Get Agent Version

Retrieves a specific version of an agent definition with its configuration snapshot.

GET https://api.futureagi.com/simulate/agent-definitions/{agent_id}/versions/{version_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.

version_id UUID Required

The agent version ID.

Response

200 OK
id string
UUID of the version.
version_number integer
Sequential version number starting from 1.
version_name string
Short version name (e.g. v1, v2).
version_name_display string
Formatted display name.
status string
Lifecycle status: draft, active, archived, or deprecated.
status_display string
Human-readable status label.
score number
Evaluation score (0.010.0). null if untested.
test_count integer
Total test executions run against this version.
pass_rate number
Test pass percentage (0100). null if untested.
description string
Version description.
commit_message string
Commit message for this version.
release_notes string
Release notes, or null.
agent_definition string
UUID of the parent agent definition.
organization string
UUID of the owning organization.
configuration_snapshot object

Immutable snapshot of agent config at version creation.

agent_name string
Display name at the time of snapshot.
agent_type string
voice or text.
inbound boolean
Whether the agent handled inbound calls.
languages array
Supported language codes.
language string
Primary language ISO 639-1 code.
provider string
Voice provider.
contact_number string
Phone number with country code.
assistant_id string
External provider assistant ID.
api_key string
Provider API key (masked).
authentication_method string
Provider auth method.
observability_enabled boolean
Whether observability was enabled.
description string
Agent description.
knowledge_base string
Linked knowledge base UUID, or null.
commit_message string
Commit message for this version.
model string
AI model identifier.
model_details object
Extended model configuration.
livekit_url string
LiveKit server URL.
livekit_api_key string
LiveKit API key.
livekit_api_secret string
Always returned as ******** (masked).
livekit_agent_name string
LiveKit agent name.
livekit_config_json object
LiveKit room configuration.
livekit_max_concurrency integer
Max concurrent LiveKit sessions. Defaults to 5.
is_active boolean
Whether this is the currently active version.
is_latest boolean
Whether this is the most recent version.
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

Agent definition or version not found.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST
 
RESPONSE