GET
/
assistant
List Assistants
curl --request GET \
  --url https://api.vapi.ai/assistant \
  --header 'Authorization: Bearer <token>'
[
  {
    "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.

Query Parameters

​
limit
number

This is the maximum number of items to return. Defaults to 100.

Required range: 0 <= x <= 1000
​
createdAtGt
string<date-time>

This will return items where the createdAt is greater than the specified value.

​
createdAtLt
string<date-time>

This will return items where the createdAt is less than the specified value.

​
createdAtGe
string<date-time>

This will return items where the createdAt is greater than or equal to the specified value.

​
createdAtLe
string<date-time>

This will return items where the createdAt is less than or equal to the specified value.

​
updatedAtGt
string<date-time>

This will return items where the updatedAt is greater than the specified value.

​
updatedAtLt
string<date-time>

This will return items where the updatedAt is less than the specified value.

​
updatedAtGe
string<date-time>

This will return items where the updatedAt is greater than or equal to the specified value.

​
updatedAtLe
string<date-time>

This will return items where the updatedAt is less than or equal to the specified value.

Response

200 - application/json

The response is of type object[].