Skip to main content
POST
/
agents
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "tools_config": {},
  "cpus": "1.0",
  "mem_limit": "1g",
  "pids_limit": 200,
  "soul_md": "<string>",
  "rules_md": "<string>",
  "status": "stopped",
  "container_id": "<string>",
  "error_message": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
agent_id
string
required
​
name
string
required
​
description
string
​
tools_config
object
​
cpus
string
​
mem_limit
string
​
pids_limit
integer
​
soul_md
string
​
rules_md
string

Response

Agent created

​
id
string<uuid>
​
agent_id
string

Unique slug identifier (lowercase, alphanumeric, hyphens)

​
name
string
​
description
string
​
tools_config
object
​
cpus
string
default:1.0
​
mem_limit
string
default:1g
​
pids_limit
integer
default:200
​
soul_md
string
​
rules_md
string
​
status
enum<string>
Available options:
stopped,
running,
error
​
container_id
string | null
​
error_message
string | null
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
created_by
string