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": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "systemPrompt": "<string>",
  "contextPrompt": "<string>",
  "agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actions": [
    {
      "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": {
        "groups": [
          "<unknown>"
        ]
      },
      "selectedColumnSlugs": [
        "<string>"
      ],
      "limit": 123,
      "prompt": "<string>"
    }
  ],
  "capabilities": [
    {
      "slug": "<string>"
    }
  ]
}
'
{
  "suggestedActions": [
    {
      "text": "<string>",
      "actions": [
        {
          "slug": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.getcargo.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Message 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})$
​
systemPrompt
string

System prompt to use for generation.

​
contextPrompt
string

Additional context for generation.

​
agentUuid
string<uuid>

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})$
​
actions
Actions · object[]

Actions 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.