Skip to main content
POST
/
ai
/
messages
Create message
curl --request POST \
  --url https://api.getcargo.io/v1/ai/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parts": [
    "<unknown>"
  ],
  "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": {}
    }
  ],
  "mcpClients": [
    {
      "kind": "<string>",
      "name": "<string>",
      "url": "<string>",
      "authentication": {
        "issuedAt": "<string>",
        "accessToken": "<string>",
        "expiresIn": 123,
        "refreshToken": "<string>",
        "scope": "<string>",
        "tokenType": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>"
      },
      "disabledToolSlugs": [
        "<string>"
      ]
    }
  ],
  "systemPrompt": "<string>",
  "withReasoning": true,
  "temperature": 123,
  "maxSteps": 123,
  "integrationSlug": "<string>",
  "connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "languageModelSlug": "<string>",
  "output": {
    "type": "<string>"
  }
}
'
import requests

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

payload = {
    "chatUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parts": ["<unknown>"],
    "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": {}
        }
    ],
    "mcpClients": [
        {
            "kind": "<string>",
            "name": "<string>",
            "url": "<string>",
            "authentication": {
                "issuedAt": "<string>",
                "accessToken": "<string>",
                "expiresIn": 123,
                "refreshToken": "<string>",
                "scope": "<string>",
                "tokenType": "<string>",
                "clientId": "<string>",
                "clientSecret": "<string>"
            },
            "disabledToolSlugs": ["<string>"]
        }
    ],
    "systemPrompt": "<string>",
    "withReasoning": True,
    "temperature": 123,
    "maxSteps": 123,
    "integrationSlug": "<string>",
    "connectorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "languageModelSlug": "<string>",
    "output": { "type": "<string>" }
}
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({
    chatUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parts: ['<unknown>'],
    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: {}}],
    mcpClients: [
      {
        kind: '<string>',
        name: '<string>',
        url: '<string>',
        authentication: {
          issuedAt: '<string>',
          accessToken: '<string>',
          expiresIn: 123,
          refreshToken: '<string>',
          scope: '<string>',
          tokenType: '<string>',
          clientId: '<string>',
          clientSecret: '<string>'
        },
        disabledToolSlugs: ['<string>']
      }
    ],
    systemPrompt: '<string>',
    withReasoning: true,
    temperature: 123,
    maxSteps: 123,
    integrationSlug: '<string>',
    connectorUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    languageModelSlug: '<string>',
    output: {type: '<string>'}
  })
};

