Create chat

Create a new chat session

POST /ai/chats

Create chat

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/ai/chats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "trigger": {
    "type": "<string>",
    "connectorUuid": "<string>",
    "meta": {}
  },
  "name": "<string>",
  "agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

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

payload = {
    "trigger": {
        "type": "<string>",
        "connectorUuid": "<string>",
        "meta": {}
    },
    "name": "<string>",
    "agentUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "releaseUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    trigger: {type: '<string>', connectorUuid: '<string>', meta: {}},
    name: '<string>',
    agentUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    releaseUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.getcargo.io/v1/ai/chats', 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/chats",
  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([
    'trigger' => [
        'type' => '<string>',
        'connectorUuid' => '<string>',
        'meta' => [
                
        ]
    ],
    'name' => '<string>',
    'agentUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'releaseUuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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/chats"

	payload := strings.NewReader("{\n  \"trigger\": {\n    \"type\": \"<string>\",\n    \"connectorUuid\": \"<string>\",\n    \"meta\": {}\n  },\n  \"name\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/chats")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"trigger\": {\n    \"type\": \"<string>\",\n    \"connectorUuid\": \"<string>\",\n    \"meta\": {}\n  },\n  \"name\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"trigger\": {\n    \"type\": \"<string>\",\n    \"connectorUuid\": \"<string>\",\n    \"meta\": {}\n  },\n  \"name\": \"<string>\",\n  \"agentUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"releaseUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

{
  "chat": {
    "uuid": "<string>",
    "slug": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "agentUuid": "<string>",
    "releaseUuid": "<string>",
    "name": "<string>",
    "trigger": "<unknown>",
    "heartbeat": {
      "intervalMinutes": 123,
      "maxMessages": 123,
      "prompt": "<string>"
    },
    "evaluator": {
      "rubric": "<string>",
      "threshold": 0.5
    },
    "activeStreamUuid": "<string>",
    "creditsUsedCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "lastMessage": {
      "uuid": "<string>",
      "workspaceUuid": "<string>",
      "agentUuid": "<string>",
      "releaseUuid": "<string>",
      "chatUuid": "<string>",
      "userUuid": "<string>",
      "errorMessage": "<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.

trigger · Trigger · object · required

Trigger configuration for the chat.

Trigger

Trigger

Trigger

Trigger

Trigger

Show child attributes

name · string

Chat name.

agentUuid · string<uuid>

Agent identifier for the chat.

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})$

releaseUuid · string<uuid>

Release identifier for the chat.

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})$

heartbeat · Heartbeat · object

Optional heartbeat configuration. When set, the chat keeps waking itself up every intervalMinutes minutes, re-sending the prompt, until it reaches maxMessages messages.

Show child attributes

evaluator · Evaluator · object

Optional evaluator configuration (rubric + quality threshold). When set, the heartbeat loop grades each output and keeps iterating until the score reaches the threshold or maxMessages is hit.

Show child attributes

Response

200

application/json

Successful response

chat · Chat · object · required

Created chat details.

Show child attributes