Get an AI action invocation | Documentation

{
  "sys": {
    "aiAction": {
      "sys": {
        "id": "3D5GGn5FlhszToS2Sbkfk8",
        "linkType": "AiAction",
        "type": "Link"
      }
    },
    "environment": {
      "sys": {
        "id": "staging",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "id": "XgfOib1ayqA4Jl8GKIgUt",
    "result": {
      "content": "Dies ist ein Beispieltext",
      "metadata": {
        "invocationResult": {
          "modelId": "us.anthropic.claude-3-5-sonnet-20241022-v2:0",
          "modelProvider": "amazon-bedrock",
          "outputFormat": "PlainText",
          "wordCount": 4
        },
        "statusChangedDates": {
          "date": "2025-03-28T08:06:09.854Z",
          "status": "COMPLETED"
        }
      },
      "type": "text"
    },
    "space": {
      "sys": {
        "id": "yadj1kx9rmg0",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "status": "COMPLETED",
    "type": "AiActionInvocation"
  }
}

Use this endpoint to obtain the result of an AI Action Invocation for a specified space, environment, AI Action and invocation.

When sys.status is COMPLETED, read the top-level result property. For AI Suggestions, result.content is an array of MarkdownBlock and SuggestionBlock objects. Running a suggestion does not modify the entry.

See Read the suggestions for a result example.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

space_idstringRequired

ID of the space in the form of a string

environment_idstringRequired

ID of the environment in the form of a string

ai_action_idstringRequired

ID of the AI Action in form of a string

ai_action_invocation_idstringRequired

ID of the AI Action invocation in the form of a string

Response headers

Content-TypestringOptional

Content-Type

Response

OK - Request successful