Skip to main content
GET
/
v1
/
agents
/
{agent_id}
/
versions
/
{agent_version_id}
curl --request GET \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/YOUR_VERSION_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY"

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "version_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "engine_class_id": "<string>",
  "engine_name": "<string>",
  "input_definitions": [
    {
      "key": "<string>",
      "data_type": "<string>",
      "description": "<string>",
      "example": "<string>",
      "accepts_multiple_files": true
    }
  ],
  "engine_config": {},
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "readonly": true,
  "base_agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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>",
    "creator": {
      "id": 123,
      "email": "[email protected]",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  },
  "creator": {
    "id": 123,
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>"
  },
  "description": "<string>"
}
curl --request GET \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/versions/YOUR_VERSION_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY"

Path Parameters

​
agent_id
string<uuid>
required

A UUID string identifying the base agent.

​
agent_version_id
string<uuid>
required

A UUID string identifying this agent version.

Query Parameters

​
get_supports_eval
boolean

Include information on whether the agent engine supports evaluation.

Response

Successfully retrieved agent version details.

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.