POST
/
v1
/
agents
/
Create a new base agent.
curl --request POST \
  --url https://api.roe-ai.com/v1/agents/ \
  --header 'Authorization: Bearer <token>' \
  --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>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Body

Serializer for creating base agents with proper JSON field handling

name
string
required

Name of the base agent.

Minimum length: 1
engine_class_id
string
required

Engine class ID for the agent.

Minimum length: 1
organization_id
string<uuid>
required

Organization ID where the agent belongs.

input_definitions
any
required

Input definitions for the first version.

engine_config
any
required

Engine configuration for the first version.

version_name
string

Name of the first version.

Minimum length: 1
description
string

Description of the first version.

Minimum length: 1

Response

Successfully created agent.

Serializer for BaseAgent (agent config)

id
string<uuid>
required
created_at
string<date-time>
required
name
string
required
Required string length: 1 - 200
disable_cache
boolean
required

Whether to disable job cache fetching for this agent.

cache_failed_jobs
boolean
required

Whether to cache failed jobs for this agent.

organization_id
string<uuid>
required

Organization ID that owns this agent.

engine_class_id
string
required
Maximum length: 200
current_version_id
string<uuid>
required

UUID of the current agent version.

job_count
integer
required
most_recent_job
string<date-time>
required
engine_name
string
required

Engine Display Name

tags
string
required
creator
object