Skip to main content
GET
/
v2
/
assistant
/
get
/
{assistantId}
Get AI Assistant
curl --request GET \
  --url https://api.voice-agents.miraiminds.co/v2/assistant/get/{assistantId} \
  --header 'workspace: <workspace>' \
  --header 'x-private-key: <api-key>' \
  --header 'x-public-key: <api-key>'
{
  "message": "Assistant fetched successfully",
  "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>"
        }
      ]
    },
    "analysisPlan": {
      "successCriteriaPlan": "<string>",
      "summaryPlan": "<string>",
      "callInsightPlan": {}
    },
    "trainingData": {
      "faq": [
        {
          "question": "What is your return policy?",
          "answer": "We offer a 7-day return policy for unused items."
        }
      ],
      "humanAgentAudioFiles": [
        "<string>"
      ]
    },
    "knowledgeBase": {
      "documents": [
        {
          "url": "<string>",
          "title": "<string>",
          "type": "pdf"
        }
      ]
    },
    "additionalFields": [
      {
        "name": "<string>",
        "type": "string",
        "isRequired": true,
        "fields": "<array>"
      }
    ],
    "_id": "<string>",
    "status": "in-process"
  }
}

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

Path Parameters

assistantId
string
required

Response

Assistant fetched successfully

message
string
Example:

"Assistant fetched successfully"

data
object