Retrieve an Agent - Roe Documentation

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

Authorizations

Authorization

string

header

required

Organization API key passed as a Bearer token. This is the scheme used by the public SDK surface.

Path Parameters

agent_id

string<uuid>

required

A UUID string identifying this 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.

Response

Successfully retrieved base agent details.

Serializer for BaseAgent (agent config)

string<uuid>

required

read-only

created_at

string<date-time>

required

read-only

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 string length: 200

current_version_id

string<uuid>

required

read-only

UUID of the current agent version.

job_count

integer | null

required

read-only

Served job count: cached baseline + live delta, annotated by the views as job_count. None when stats weren't fetched (the list can be requested with include_job_stats=false; use /agents/job-stats/).

most_recent_job

string<date-time> | null

required

read-only

engine_name

string

required

read-only

Engine Display Name