curl --request POST \
--url https://api.getcargo.io/v1/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"face": "<string>"
},
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>"
}
],
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/ai/agents"
payload = {
"name": "<string>",
"icon": { "face": "<string>" },
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>"
}
],
"folderUuid": "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({
name: '<string>',
icon: {face: '<string>'},
description: '<string>',
triggers: [
{
name: '<string>',
description: '<string>',
type: 'cron',
cron: '<string>',
text: '<string>'
}
],
folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getcargo.io/v1/ai/agents', 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/agents",
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([
'name' => '<string>',
'icon' => [
'face' => '<string>'
],
'description' => '<string>',
'triggers' => [
[
'name' => '<string>',
'description' => '<string>',
'type' => 'cron',
'cron' => '<string>',
'text' => '<string>'
]
],
'folderUuid' => '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/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"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/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/ai/agents")
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 \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>",
"temporalScheduleWorkflowId": "<string>"
}
],
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"templateSlug": "<string>",
"version": "<string>",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": true
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {
"scope": "chat"
}
}
],
"suggestedActions": [
{
"text": "<string>",
"actions": [
{
"slug": "<string>"
}
]
}
],
"systemPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"integrationSlug": "<string>",
"connectorUuid": "<string>",
"languageModelSlug": "<string>",
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"isReadOnly": true
}
],
"heartbeat": {
"intervalMinutes": 123,
"maxMessages": 123,
"prompt": "<string>"
},
"evaluator": {
"rubric": "<string>",
"threshold": 0.5
},
"harnessSlug": "claudeCode",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<string>"
}
]
},
"deployedAt": "<string>",
"createdAt": "<string>"
},
"folderUuid": "<string>",
"template": {
"slug": "<string>",
"isAvailable": true,
"scope": "public"
},
"isReadOnly": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Create agent
Create a new AI agent (POST /ai/agents).
curl --request POST \
--url https://api.getcargo.io/v1/ai/agents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"icon": {
"face": "<string>"
},
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>"
}
],
"folderUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.getcargo.io/v1/ai/agents"
payload = {
"name": "<string>",
"icon": { "face": "<string>" },
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>"
}
],
"folderUuid": "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({
name: '<string>',
icon: {face: '<string>'},
description: '<string>',
triggers: [
{
name: '<string>',
description: '<string>',
type: 'cron',
cron: '<string>',
text: '<string>'
}
],
folderUuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.getcargo.io/v1/ai/agents', 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/agents",
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([
'name' => '<string>',
'icon' => [
'face' => '<string>'
],
'description' => '<string>',
'triggers' => [
[
'name' => '<string>',
'description' => '<string>',
'type' => 'cron',
'cron' => '<string>',
'text' => '<string>'
]
],
'folderUuid' => '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/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"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/agents")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/ai/agents")
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 \"name\": \"<string>\",\n \"icon\": {\n \"face\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"triggers\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"cron\",\n \"cron\": \"<string>\",\n \"text\": \"<string>\"\n }\n ],\n \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"uuid": "<string>",
"workspaceUuid": "<string>",
"userUuid": "<string>",
"name": "<string>",
"icon": {
"color": "grey",
"face": "<string>"
},
"description": "<string>",
"triggers": [
{
"name": "<string>",
"description": "<string>",
"type": "cron",
"cron": "<string>",
"text": "<string>",
"temporalScheduleWorkflowId": "<string>"
}
],
"deployedRelease": {
"uuid": "<string>",
"userUuid": "<string>",
"description": "<string>",
"templateSlug": "<string>",
"version": "<string>",
"actions": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"isBulkAllowed": true,
"config": {},
"kind": "tool",
"toolUuid": "<string>",
"templateSlug": "<string>",
"waitUntilFinished": true
}
],
"capabilities": [
{
"slug": "sandbox",
"config": {
"scope": "chat"
}
}
],
"suggestedActions": [
{
"text": "<string>",
"actions": [
{
"slug": "<string>"
}
]
}
],
"systemPrompt": "<string>",
"withReasoning": true,
"temperature": 123,
"maxSteps": 123,
"integrationSlug": "<string>",
"connectorUuid": "<string>",
"languageModelSlug": "<string>",
"mcpClients": [
{
"kind": "custom",
"name": "<string>",
"url": "<string>",
"authentication": {
"issuedAt": "<string>",
"accessToken": "<string>",
"expiresIn": 123,
"refreshToken": "<string>",
"scope": "<string>",
"tokenType": "<string>",
"clientId": "<string>",
"clientSecret": "<string>"
},
"disabledToolSlugs": [
"<string>"
]
}
],
"resources": [
{
"kind": "model",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"prompt": "<string>",
"integrationSlug": "<string>",
"modelUuid": "<string>",
"filter": {
"conjonction": "or",
"groups": [
"<unknown>"
]
},
"selectedColumnSlugs": [
"<string>"
],
"limit": 123,
"isReadOnly": true
}
],
"heartbeat": {
"intervalMinutes": 123,
"maxMessages": 123,
"prompt": "<string>"
},
"evaluator": {
"rubric": "<string>",
"threshold": 0.5
},
"harnessSlug": "claudeCode",
"repository": {
"connectorUuid": "<string>",
"repository": "<string>",
"defaultBranch": "<string>",
"rootDirectory": "<string>",
"env": [
{
"key": "<string>",
"type": "public",
"value": "<string>"
}
]
},
"deployedAt": "<string>",
"createdAt": "<string>"
},
"folderUuid": "<string>",
"template": {
"slug": "<string>",
"isAvailable": true,
"scope": "public"
},
"isReadOnly": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"deletedAt": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
255"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
Request body schema.
Agent name.
1 - 255Agent icon.
Show child attributes
Show child attributes
Agent description.
1 - 1000Agent triggers.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Folder identifier for the agent.
^([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})$Response
Create agent
Created agent details.
Show child attributes
Show child attributes
Was this page helpful?