fetch('https://api.getcargo.io/v1/ai/messages', 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/messages",
  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([
    'chatUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parts' => [
        '<unknown>'
    ],
    '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' => [
                                
                ]
        ]
    ],
    'mcpClients' => [
        [
                'kind' => '<string>',
                'name' => '<string>',
                'url' => '<string>',
                'authentication' => [
                                'issuedAt' => '<string>',
                                'accessToken' => '<string>',
                                'expiresIn' => 123,
                                'refreshToken' => '<string>',
                                'scope' => '<string>',
                                'tokenType' => '<string>',
                                'clientId' => '<string>',
                                'clientSecret' => '<string>'
                ],
                'disabledToolSlugs' => [
                                '<string>'
                ]
        ]
    ],
    'systemPrompt' => '<string>',
    'withReasoning' => true,
    'temperature' => 123,
    'maxSteps' => 123,
    'integrationSlug' => '<string>',
    'connectorUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'languageModelSlug' => '<string>',
    'output' => [
        'type' => '<string>'
    ]
  ]),
  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/messages"

	payload := strings.NewReader("{\n  \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parts\": [\n    \"<unknown>\"\n  ],\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  \"mcpClients\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"authentication\": {\n        \"issuedAt\": \"<string>\",\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": 123,\n        \"refreshToken\": \"<string>\",\n        \"scope\": \"<string>\",\n        \"tokenType\": \"<string>\",\n        \"clientId\": \"<string>\",\n        \"clientSecret\": \"<string>\"\n      },\n      \"disabledToolSlugs\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"systemPrompt\": \"<string>\",\n  \"withReasoning\": true,\n  \"temperature\": 123,\n  \"maxSteps\": 123,\n  \"integrationSlug\": \"<string>\",\n  \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"languageModelSlug\": \"<string>\",\n  \"output\": {\n    \"type\": \"<string>\"\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/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parts\": [\n    \"<unknown>\"\n  ],\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  \"mcpClients\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"authentication\": {\n        \"issuedAt\": \"<string>\",\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": 123,\n        \"refreshToken\": \"<string>\",\n        \"scope\": \"<string>\",\n        \"tokenType\": \"<string>\",\n        \"clientId\": \"<string>\",\n        \"clientSecret\": \"<string>\"\n      },\n      \"disabledToolSlugs\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"systemPrompt\": \"<string>\",\n  \"withReasoning\": true,\n  \"temperature\": 123,\n  \"maxSteps\": 123,\n  \"integrationSlug\": \"<string>\",\n  \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"languageModelSlug\": \"<string>\",\n  \"output\": {\n    \"type\": \"<string>\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

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

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  \"chatUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parts\": [\n    \"<unknown>\"\n  ],\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  \"mcpClients\": [\n    {\n      \"kind\": \"<string>\",\n      \"name\": \"<string>\",\n      \"url\": \"<string>\",\n      \"authentication\": {\n        \"issuedAt\": \"<string>\",\n        \"accessToken\": \"<string>\",\n        \"expiresIn\": 123,\n        \"refreshToken\": \"<string>\",\n        \"scope\": \"<string>\",\n        \"tokenType\": \"<string>\",\n        \"clientId\": \"<string>\",\n        \"clientSecret\": \"<string>\"\n      },\n      \"disabledToolSlugs\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"systemPrompt\": \"<string>\",\n  \"withReasoning\": true,\n  \"temperature\": 123,\n  \"maxSteps\": 123,\n  \"integrationSlug\": \"<string>\",\n  \"connectorUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"languageModelSlug\": \"<string>\",\n  \"output\": {\n    \"type\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "userMessage": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "agentUuid": "<string>",
    "releaseUuid": "<string>",
    "chatUuid": "<string>",
    "userUuid": "<string>",
    "errorMessage": "<string>",
    "parts": [
      "<unknown>"
    ],
    "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": {}
      }
    ],
    "mcpClients": [
      {
        "kind": "<string>",
        "name": "<string>",
        "url": "<string>",
        "authentication": {
          "issuedAt": "<string>",
          "accessToken": "<string>",
          "expiresIn": 123,
          "refreshToken": "<string>",
          "scope": "<string>",
          "tokenType": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>"
        },
        "disabledToolSlugs": [
          "<string>"
        ]
      }
    ],
    "systemPrompt": "<string>",
    "withReasoning": true,
    "temperature": 123,
    "maxSteps": 123,
    "integrationSlug": "<string>",
    "connectorUuid": "<string>",
    "languageModelSlug": "<string>",
    "evaluatedTools": {},
    "usage": {
      "tokensUsedCount": 123,
      "creditsUsedCount": 123,
      "languageModelSlug": "<string>",
      "connectorUuid": "<string>"
    },
    "output": "<unknown>",
    "meta": {},
    "suggestedActions": [
      {
        "text": "<string>",
        "actions": [
          {
            "slug": "<string>"
          }
        ]
      }
    ],
    "temporalWorkflowId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "finishedAt": "<string>",
    "deletedAt": "<string>"
  },
  "assistantMessage": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "agentUuid": "<string>",
    "releaseUuid": "<string>",
    "chatUuid": "<string>",
    "userUuid": "<string>",
    "errorMessage": "<string>",
    "parts": [
      "<unknown>"
    ],
    "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": {}
      }
    ],
    "mcpClients": [
      {
        "kind": "<string>",
        "name": "<string>",
        "url": "<string>",
        "authentication": {
          "issuedAt": "<string>",
          "accessToken": "<string>",
          "expiresIn": 123,
          "refreshToken": "<string>",
          "scope": "<string>",
          "tokenType": "<string>",
          "clientId": "<string>",
          "clientSecret": "<string>"
        },
        "disabledToolSlugs": [
          "<string>"
        ]
      }
    ],
    "systemPrompt": "<string>",
    "withReasoning": true,
    "temperature": 123,
    "maxSteps": 123,
    "integrationSlug": "<string>",
    "connectorUuid": "<string>",
    "languageModelSlug": "<string>",
    "evaluatedTools": {},
    "usage": {
      "tokensUsedCount": 123,
      "creditsUsedCount": 123,
      "languageModelSlug": "<string>",
      "connectorUuid": "<string>"
    },
    "output": "<unknown>",
    "meta": {},
    "suggestedActions": [
      {
        "text": "<string>",
        "actions": [
          {
            "slug": "<string>"
          }
        ]
      }
    ],
    "temporalWorkflowId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "finishedAt": "<string>",
    "deletedAt": "<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.

​
chatUuid
string<uuid>
required

Chat 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})$
​
parts
any[]
required

Message parts.

​
actions
Actions · object[]

Actions available for the message.

​
resources
Resources · object[]

Resources available for the message.

​
capabilities
Capabilities · object[]

Capabilities available for the message.

​
mcpClients
MCP clients · object[]

MCP clients to use for the message.

​
systemPrompt
string

System prompt for the message.

​
withReasoning
boolean

Whether to include reasoning.

​
temperature
number

Sampling temperature.

​
maxSteps
number

Maximum number of steps.

​
integrationSlug
string

Integration identifier.

​
connectorUuid
string<uuid>

Connector 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})$
​
languageModelSlug
string

Language model identifier.

​
output
Output · object

Output format for the assistant message. Defaults to text when omitted.

Response

Successful response

​
userMessage
User message · object
required

The created user message.

​
assistantMessage
Assistant message · object
required

The created assistant message (initially pending while processing).