Create Agent Version

Creates a new version of an agent definition.

POST https://api.futureagi.com/simulate/agent-definitions/{agent_id}/versions/create/

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.

Request body

All fields except commitMessage are optional. Omitted fields inherit values from the current agent definition.

agentType string Optional

The agent type. Must be "voice" or "text".

agentName string Optional

Updated display name for the agent.

provider string Optional

Voice provider. One of "vapi", "retell", "elevenLabs", or "others".

apiKey string Optional

API key for the external voice provider.

assistantId string Optional

Assistant identifier from the external provider.

description string Optional

Description for this version.

language string Optional

Primary language as an ISO 639-1 code (e.g., "en", "es").

knowledgeBase string Optional

UUID of a knowledge base to link. Pass null to remove.

contactNumber string Optional

Phone number with country code prefix. Must be 10-12 digits.

inbound boolean Optional

Whether the agent handles inbound calls.

commitMessage string Required

Commit message describing the changes in this version.

observabilityEnabled boolean Optional

Toggle provider observability integration.

Response

201 Created
message string
Confirmation message.
version object
Created agent version object with id, version_number, and status.

Errors

400 Bad Request Optional

Missing required fields or invalid values.

401 Unauthorized Optional

Invalid or missing API credentials.

404 Not Found Optional

Agent definition not found.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST 
 
 
  
 
 RESPONSE