Skip to main content
POST
/
v1
/
agents
/
Create a new base agent.
curl --request POST \
  --url https://api.roe-ai.com/v1/agents/ \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "engine_class_id": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version_name": "<string>",
  "description": "<string>",
  "input_definitions": "<any>",
  "engine_config": "<any>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creator": {
    "id": 123,
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "disable_cache": true,
  "cache_failed_jobs": true,
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "engine_class_id": "<string>",
  "current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_count": 123,
  "most_recent_job": "2023-11-07T05:31:56Z",
  "engine_name": "<string>",
  "tags": "<string>"
}

Query Parameters

​
organization_id
string<uuid>

Body

​
name
string
required
Minimum length: 1
​
engine_class_id
string
required
Minimum length: 1
​
organization_id
string<uuid>
required
​
input_definitions
any
required
​
engine_config
any
required
​
version_name
string
Minimum length: 1
​
description
string
Minimum length: 1

Response

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
name
string
required
Required string length: 1 - 200
​
disable_cache
boolean
required
​
cache_failed_jobs
boolean
required
​
organization_id
string<uuid>
required
​
engine_class_id
string
required
Maximum length: 200
​
current_version_id
string<uuid>
required
​
job_count
integer
required
​
most_recent_job
string<date-time>
required
​
engine_name
string
required
​
tags
string
required
​
creator
object