Skip to main content
POST
/
simulate
/
agent-definitions
/
create
/
Create agent definition
curl --request POST \
  --url https://api.futureagi.com/simulate/agent-definitions/create/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>' \
  --data '{
  "agentName": "test-ag",
  "provider": "vapi",
  "language": "en",
  "contactNumber": "<contact_number>"
}'
{
  "message": "Agent definition created successfully",
  "agent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "agent_type": "<string>",
    "contact_number": "<string>",
    "inbound": true,
    "description": "<string>",
    "assistant_id": "<string>",
    "provider": "<string>",
    "language": "<string>",
    "websocket_url": "<string>",
    "websocket_headers": {},
    "knowledge_base": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "api_key": "<string>",
    "webhook_secret": "<string>",
    "observability_provider": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-Api-Key
string
header
required

API Key for authentication. Click here to access API Key

​
X-Secret-Key
string
header
required

Secret Key for authentication. Click here to access Secret Key

Body

application/json
​
agentName
string
required

Name of the agent.

​
provider
enum<string>
required

Provider for the agent (e.g., vapi, retell).

Available options:
vapi,
retell
​
language
string
required

Language of the agent (ISO 639-1 code, for example, en for English).

​
contactNumber
string
required

Contact number for the agent including country code. For example, +1xxxxxxxxxx for USA, +91xxxxxxxxxx for India, etc.

​
agentType
enum<string>

Type of the agent.

Available options:
voice,
text
​
apiKey
string<uuid>

API key for the agent provider.

​
assistantId
string

External identifier for the assistant.

​
description
string

Description for the first version of the agent.

​
knowledgeBase
string<uuid> | null

ID of the knowledge base to associate with the agent.

​
countryCode
string

Country code for the contact number. For example, 1 for USA, 91 for India, etc.

​
inbound
boolean

Specifies if the agent handles inbound communication.

​
commitMessage
string

Commit message for the initial version of the agent.

​
observabilityEnabled
boolean

Enable observability for the agent.

Response

Agent definition created successfully.

​
message
string
Example:

"Agent definition created successfully"

​
agent
object