Skip to main content
PUT
/
ai
/
agents
/
{uuid}
Update agent
curl --request PUT \
  --url https://api.getcargo.io/v1/ai/agents/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "icon": {
    "color": "grey",
    "face": "<string>"
  },
  "description": "<string>",
  "triggers": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "<string>",
      "cron": "<string>",
      "text": "<string>"
    }
  ],
  "folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "agent": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "icon": {
      "color": "grey",
      "face": "<string>"
    },
    "description": "<string>",
    "triggers": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "<string>",
        "cron": "<string>",
        "text": "<string>",
        "temporalScheduleWorkflowId": "<string>"
      }
    ],
    "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": [
        {
          "kind": "<string>",
          "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>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required

Agent identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

name
string

Agent name.

icon
Icon · object

Agent icon.

description
string | null

Agent description.

triggers
Triggers · object[]

Agent triggers.

folderUuid
string<uuid> | null

Folder identifier for the agent.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Response

Successful response

agent
Agent · object
required

Updated agent details.