Skip to main content
POST
/
v1
/
agents
/
{agent_id}
/
versions
/
Create a new agent version.
curl --request POST \
  --url https://api.roe-ai.com/v1/agents/{agent_id}/versions/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "version_name": "<string>",
  "description": "<string>",
  "input_definitions": "<any>",
  "engine_config": "<any>"
}'
{
  "id": "789e1234-e89b-12d3-a456-426614174002",
  "version_name": "version 2",
  "description": "Updated version with new features",
  "input_definitions": [
    {
      "key": "input_text",
      "description": "Text to process",
      "data_type": "text/plain"
    }
  ],
  "engine_config": {
    "model": "gpt-4",
    "temperature": "0.5"
  },
  "created_at": "2024-01-16T14:20:00Z",
  "readonly": false,
  "engine_class_id": "openai_chat",
  "organization": "org-123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
agent_id
string<uuid>
required

A UUID string identifying the base agent.

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 new agent versions

​
input_definitions
any
required

List of input definitions for this agent version.

​
engine_config
any
required

Engine configuration as a dictionary of string key-value pairs.

​
version_name
string

Version name for the agent version. Defaults to 'unnamed version' if not provided.

Minimum length: 1
​
description
string | null
Minimum length: 1

Response

Successfully created new agent version.

Serializer for Agent (version) model

​
id
string<uuid>
required
​
name
string
required
​
version_name
string
required

Version name for the agent version. Defaults to 'unnamed version' if not provided.

​
created_at
string<date-time>
required
​
engine_class_id
string
required

Get engine_class_id from base_agent.

​
engine_name
string
required

Engine Display Name

​
input_definitions
object[]
required

List of input definitions for this agent version.

​
engine_config
object
required

Engine configuration as a dictionary of string key-value pairs.

​
organization_id
string<uuid>
required

Organization ID from base_agent.

​
readonly
boolean
required
​
base_agent
object
required

Serializer for BaseAgent (agent config)

​
creator
object
​
description
string

Description of the agent version.

⌘I