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": "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": "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>"
}

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

Response

201
application/json

Successfully created agent.

Serializer for BaseAgent (agent config)