Create agent

Create a new AI agent

POST /ai/agents

Create agent

cURL

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": "<string>",
      "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": "<string>",
            "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: '<string>',
        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' => '<string>',
                '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\": \"<string>\",\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\": \"<string>\",\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\": \"<string>\",\n      \"cron\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ],\n  \"folderUuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

200

{
  "agent": {
    "uuid": "<string>",
    "workspaceUuid": "<string>",
    "userUuid": "<string>",
    "name": "<string>",
    "icon": {
      "face": "<string>"
    },
    "description": "<string>",
    "triggers": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "<string>",
        "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": "<string>",
          "toolUuid": "<string>",
          "templateSlug": "<string>",
          "waitUntilFinished": true
        }
      ],
      "capabilities": [
        {
          "slug": "<string>",
          "config": {}
        }
      ],
      "suggestedActions": [
        {
          "text": "<string>",
          "actions": [
            {
              "slug": "<string>"
            }
          ]
        }
      ],
      "systemPrompt": "<string>",
      "withReasoning": true,
      "temperature": 123,
      "maxSteps": 123,
      "integrationSlug": "<string>",
      "connectorUuid": "<string>",
      "languageModelSlug": "<string>",
      "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>"
          ]
        }
      ],
      "resources": [
        {
          "kind": "<string>",
          "name": "<string>",
          "slug": "<string>",
          "description": "<string>",
          "integrationSlug": "<string>",
          "modelUuid": "<string>",
          "filter": {
            "groups": [
              "<unknown>"
            ]
          },
          "selectedColumnSlugs": [
            "<string>"
          ],
          "limit": 123,
          "prompt": "<string>",
          "isReadOnly": true
        }
      ],
      "heartbeat": {
        "intervalMinutes": 123,
        "maxMessages": 123,
        "prompt": "<string>"
      },
      "evaluator": {
        "rubric": "<string>",
        "threshold": 0.5
      },
      "deployedAt": "<string>",
      "createdAt": "<string>"
    },
    "folderUuid": "<string>",
    "template": {
      "slug": "<string>",
      "isAvailable": true
    },
    "isReadOnly": true,
    "createdAt": "<string>",
    "updatedAt": "<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.

name · string · required

Agent name.

icon · Icon · object · required

Agent icon.

Show child attributes

description · string

Agent description.

triggers · Triggers · object[]

Agent triggers.

Option 1

Option 2

Show child attributes

folderUuid · string<uuid>

Folder identifier for the agent.

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

Response

200

application/json

Successful response

agent · Agent · object · required

Created agent details.

Show child attributes