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": "cs",
    "keywords": [
      "<string>"
    ]
  },
  "model": {
    "messages": [
      {
        "content": "<string>",
        "role": "assistant",
        "function_call": {},
        "tool_calls": [
          {}
        ]
      }
    ],
    "provider": "openai",
    "model": "gpt-4-1106-preview",
    "fallbackModels": [
      "gpt-4-0125-preview",
      "gpt-4-0613"
    ],
    "semanticCachingEnabled": true,
    "temperature": 1,
    "functions": [
      {
        "name": "<string>",
        "async": true,
        "description": "<string>",
        "parameters": {
          "type": "object",
          "properties": {},
          "required": [
            "<string>"
          ]
        },
        "serverUrl": "<string>",
        "serverUrlSecret": "<string>"
      }
    ],
    "maxTokens": 525
  },
  "voice": {
    "provider": "azure",
    "voiceId": "andrew",
    "speed": 1.25
  },
  "forwardingPhoneNumber": null,
  "recordingEnabled": true,
  "endCallFunctionEnabled": false,
  "dialKeypadFunctionEnabled": null,
  "hipaaEnabled": false,
  "clientMessages": [
    "transcript",
    "hang",
    "function-call",
    "speech-update",
    "metadata",
    "conversation-update"
  ],
  "serverMessages": [
    "end-of-call-report",
    "status-update",
    "hang",
    "function-call"
  ],
  "silenceTimeoutSeconds": 30,
  "responseDelaySeconds": 0.4,
  "llmRequestDelaySeconds": 0.1,
  "numWordsToInterruptAssistant": 2,
  "maxDurationSeconds": 1800,
  "backgroundSound": "office",
  "name": "<string>",
  "forwardingPhoneNumbers": [
    {
      "number": "<string>",
      "sipUri": "<string>",
      "message": "<string>"
    }
  ],
  "firstMessage": "<string>",
  "voicemailDetectionEnabled": true,
  "voicemailMessage": "<string>",
  "endCallMessage": "<string>",
  "endCallPhrases": [
    "<string>"
  ],
  "metadata": {},
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>"
}'
{
  "transcriber": {
    "provider": "deepgram",
    "model": "nova-2",
    "language": "cs",
    "keywords": [
      "<string>"
    ]
  },
  "model": {
    "messages": [
      {
        "content": "<string>",
        "role": "assistant",
        "function_call": {},
        "tool_calls": [
          {}
        ]
      }
    ],
    "provider": "openai",
    "model": "gpt-4-1106-preview",
    "fallbackModels": [
      "gpt-4-0125-preview",
      "gpt-4-0613"
    ],
    "semanticCachingEnabled": true,
    "temperature": 1,
    "functions": [
      {
        "name": "<string>",
        "async": true,
        "description": "<string>",
        "parameters": {
          "type": "object",
          "properties": {},
          "required": [
            "<string>"
          ]
        },
        "serverUrl": "<string>",
        "serverUrlSecret": "<string>"
      }
    ],
    "maxTokens": 525
  },
  "voice": {
    "provider": "azure",
    "voiceId": "andrew",
    "speed": 1.25
  },
  "forwardingPhoneNumber": null,
  "recordingEnabled": true,
  "endCallFunctionEnabled": false,
  "dialKeypadFunctionEnabled": null,
  "hipaaEnabled": false,
  "clientMessages": [
    "transcript",
    "hang",
    "function-call",
    "speech-update",
    "metadata",
    "conversation-update"
  ],
  "serverMessages": [
    "end-of-call-report",
    "status-update",
    "hang",
    "function-call"
  ],
  "silenceTimeoutSeconds": 30,
  "responseDelaySeconds": 0.4,
  "llmRequestDelaySeconds": 0.1,
  "numWordsToInterruptAssistant": 2,
  "maxDurationSeconds": 1800,
  "backgroundSound": "office",
  "name": "<string>",
  "forwardingPhoneNumbers": [
    {
      "number": "<string>",
      "sipUri": "<string>",
      "message": "<string>"
    }
  ],
  "firstMessage": "<string>",
  "voicemailDetectionEnabled": true,
  "voicemailMessage": "<string>",
  "endCallMessage": "<string>",
  "endCallPhrases": [
    "<string>"
  ],
  "metadata": {},
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>",
  "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.