POST
/
assistant
curl --request POST \
  --url https://api.vapi.ai/assistant \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "transcriber": {
    "provider": "deepgram",
    "model": "nova-2",
    "language": "bg",
    "smartFormat": false,
    "keywords": [
      "<string>"
    ]
  },
  "model": {
    "messages": [
      {
        "content": "<string>",
        "role": "assistant"
      }
    ],
    "tools": [
      {
        "async": false,
        "messages": [
          {
            "type": "request-start",
            "content": "<string>",
            "conditions": [
              {
                "param": "<string>",
                "value": {},
                "operator": "eq"
              }
            ]
          }
        ],
        "type": "transferCall",
        "destinations": [
          {
            "type": "assistant",
            "assistantName": "<string>",
            "message": "<string>",
            "description": "<string>"
          }
        ],
        "function": {
          "name": "<string>",
          "description": "<string>",
          "parameters": {
            "type": "object",
            "properties": {},
            "required": [
              "<string>"
            ]
          }
        },
        "server": {
          "url": "<string>",
          "secret": "<string>"
        }
      }
    ],
    "toolIds": [
      "<string>"
    ],
    "provider": "openai",
    "model": "gpt-4o",
    "fallbackModels": [
      "gpt-4-0125-preview",
      "gpt-4-0613"
    ],
    "semanticCachingEnabled": true,
    "numFastTurns": 1,
    "temperature": 1,
    "knowledgeBase": {
      "provider": "canonical",
      "topK": 123,
      "fileIds": [
        "<string>"
      ]
    },
    "maxTokens": 525,
    "emotionRecognitionEnabled": true
  },
  "voice": {
    "inputPreprocessingEnabled": true,
    "inputMinCharacters": 10,
    "inputPunctuationBoundaries": [
      "。",
      "，",
      ".",
      "!",
      "?",
      ";",
      ")",
      "،",
      "۔",
      "।",
      "॥",
      "|",
      "||",
      ",",
      ":"
    ],
    "fillerInjectionEnabled": false,
    "provider": "azure",
    "voiceId": "andrew",
    "speed": 1.25
  },
  "firstMessageMode": "assistant-speaks-first",
  "recordingEnabled": true,
  "hipaaEnabled": false,
  "clientMessages": [
    "transcript",
    "hang",
    "tool-calls",
    "speech-update",
    "metadata",
    "conversation-update"
  ],
  "serverMessages": [
    "end-of-call-report",
    "status-update",
    "hang",
    "tool-calls"
  ],
  "silenceTimeoutSeconds": 30,
  "responseDelaySeconds": 0.4,
  "llmRequestDelaySeconds": 0.1,
  "numWordsToInterruptAssistant": 1,
  "maxDurationSeconds": 1800,
  "backgroundSound": "office",
  "backchannelingEnabled": true,
  "name": "<string>",
  "firstMessage": "<string>",
  "voicemailDetection": {
    "provider": "twilio",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence"
    ],
    "enabled": true,
    "machineDetectionTimeout": 31,
    "machineDetectionSpeechThreshold": 3500,
    "machineDetectionSpeechEndThreshold": 2750,
    "machineDetectionSilenceTimeout": 6000
  },
  "voicemailMessage": "<string>",
  "endCallMessage": "<string>",
  "endCallPhrases": [
    "<string>"
  ],
  "metadata": {},
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>",
  "analysisPlan": {
    "summaryPrompt": "<string>",
    "successEvaluationPrompt": "<string>",
    "successEvaluationRubric": "NumericScale",
    "structuredDataPrompt": "<string>",
    "structuredDataSchema": {
      "type": "string",
      "items": {},
      "properties": {},
      "description": "<string>",
      "required": [
        {}
      ]
    }
  }
}'
{
  "transcriber": {
    "provider": "deepgram",
    "model": "nova-2",
    "language": "bg",
    "smartFormat": false,
    "keywords": [
      "<string>"
    ]
  },
  "model": {
    "messages": [
      {
        "content": "<string>",
        "role": "assistant"
      }
    ],
    "tools": [
      {
        "async": false,
        "messages": [
          {
            "type": "request-start",
            "content": "<string>",
            "conditions": [
              {
                "param": "<string>",
                "value": {},
                "operator": "eq"
              }
            ]
          }
        ],
        "type": "transferCall",
        "destinations": [
          {
            "type": "assistant",
            "assistantName": "<string>",
            "message": "<string>",
            "description": "<string>"
          }
        ],
        "function": {
          "name": "<string>",
          "description": "<string>",
          "parameters": {
            "type": "object",
            "properties": {},
            "required": [
              "<string>"
            ]
          }
        },
        "server": {
          "url": "<string>",
          "secret": "<string>"
        }
      }
    ],
    "toolIds": [
      "<string>"
    ],
    "provider": "openai",
    "model": "gpt-4o",
    "fallbackModels": [
      "gpt-4-0125-preview",
      "gpt-4-0613"
    ],
    "semanticCachingEnabled": true,
    "numFastTurns": 1,
    "temperature": 1,
    "knowledgeBase": {
      "provider": "canonical",
      "topK": 123,
      "fileIds": [
        "<string>"
      ]
    },
    "maxTokens": 525,
    "emotionRecognitionEnabled": true
  },
  "voice": {
    "inputPreprocessingEnabled": true,
    "inputMinCharacters": 10,
    "inputPunctuationBoundaries": [
      "。",
      "，",
      ".",
      "!",
      "?",
      ";",
      ")",
      "،",
      "۔",
      "।",
      "॥",
      "|",
      "||",
      ",",
      ":"
    ],
    "fillerInjectionEnabled": false,
    "provider": "azure",
    "voiceId": "andrew",
    "speed": 1.25
  },
  "firstMessageMode": "assistant-speaks-first",
  "recordingEnabled": true,
  "hipaaEnabled": false,
  "clientMessages": [
    "transcript",
    "hang",
    "tool-calls",
    "speech-update",
    "metadata",
    "conversation-update"
  ],
  "serverMessages": [
    "end-of-call-report",
    "status-update",
    "hang",
    "tool-calls"
  ],
  "silenceTimeoutSeconds": 30,
  "responseDelaySeconds": 0.4,
  "llmRequestDelaySeconds": 0.1,
  "numWordsToInterruptAssistant": 1,
  "maxDurationSeconds": 1800,
  "backgroundSound": "office",
  "backchannelingEnabled": true,
  "name": "<string>",
  "firstMessage": "<string>",
  "voicemailDetection": {
    "provider": "twilio",
    "voicemailDetectionTypes": [
      "machine_end_beep",
      "machine_end_silence"
    ],
    "enabled": true,
    "machineDetectionTimeout": 31,
    "machineDetectionSpeechThreshold": 3500,
    "machineDetectionSpeechEndThreshold": 2750,
    "machineDetectionSilenceTimeout": 6000
  },
  "voicemailMessage": "<string>",
  "endCallMessage": "<string>",
  "endCallPhrases": [
    "<string>"
  ],
  "metadata": {},
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>",
  "analysisPlan": {
    "summaryPrompt": "<string>",
    "successEvaluationPrompt": "<string>",
    "successEvaluationRubric": "NumericScale",
    "structuredDataPrompt": "<string>",
    "structuredDataSchema": {
      "type": "string",
      "items": {},
      "properties": {},
      "description": "<string>",
      "required": [
        {}
      ]
    }
  },
  "id": "<string>",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Retrieve your key from Dashboard.

Body

application/json

Response

201 - application/json

The response is of type object.