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 '{
>   "name": "Translate",
>   "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": [
>       {
>         "name": "Locale",
>         "type": "Locale",
>         "description": "Target language or region for the translation."
>       }
>     ]
>   },
>   "configuration": {
>     "modelTemperature": 0.1,
>     "modelType": "anthropic.claude-3-5-sonnet"
>   },
>   "testCases": [
>     {
>       "type": "Text",
>       "value": "This is an example text"
>     }
>   ]
> }'

201AI Actions_createAnAiAction_example

1 {
2   "name": "Translate",
3   "description": "Convert text to another language.",
4   "instruction": {
5     "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.",
6     "variables": [
7       {
8         "name": "Locale",
9         "type": "Locale",
10         "description": "Target language or region for the translation."
11       }
12     ]
13   },
14   "configuration": {
15     "modelTemperature": 0.1,
16     "modelType": "anthropic.claude-3-5-sonnet"
17   },
18   "testCases": [
19     {
20       "type": "Text",
21       "value": "This is an example text"
22     }
23   ],
24   "sys": {
25     "type": "AiAction",
26     "id": "3D5GGn5FlhszToS2Sbkfk8",
27     "space": {
28       "sys": {
29         "type": "Link",
30         "linkType": "Space",
31         "id": "yadj1kx9rmg0"
32       }
33     },
34     "createdAt": "2025-03-27T09:27:43.654Z",
35     "updatedAt": "2025-03-27T09:39:33.032Z",
36     "createdBy": {
37       "sys": {
38         "id": "1xGZIRXr2WPnsLkKfREo0z",
39         "type": "Link",
40         "linkType": "User"
41       }
42     },
43     "updatedBy": {
44       "sys": {
45         "id": "1xGZIRXr2WPnsLkKfREo0z",
46         "type": "Link",
47         "linkType": "User"
48       }
49     },
50     "publishedAt": "2025-03-27T09:39:33.032Z",
51     "publishedBy": {
52       "sys": {
53         "id": "1xGZIRXr2WPnsLkKfREo0z",
54         "type": "Link",
55         "linkType": "User"
56       }
57     },
58     "publishedVersion": 1,
59     "version": 1
60   }
61 }

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

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-Typestring

Content-Type

Response

Created - Resource created successfully