Generate suggested actions

Generate suggested actions for a chat

POST /ai/suggestedActions/generate

Generate suggested actions

cURL

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>",
      "waitUntilFinished": true
    }
  ],
  "resources": [
    {
      "kind": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "integrationSlug": "<string>",
      "modelUuid": "<string>",
      "filter": {
        "groups": [
          "<unknown>"
        ]
      },
      "selectedColumnSlugs": [
        "<string>"
      ],
      "limit": 123,
      "prompt": "<string>",
      "isReadOnly": true
    }
  ],
  "capabilities": [
    {
      "slug": "<string>",
      "config": {}
    }
  ]
}
'

import requests

url = "https://api.getcargo.io/v1/ai/suggestedActions/generate"

payload = {
    "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>",
            "waitUntilFinished": True
        }
    ],
    "resources": [
        {
            "kind": "<string>",
            "name": "<string>",
            "slug": "<string>",
            "description": "<string>",
            "integrationSlug": "<string>",
            "modelUuid": "<string>",
            "filter": { "groups": ["<unknown>"] },
            "selectedColumnSlugs": ["<string>"],
            "limit": 123,
            "prompt": "<string>",
            "isReadOnly": True
        }
    ],
    "capabilities": [
        {
            "slug": "<string>",
            "config": {}
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>',
        waitUntilFinished: true
      }
    ],
    resources: [
      {
        kind: '<string>',
        name: '<string>',
        slug: '<string>',
        description: '<string>',
        integrationSlug: '<string>',
        modelUuid: '<string>',
        filter: {groups: ['<unknown>']},
        selectedColumnSlugs: ['<string>'],
        limit: 123,
        prompt: '<string>',
        isReadOnly: true
      }
    ],
    capabilities: [{slug: '<string>', config: {}}]
  })
};

fetch('https://api.getcargo.io/v1/ai/suggestedActions/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/ai/suggestedActions/generate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>',
                'waitUntilFinished' => true
        ]
    ],
    'resources' => [
        [
                'kind' => '<string>',
                'name' => '<string>',
                'slug' => '<string>',
                'description' => '<string>',
                'integrationSlug' => '<string>',
                'modelUuid' => '<string>',
                'filter' => [
                                'groups' => [
                                                                '<unknown>'
                                ]
                ],
                'selectedColumnSlugs' => [
                                '<string>'
                ],
                'limit' => 123,
                'prompt' => '<string>',
                'isReadOnly' => true
        ]
    ],
    'capabilities' => [
        [
                'slug' => '<string>',
                'config' => [
                                
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/ai/suggestedActions/generate"

	payload := strings.NewReader("{\n  \"cacheKey\": \"<string>\",\n  \"messageUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"systemPrompt\": \"<string>\",\n  \"contextPrompt\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"actions\": [\n    {\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"isBulkAllowed\": true,\n      \"config\": {},\n      \"kind\": \"<string>\",\n      \"toolUuid\": \"<string>\",\n      \"templateSlug\": \"<string>\",\n      \"waitUntilFinished\": true\n    }\n  ],\n  \"resources\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"integrationSlug\": \"<string>\",\n      \"modelUuid\": \"<string>\",\n      \"filter\": {\n        \"groups\": [\n          \"<unknown>\"\n        ]\n      },\n      \"selectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"limit\": 123,\n      \"prompt\": \"<string>\",\n      \"isReadOnly\": true\n    }\n  ],\n  \"capabilities\": [\n    {\n      \"slug\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/ai/suggestedActions/generate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"cacheKey\": \"<string>\",\n  \"messageUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"systemPrompt\": \"<string>\",\n  \"contextPrompt\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"actions\": [\n    {\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"isBulkAllowed\": true,\n      \"config\": {},\n      \"kind\": \"<string>\",\n      \"toolUuid\": \"<string>\",\n      \"templateSlug\": \"<string>\",\n      \"waitUntilFinished\": true\n    }\n  ],\n  \"resources\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"integrationSlug\": \"<string>\",\n      \"modelUuid\": \"<string>\",\n      \"filter\": {\n        \"groups\": [\n          \"<unknown>\"\n        ]\n      },\n      \"selectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"limit\": 123,\n      \"prompt\": \"<string>\",\n      \"isReadOnly\": true\n    }\n  ],\n  \"capabilities\": [\n    {\n      \"slug\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/ai/suggestedActions/generate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"cacheKey\": \"<string>\",\n  \"messageUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"systemPrompt\": \"<string>\",\n  \"contextPrompt\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"actions\": [\n    {\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"isBulkAllowed\": true,\n      \"config\": {},\n      \"kind\": \"<string>\",\n      \"toolUuid\": \"<string>\",\n      \"templateSlug\": \"<string>\",\n      \"waitUntilFinished\": true\n    }\n  ],\n  \"resources\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"slug\": \"<string>\",\n      \"description\": \"<string>\",\n      \"integrationSlug\": \"<string>\",\n      \"modelUuid\": \"<string>\",\n      \"filter\": {\n        \"groups\": [\n          \"<unknown>\"\n        ]\n      },\n      \"selectedColumnSlugs\": [\n        \"<string>\"\n      ],\n      \"limit\": 123,\n      \"prompt\": \"<string>\",\n      \"isReadOnly\": true\n    }\n  ],\n  \"capabilities\": [\n    {\n      \"slug\": \"<string>\",\n      \"config\": {}\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "suggestedActions": [
    {
      "text": "<string>",
      "actions": [
        {
          "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<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.

Option 1

Option 2

Option 3

Show child attributes

resources · Resources · object[]

Resources available for generation.

Option 1

Option 2

Show child attributes

capabilities · Capabilities · object[]

Capabilities available for generation.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Show child attributes

Response

200

application/json

Successful response

suggestedActions · Suggested actions · object[] · required

Generated suggested actions.

Show child attributes