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 '{
  "agent_name": "Support Agent",
  "assistant_id": "<string>",
  "provider": "vapi",
  "api_key": "<string>"
}'
{
  "message": "<string>",
  "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
agent_name
string
required

Name of the agent

Example:

"Support Agent"

assistant_id
string
required

Assistant ID from provider

provider
string
required

Provider (e.g., 'vapi', 'retell')

Example:

"vapi"

api_key
string
required

API key for the provider

agent_type
string

Type of agent

contact_number
string

Contact number for the agent

Example:

"+1234567890"

inbound
boolean

Whether this is an inbound agent

description
string

Agent description

language
string
default:en

Language code

websocket_url
string | null

WebSocket URL for agent communication

websocket_headers
object | null

Headers for WebSocket connection

knowledge_base
string<uuid> | null

Knowledge base ID

webhook_secret
string | null

Webhook secret for provider callbacks

observability_enabled
boolean
default:false

Enable observability tracking

commit_message
string

Initial commit message for version

Response

201 - application/json

Agent definition created

message
string
agent
object