Invoke an AI action | Documentation

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/environments/staging/ai/actions/3D5GGn5FlhszToS2Sbkfk8/invoke \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "variables": [
    {
      "id": "l6s9730ohhha",
      "value": "de"
    }
  ]
}'

{
  "sys": {
    "aiAction": {
      "sys": {
        "id": "3D5GGn5FlhszToS2Sbkfk8",
        "linkType": "AiAction",
        "type": "Link"
      }
    },
    "environment": {
      "sys": {
        "id": "staging",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "id": "XgfOib1ayqA4Jl8GKIgUt",
    "space": {
      "sys": {
        "id": "yadj1kx9rmg0",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "status": "SCHEDULED",
    "type": "AiActionInvocation"
  }
}

Use this endpoint to invoke an AI Action for a specified space and environment.

For AI Suggestions, set outputFormat to Suggestion. The StandardInput variable must identify an entry and include a non-empty entityPaths array for the fields and locales to analyze. Variable IDs must match the action definition. The response contains the invocation ID and status; generation completes asynchronously.

See AI Suggestions for an invocation 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

Request

This endpoint expects a map from strings to any.

Response headers

Content-TypestringOptional

Content-Type

Response

Created - Resource created successfully