Get Agent Definition

Retrieves a specific agent definition with all its versions.

GET https://api.futureagi.com/simulate/agent-definitions/{agent_id}/

Authentication

X-Api-Key API Key Required

Your Future AGI API key used to authenticate requests. You can find and manage your API keys in the Dashboard under Settings.

X-Secret-Key Secret Key Required

Your Future AGI secret key, used alongside the API key for request authentication. This is generated when you create an API key in the Dashboard.

Path parameters

agent_id UUID Required

The agent definition ID.

Response

200 OK
id string
UUID of the agent definition.
agent_name string
Display name of the agent.
agent_type string
Agent type: voice or text.
contact_number string
Phone number with country code, or null.
inbound boolean
Whether the agent handles inbound calls.
description string
Agent definition description.
assistant_id string
External provider assistant ID, or null.
provider string
Voice provider (vapi, retell, eleven_labs, others), or null.
language string
Primary language as ISO 639-1 code.
languages array
All supported language codes.
websocket_url string
WebSocket URL for real-time communication, or null.
websocket_headers object
Custom WebSocket connection headers, or null.
workspace string
UUID of the workspace, or null.
knowledge_base string
UUID of the linked knowledge base, or null.
organization string
UUID of the owning organization.
model string
AI model identifier, if set.
model_details object
Extended model configuration, if available.
versions array
All version objects for this agent definition.
id string
UUID of the version.
version_number integer
Sequential version number.
status string
Lifecycle status: draft, active, archived, or deprecated.
score number
Evaluation score (0.0-10.0). null if untested.
commit_message string
Commit message for this version.
created_at datetime
ISO 8601 creation timestamp.
active_version object
Currently active version, or null.
version_count integer
Total number of versions.
created_at datetime
ISO 8601 creation timestamp.
updated_at datetime
ISO 8601 last-modified timestamp.

Errors

401 Unauthorized Optional

Invalid or missing API credentials.

404 Not Found Optional

No agent definition found with the specified ID.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE