Skip to main content
GET
/
v1
/
agents
/
{agent_id}
/
Retrieve an agent.
curl --request GET \
  --url https://api.roe-ai.com/v1/agents/{agent_id}/
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "My Agent",
  "creator": {
    "id": 2,
    "email": "user@example.com",
    "first_name": "John",
    "last_name": "Doe"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "engine_class_id": "openai_chat",
  "engine_name": "OpenAI Chat",
  "current_version_id": "456e7890-e89b-12d3-a456-426614174001",
  "organization": "org-123e4567-e89b-12d3-a456-426614174000",
  "disable_cache": false,
  "cache_failed_jobs": false,
  "job_count": 42,
  "most_recent_job": "2024-01-20T15:45:00Z"
}

Path Parameters

​
agent_id
string<uuid>
required

Query Parameters

​
organization_id
string<uuid>

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