Skip to main content
POST
/
ai
/
suggestedActions
/
generate
Generate suggested actions
curl --request POST \
  --url https://api.getcargo.io/v1/ai/suggestedActions/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cacheKey": "<string>",
  "messageUuid": "<string>",
  "systemPrompt": "<string>",
  "contextPrompt": "<string>",
  "agentUuid": "<string>",
  "tools": [
    {
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "isBulkAllowed": true,
      "config": {},
      "kind": "<string>",
      "toolUuid": "<string>",
      "templateSlug": "<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>"
    }
  ],
  "capabilities": [
    {
      "slug": "<string>"
    }
  ]
}
'
{
  "suggestedActions": [
    {
      "text": "<string>",
      "tools": [
        {
          "slug": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Request body schema.

cacheKey
string

Cache key for suggested actions.

messageUuid
string

Message identifier.

systemPrompt
string

System prompt to use for generation.

contextPrompt
string

Additional context for generation.

agentUuid
string

Agent identifier.

tools
Tools · object[]

Tools available for generation.

resources
Resources · object[]

Resources available for generation.

capabilities
Capabilities · object[]

Capabilities available for generation.

Response

Successful response

suggestedActions
Suggested actions · object[]
required

Generated suggested actions.