curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v1/admin/assistant/create \
  --header 'Content-Type: application/json' \
  --header 'workspace: <workspace>' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "name": "Order Update Assistant",
  "variant": {
    "type": "custom",
    "config": {
      "inputSchema": [
        {
          "name": "customerName",
          "type": "string",
          "isRequired": true
        },
        {
          "name": "orderId",
          "type": "string",
          "isRequired": true
        },
        {
          "name": "deliveryDate",
          "type": "string",
          "isRequired": false
        },
        {
          "name": "token",
          "type": "string",
          "isRequired": false
        }
      ]
    }
  },
  "agent": {
    "identity": {
      "name": "priya",
      "gender": "female",
      "voice": "priya"
    },
    "systemPrompt": "You are Priya, a friendly support agent for Acme. Greet the customer: Hello {{customerName}}! You are calling about order {{orderId}}. If a delivery date is available, mention it: your order is expected on {{deliveryDate}}. Confirm the details and answer any questions politely. When asked about policies or products, search the knowledge base first.",
    "tools": [
      "6710a1b2c3d4e5f600000020"
    ]
  }
}
'

{
  "message": "Assistant created successfully",
  "data": {
    "assistantId": "<string>"
  }
}

Assistant

Create AI Assistant

Creates a new AI assistant with the specified configuration. The variant.type determines the assistant’s behavior and the required variant.config structure.

Variants

abandoned_cart — a ready-made flow; provide variant.config.abandoned_cart (e.g. payment plan). The system prompt is generated from the variant template, so agent.systemPrompt can be left empty.
cod_to_prepaid — converts Shopify COD orders to prepaid. Provide variant.config.cod_to_prepaid.paymentLinkValidity, codFee, and supportContacts.
address_verification — verifies or collects Shopify shipping addresses. Provide variant.config.address_verification.minDays, maxDays, and supportContacts.
order_confirmation — confirms Shopify orders before fulfillment. Optional config: variant.config.order_confirmation.supportContacts.
ndr_followup — follows up on failed delivery / NDR events. Optional config: variant.config.ndr_followup.maxRescheduleDays, webhookToken, and supportContacts.
custom — you fully author the behavior. Put your prompt in agent.systemPrompt and declare any dynamic variables in variant.config.inputSchema.

For preset variants, leave agent.systemPrompt empty and pass the required per-call data in payload when initiating the call.

Using variables in agent.systemPrompt (custom variant)

Reference a variable with the {{variableName}} placeholder syntax; nested values use dot-paths, e.g. {{customer.firstName}}. Each variable you reference should be declared in variant.config.inputSchema (name + type, mark isRequired: true when mandatory). The actual values are supplied per call through the variableValues object when you initiate the call — at that point every {{placeholder}} is substituted with the matching value. Any placeholder with no matching value is left untouched in the prompt.

POST

admin

assistant

create

curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v1/admin/assistant/create \
  --header 'Content-Type: application/json' \
  --header 'workspace: <workspace>' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "name": "Order Update Assistant",
  "variant": {
    "type": "custom",
    "config": {
      "inputSchema": [
        {
          "name": "customerName",
          "type": "string",
          "isRequired": true
        },
        {
          "name": "orderId",
          "type": "string",
          "isRequired": true
        },
        {
          "name": "deliveryDate",
          "type": "string",
          "isRequired": false
        },
        {
          "name": "token",
          "type": "string",
          "isRequired": false
        }
      ]
    }
  },
  "agent": {
    "identity": {
      "name": "priya",
      "gender": "female",
      "voice": "priya"
    },
    "systemPrompt": "You are Priya, a friendly support agent for Acme. Greet the customer: Hello {{customerName}}! You are calling about order {{orderId}}. If a delivery date is available, mention it: your order is expected on {{deliveryDate}}. Confirm the details and answer any questions politely. When asked about policies or products, search the knowledge base first.",
    "tools": [
      "6710a1b2c3d4e5f600000020"
    ]
  }
}
'

{
  "message": "Assistant created successfully",
  "data": {
    "assistantId": "<string>"
  }
}

Authorizations

x-public-key

string

header

required

x-private-key

string

header

required

Headers

x-public-key

string

required

x-private-key

string

required

workspace

string

required

Body

application/json

name

string

required

Maximum string length: 40

variant

object

required

Show child attributes

agent

object

required

Show child attributes

telephony

object

Telephony numbers linked to the assistant. Each value is the _id of a telephony number (from GET /v1/number-pool/{telephonyNumberId} or POST /v1/number-pool/purchase).

inbound — the phone number customers call to reach this assistant. When someone dials it, the assistant picks up automatically and follows its systemPrompt. Only one assistant can hold an inbound number at a time; assigning it here removes it from any other assistant.
outbound — the caller ID shown to customers when the assistant places an outgoing call.

Auto-assignment: In production, the first assistant in a new workspace automatically receives the workspace's default number as outbound. Additional assistants must be assigned numbers explicitly.

Show child attributes

analysisPlan

object

Post-call AI evaluation configuration. After each call ends, the platform runs these prompts against the call recording and transcript. Results are returned in the end-of-call webhook event and visible in the call dashboard.

Show child attributes

preCall

object

Configure pre-call enrichment during assistant creation. Supports templated apiPlan.headers and apiPlan.body values from per-call variableValues.

Show child attributes

icpContext

object

Show child attributes

callSettings

object

Show child attributes

knowledgeBase

object

Combined knowledge base containing both documents and FAQ entries.

Show child attributes

Response

Assistant Created

message

string

Example:

"Assistant created successfully"

data

object

Show child attributes

Start

Developer guides

API v1 reference

Endpoints

Guides

Integrations

Use cases

Create AI Assistant

Authorizations

Headers

Body

Response