Create Agent Definition

Creates a new agent definition with its first version.

POST https://api.futureagi.com/simulate/agent-definitions/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.

Request body

agentType string Required

The communication channel for the agent. Values: "voice", "text".

agentName string Required

Display name for the agent.

provider string Required

The external voice provider. Values: "vapi", "retell", "eleven_labs", "others". Required for voice agents.

apiKey string Optional

API key for the external voice provider. Required for outbound agents or when observabilityEnabled is true.

assistantId string Optional

Assistant ID from the external provider. Required for outbound agents or when observabilityEnabled is true.

description string Optional

Description for the initial agent version.

language string Required

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

knowledgeBase string Optional

UUID of a knowledge base to link to the agent.

countryCode string Optional

Phone country code without the + prefix (e.g., "1", "91").

contactNumber string Required

Full phone number with country code prefix (e.g., "+14155551234"). Number portion must be 10-12 digits.

inbound boolean Optional

Whether the agent handles inbound calls. Defaults to false (outbound-only).

commitMessage string Optional

Commit message for the initial version. A default is generated if omitted.

observabilityEnabled boolean Optional

Enables ingestion of call logs and transcripts from the provider. Requires apiKey and assistantId.

Response

201 Created
message string
Confirmation message.
agent object
The created agent definition object.

Errors

400 Bad Request Optional

Missing required fields or invalid values.

401 Unauthorized Optional

Invalid or missing API credentials.

500 Internal Server Error Optional

Unexpected server error.

GET /
Authentication
REQUEST
 
RESPONSE