Skip to main content
POST
/
simulate
/
agent-definitions
/
{agent_id}
/
versions
/
create
/
Create new version of agent
curl --request POST \
  --url https://api.futureagi.com/simulate/agent-definitions/{agent_id}/versions/create/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Secret-Key: <api-key>' \
  --data '{
  "agent_type": "voice",
  "agent_name": "test-agiii",
  "provider": "vapi",
  "api_key": "<api_key>",
  "assistant_id": "<assistant_id>",
  "description": "<description>",
  "language": "en",
  "knowledge_base": null,
  "contact_number": "<contact_number>",
  "inbound": true,
  "commit_message": "<commit_message>",
  "observability_enabled": true
}'
{
  "message": "Agent version created successfully",
  "version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "version_name": "<string>",
    "version_name_display": "<string>",
    "status": "<string>",
    "status_display": "<string>",
    "score": 123,
    "test_count": 123,
    "pass_rate": 123,
    "description": "<string>",
    "commit_message": "<string>",
    "release_notes": "<string>",
    "agent_definition": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "configuration_snapshot": {},
    "is_active": true,
    "is_latest": true,
    "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

Path Parameters

​
agent_id
string<uuid>
required

A UUID string identifying the agent definition.

Body

application/json
​
agent_type
enum<string>

Type of the agent.

Available options:
voice,
text
​
agent_name
string

Name of the agent.

​
provider
string

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

​
api_key
string<uuid>

API key for the agent provider.

​
assistant_id
string

External identifier for the assistant.

​
description
string

New description for the agent.

​
language
string

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

​
knowledge_base
string<uuid> | null

ID of the knowledge base to associate with the agent.

​
contact_number
string

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

​
inbound
boolean

Specifies if the agent handles inbound communication.

​
commit_message
string

Commit message for this new version.

​
observability_enabled
boolean

Enable or disable observability for the agent.

Response

Agent version created successfully.

​
message
string
Example:

"Agent version created successfully"

​
version
object