Create Agent

curl -X POST https://api.vaanivoice.ai/api/create-agent \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_display_name": "support-bot",
    "config": {
      "persona": {
        "identity": {
          "system_prompt": "You are a helpful customer support agent."
        }
      }
    }
  }'

const response = await fetch("https://api.vaanivoice.ai/api/create-agent", {
  method: "POST",
  headers: {
    "X-API-Key": "vaani_<your_key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    agent_display_name: "support-bot",
    config: {
      persona: {
        identity: {
          system_prompt: "You are a helpful customer support agent.",
        },
      },
    },
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://api.vaanivoice.ai/api/create-agent",
    headers={
        "X-API-Key": "vaani_<your_key>",
        "Content-Type": "application/json",
    },
    json={
        "agent_display_name": "support-bot",
        "config": {
            "persona": {
                "identity": {
                    "system_prompt": "You are a helpful customer support agent."
                }
            }
        },
    },
)
print(response.json())

{
  "success": true,
  "agent_id": "7ec4155e-0e62-440a-b983-5974f7697854",
  "agent_name": "support-bot",
  "client_id": "9abf5eff-e978-4e87-954d-7ff6ba570796"
}

POST

api

create-agent

curl -X POST https://api.vaanivoice.ai/api/create-agent \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_display_name": "support-bot",
    "config": {
      "persona": {
        "identity": {
          "system_prompt": "You are a helpful customer support agent."
        }
      }
    }
  }'

const response = await fetch("https://api.vaanivoice.ai/api/create-agent", {
  method: "POST",
  headers: {
    "X-API-Key": "vaani_<your_key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    agent_display_name: "support-bot",
    config: {
      persona: {
        identity: {
          system_prompt: "You are a helpful customer support agent.",
        },
      },
    },
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://api.vaanivoice.ai/api/create-agent",
    headers={
        "X-API-Key": "vaani_<your_key>",
        "Content-Type": "application/json",
    },
    json={
        "agent_display_name": "support-bot",
        "config": {
            "persona": {
                "identity": {
                    "system_prompt": "You are a helpful customer support agent."
                }
            }
        },
    },
)
print(response.json())

{
  "success": true,
  "agent_id": "7ec4155e-0e62-440a-b983-5974f7697854",
  "agent_name": "support-bot",
  "client_id": "9abf5eff-e978-4e87-954d-7ff6ba570796"
}

Create a new agent and associate it with the authenticated user’s client. The client_id is automatically extracted from your API key — you don’t need to supply it.

Parameters

string

required

Human-readable name for the agent (e.g. "support-bot")

object

default:"{}"

Optional initial configuration for the agent. You can pass any subset of the agent config sections here or leave it empty and configure them later via the section PATCH endpoints.

Show config structure

object

Persona section — identity, senses/capabilities, actions, memories.

object

Training section — knowledge base (RAG), FAQ, guardrails.

object

Experience section — conversational feel, call settings.

object

Analysis section — dispositions, data extraction.

object

Deployment section — phone call-type routing.

Request Example

curl -X POST https://api.vaanivoice.ai/api/create-agent \
  -H "X-API-Key: vaani_<your_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_display_name": "support-bot",
    "config": {
      "persona": {
        "identity": {
          "system_prompt": "You are a helpful customer support agent."
        }
      }
    }
  }'

const response = await fetch("https://api.vaanivoice.ai/api/create-agent", {
  method: "POST",
  headers: {
    "X-API-Key": "vaani_<your_key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    agent_display_name: "support-bot",
    config: {
      persona: {
        identity: {
          system_prompt: "You are a helpful customer support agent.",
        },
      },
    },
  }),
});

const data = await response.json();
console.log(data);

import requests

response = requests.post(
    "https://api.vaanivoice.ai/api/create-agent",
    headers={
        "X-API-Key": "vaani_<your_key>",
        "Content-Type": "application/json",
    },
    json={
        "agent_display_name": "support-bot",
        "config": {
            "persona": {
                "identity": {
                    "system_prompt": "You are a helpful customer support agent."
                }
            }
        },
    },
)
print(response.json())

Response

{
  "success": true,
  "agent_id": "7ec4155e-0e62-440a-b983-5974f7697854",
  "agent_name": "support-bot",
  "client_id": "9abf5eff-e978-4e87-954d-7ff6ba570796"
}

boolean

true when the agent was created successfully.

string

UUID of the newly created agent. Use this in subsequent PATCH calls and when triggering calls.

string

Display name of the new agent.

string

Client UUID the agent was associated with (resolved from your API key).

Overview

Campaigns

Agents

Calls

Create Agent

Create Agent

Parameters

Request Example

Response

​Create Agent

​Parameters

​Request Example

​Response

Create Agent

Parameters

Request Example

Response