Create an AI action

POST

https://api.contentful.com/spaces/:space_id/ai/actions

POST

/spaces/:space_id/ai/actions

curl -X POST https://api.contentful.com/spaces/yadj1kx9rmg0/ai/actions \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/vnd.contentful.management.v1+json" \
     -d '{
  "configuration": {
    "modelTemperature": 0.1,
    "modelType": "anthropic.claude-3-5-sonnet"
  },
  "description": "Convert text to another language.",
  "instruction": {
    "template": "You are an expert in translating text to {{var.t82kaxhw0s13}}. Your task is to convert the provided content to the specified language while maintaining the original message and intent.",
    "variables": [
      {
        "description": "Target language or region for the translation.",
        "name": "Locale",
        "type": "Locale"
      }
    ]
  },
  "name": "Translate",
  "testCases": [
    {
      "type": "Text",
      "value": "This is an example text"
    }
  ]
}'

201AI Actions_createAnAiAction_example

{
  "configuration": {
    "modelTemperature": 0.1,
    "modelType": "anthropic.claude-3-5-sonnet"
  },
  "description": "Convert text to another language.",
  "instruction": {
    "template": "You are an expert in translating text to {{var.t82kaxhw0s13}}. Your task is to convert the provided content to the specified language while maintaining the original message and intent.",
    "variables": [
      {
        "description": "Target language or region for the translation.",
        "name": "Locale",
        "type": "Locale"
      }
    ]
  },
  "name": "Translate",
  "sys": {
    "createdAt": "2025-03-27T09:27:43.654Z",
    "createdBy": {
      "sys": {
        "id": "1xGZIRXr2WPnsLkKfREo0z",
        "linkType": "User",
        "type": "Link"
      }
    },
    "id": "3D5GGn5FlhszToS2Sbkfk8",
    "publishedAt": "2025-03-27T09:39:33.032Z",
    "publishedBy": {
      "sys": {
        "id": "1xGZIRXr2WPnsLkKfREo0z",
        "linkType": "User",
        "type": "Link"
      }
    },
    "publishedVersion": 1,
    "space": {
      "sys": {
        "id": "yadj1kx9rmg0",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "type": "AiAction",
    "updatedAt": "2025-03-27T09:39:33.032Z",
    "updatedBy": {
      "sys": {
        "id": "1xGZIRXr2WPnsLkKfREo0z",
        "linkType": "User",
        "type": "Link"
      }
    },
    "version": 1
  },
  "testCases": [
    {
      "type": "Text",
      "value": "This is an example text"
    }
  ]
}

Use this endpoint to create a new AI Action for a specified space.

To create an AI Suggestion, set configuration.scope to Entry and configuration.outputType to Suggestion. Include a StandardInput variable for the entry fields to analyze. Publish the action before invoking it.

See AI Suggestions for creation, publication, invocation, and result examples.

Authentication

AuthorizationBearer

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

Path parameters

space_idstringRequired

ID of the space 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