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": "<string>",
  "variant": "abandoned_cart",
  "agentIdentity": {
    "name": "<string>",
    "gender": "male",
    "voice": "<string>",
    "traits": [
      "elegant"
    ]
  },
  "icpContext": {
    "targetAgeGroups": [
      "gen_z"
    ],
    "locationTiers": [
      "metro_urban"
    ],
    "language": "hinglish",
    "targetAudience": [
      "male"
    ]
  },
  "callSettings": {
    "slots": [
      {
        "startTime": "10:00",
        "endTime": "13:00"
      }
    ],
    "retryProtocol": {
      "maxAttemptsNoPickup": 2,
      "maxAttemptsLowEngagement": 1,
      "reAttemptPeriod": 300,
      "maxRescheduleCount": 1
    },
    "maxCallDuration": 200,
    "concurrentCallCount": 5
  },
  "variantConfigs": {
    "pitchFlow": [
      "company_usp_pitch",
      "return_policy_assurance",
      "discount_offer"
    ],
    "discountRules": {
      "canOffer": true,
      "maxPercent": 15
    },
    "systemPrompt": "<string>",
    "variables": [
      {
        "name": "<string>",
        "type": "string",
        "isRequired": true,
        "fields": "<array>"
      }
    ]
  }
}
'
{
  "message": "Assistant created successfully",
  "data": {
    "assistantId": "<string>",
    "status": "<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
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

Dynamic configuration based on assistant type.

analysisPlan
object
trainingData
object
knowledgeBase
object
additionalFields
object[]

Response

Assistant Created

message
string
Example:

"Assistant created successfully"

data
object