Skip to main content
POST
/
v2
/
assistant
/
create
Create AI Assistant
curl --request POST \
  --url https://api.voice-agents.miraiminds.co/v2/assistant/create \
  --header 'Content-Type: application/json' \
  --header 'workspace: <workspace>' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>' \
  --data '
{
  "name": "My Abandoned Cart Assistant",
  "variant": "abandoned_cart",
  "agentIdentity": {
    "name": "neha",
    "gender": "female",
    "voice": "neha"
  },
  "variantConfigs": {
    "systemPrompt": ""
  },
  "icpContext": {
    "targetAgeGroups": [
      "millennials"
    ],
    "locationTiers": [
      "metro_urban"
    ],
    "language": "english",
    "targetAudience": [
      "female"
    ]
  },
  "callSettings": {
    "slots": [
      {
        "startTime": "10:00",
        "endTime": "17:30"
      }
    ],
    "maxCallDuration": 200,
    "concurrentCallCount": 5,
    "retryProtocol": {
      "maxAttemptsNoPickup": 2,
      "maxAttemptsLowEngagement": 1,
      "reAttemptPeriod": 300,
      "maxRescheduleCount": 1
    }
  }
}
'
{
  "message": "Assistant created successfully",
  "data": {
    "assistantId": "<string>",
    "status": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.miraiminds.co/llms.txt

Use this file to discover all available pages before exploring further.

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
​
variant
enum<string>
required

This value changes the validation rules for 'AdditionalContext'

Available options:
abandoned_cart,
custom
​
agentIdentity
object
required
​
icpContext
object
required
​
callSettings
object
required
​
variantConfigs
object
required

Variant-specific configuration. For custom variant, systemPrompt is required. For abandoned_cart, systemPrompt is optional (overrides the generated one). variables defines the fields expected in the call payload.

​
analysisPlan
object
​
trainingData
object
​
knowledgeBase
object

Response

Assistant Created

​
message
string
Example:

"Assistant created successfully"

​
data
object