Skip to main content
GET
/
ai
/
agents
/
{uuid}
Get agent
curl --request GET \
  --url https://api.getcargo.io/v1/ai/agents/{uuid} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string
required

Resource UUID

Response

Successful response

agent
Agent · object
required

Agent details.