curl --request POST \
--url https://api.getcargo.io/v1/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"deployments": [
{
"name": "<string>",
"description": "<string>",
"type": "connector",
"connectorUuid": "<string>",
"integrationSlug": "<string>",
"config": {}
}
],
"description": "<string>",
"folderUuid": "<string>"
}
'{
"agent": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"description": "<string>",
"deployments": [
{
"name": "<string>",
"description": "<string>",
"type": "connector",
"connectorUuid": "<string>",
"integrationSlug": "<string>",
"config": {}
}
],
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"templateSlug": "<string>",
"version": "<string>",
"tools": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "<string>",
"toolUuid": "<string>",
"templateSlug": "<string>"
}
],
"capabilities": [
{
"slug": "<string>"
}
],
"suggestedActions": [
{
"text": "<string>",
"tools": [
{
"slug": "<string>"
}
]
}
],
"systemPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"integrationSlug": "<string>",
"connectorUuid": "<string>",
"languageModelSlug": "<string>",
"mcpClients": [
{
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"prompt": "<string>"
}
],
"deployedAt": "<string>",
"createdAt": "<string>"
},
"folderUuid": "<string>",
"isReadOnly": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Create a new AI agent
curl --request POST \
--url https://api.getcargo.io/v1/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"deployments": [
{
"name": "<string>",
"description": "<string>",
"type": "connector",
"connectorUuid": "<string>",
"integrationSlug": "<string>",
"config": {}
}
],
"description": "<string>",
"folderUuid": "<string>"
}
'{
"agent": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"description": "<string>",
"deployments": [
{
"name": "<string>",
"description": "<string>",
"type": "connector",
"connectorUuid": "<string>",
"integrationSlug": "<string>",
"config": {}
}
],
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"templateSlug": "<string>",
"version": "<string>",
"tools": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "<string>",
"toolUuid": "<string>",
"templateSlug": "<string>"
}
],
"capabilities": [
{
"slug": "<string>"
}
],
"suggestedActions": [
{
"text": "<string>",
"tools": [
{
"slug": "<string>"
}
]
}
],
"systemPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"integrationSlug": "<string>",
"connectorUuid": "<string>",
"languageModelSlug": "<string>",
"mcpClients": [
{
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"prompt": "<string>"
}
],
"deployedAt": "<string>",
"createdAt": "<string>"
},
"folderUuid": "<string>",
"isReadOnly": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successful response
Created agent details.
Show child attributes
Was this page helpful?