Vapi

https://docs.vapi.ai/api-reference
Admin
Vapi is an AI voice platform that enables developers to build, manage, and deploy intelligent voice...
Tokens:211,387
Snippets:980
Trust Score:9.2
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### List Knowledge Bases Response Example

Source: https://docs.vapi.ai/api-reference/knowledge-bases-v-2/knowledge-base-v-2-controller-find-all

Example JSON response returned by the GET /v2/knowledge-base endpoint with a 200 status. Each object represents a knowledge base with fields for name, id, orgId, createdAt, updatedAt, and description.

```json
[
  {
    "name": "string",
    "id": "string",
    "orgId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "description": "string"
  }
]
```

--------------------------------

### 200 response for Get Board

Source: https://docs.vapi.ai/api-reference/board/board-controller-find-one

Example JSON response returned when the board is successfully retrieved. Contains board metadata, layout, items, and optional time range override.

```json
{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "name": "string",
  "layout": {
    "columns": 6
  },
  "items": [
    {
      "insightId": "string",
      "position": {
        "x": 1.1,
        "y": 1.1
      },
      "size": {
        "height": 1.1,
        "width": 1.1
      },
      "systemKey": "string",
      "type": "insight"
    }
  ],
  "systemKey": "string",
  "timeRangeOverride": {
    "step": "minute",
    "start": "\"2025-01-01\" or \"-7d\" or \"now\"",
    "end": "\"2025-01-01\" or \"now\"",
    "timezone": "string"
  }
}

```

--------------------------------

### Example 200 response for list simulations

Source: https://docs.vapi.ai/api-reference/simulations/simulation-controller-find-all

Example JSON response returned when the request succeeds. Contains an array of simulation objects with fields such as id, orgId, createdAt, updatedAt, scenarioId, personalityId, name, and path.

```json
[
  {
    "id": "string",
    "orgId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "scenarioId": "string",
    "personalityId": "string",
    "name": "Eligible Path with Confused User",
    "path": "string"
  }
]
```

--------------------------------

### 201 Created response example

Source: https://docs.vapi.ai/api-reference/traffic-allocations/traffic-allocation-controller-create

Example 201 Created response body for the create traffic allocation endpoint. Shows the allocation object with id, orgId, allocationIntent, createdAt, actorType, targets, assistantId, actorId, actorEmail, and description fields.

```json
{
  "id": "string",
  "orgId": "string",
  "allocationIntent": "follow-latest",
  "createdAt": "2024-01-15T09:30:00Z",
  "actorType": "user",
  "targets": [
    {
      "assistantVersion": "string",
      "position": 1.1,
      "percentage": 1.1
    }
  ],
  "assistantId": "string",
  "actorId": "string",
  "actorEmail": "string",
  "description": "string"
}
```

--------------------------------

### 200 Response for Get Simulation Concurrency

Source: https://docs.vapi.ai/api-reference/simulations/simulation-controller-get-concurrency

Example 200 response from the GET /eval/simulation/concurrency endpoint. Shows the organization's concurrency limit, active simulations, available to start, timestamps, and whether the default limit is used.

```json
{
  "orgId": "string",
  "concurrencyLimit": 1.1,
  "activeSimulations": 1.1,
  "availableToStart": 1.1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "isDefault": true
}
```

--------------------------------

### Create Tool Response (201 Created)

Source: https://docs.vapi.ai/api-reference/tools/create

Example response body returned with a 201 Created status when a tool is successfully created. Shows the full tool object including backoffPlan, body schema, and credentialId.

```json
{
  "type": "apiRequest",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "method": "POST",
  "orgId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "url": "string",
  "backoffPlan": {
    "type": "fixed",
    "maxRetries": 0,
    "baseDelaySeconds": 1,
    "excludedStatusCodes": [
      400,
      401,
      403,
      404
    ]
  },
  "body": {
    "type": "string",
    "items": {
      "type": "string",
      "items": {
        "type": "string",
        "items": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": {},
                        "items": {},
                        "properties": {},
                        "description": {},
                        "pattern": {},
                        "format": {},
                        "required": {},
                        "enum": {},
                        "title": {}
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "properties": {},
        "description": "string",
        "pattern": "string",
        "format": "date-time",
        "required": [
          "string"
        ],
        "enum": [
          "string"
        ],
        "title": "string"
      },
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    },
    "properties": {},
    "description": "string",
    "pattern": "string",
    "format": "date-time",
    "required": [
      "string"
    ],
    "enum": [
      "string"
    ],
    "title": "string"
  },
  "credentialId": "550e8400-e29b-41d4-a716-446655440000",
  "description": "string"
}
```

--------------------------------

### 200 Response for Get Insights

Source: https://docs.vapi.ai/api-reference/insight/insight-controller-find-all

Example 200 response returned by the GET /reporting/insight endpoint. Contains a results array of reporting insight objects and a metadata object with pagination details.

```json
{
  "results": [
    {
      "type": "bar",
      "id": "string",
      "orgId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "name": "string",
      "systemKey": "string"
    }
  ],
  "metadata": {
    "itemsPerPage": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1,
    "totalPages": 1.1,
    "hasNextPage": true,
    "nextCursor": "string",
    "sortOrder": "ASC",
    "itemsBeyondRetention": true,
    "createdAtLe": "2024-01-15T09:30:00Z",
    "createdAtGe": "2024-01-15T09:30:00Z"
  }
}
```

--------------------------------

### 201 Created response for create simulation suite

Source: https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-create

Example response body returned when the simulation suite is successfully created. Contains the suite ID, org ID, timestamps, name, simulation IDs, target assignments, Slack webhook URL, and path.

```json
{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "name": "Checkout Flow Tests",
  "simulationIds": [
    "string"
  ],
  "targetAssignments": [
    {
      "targetType": "assistant",
      "targetId": "string"
    }
  ],
  "slackWebhookUrl": "string",
  "path": "string"
}
```

--------------------------------

### Create Knowledge Base V2 Response

Source: https://docs.vapi.ai/api-reference/knowledge-bases-v-2/knowledge-base-v-2-controller-create

Example response body returned when the knowledge base is successfully created. The response includes the knowledge base name, id, orgId, creation and update timestamps, and an optional description.

```json
{
  "name": "string",
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "description": "string"
}
```

--------------------------------

### Get Simulation 200 Response

Source: https://docs.vapi.ai/api-reference/simulations/simulation-controller-find-one

Example 200 response body for the Get Simulation endpoint. Contains simulation metadata including id, orgId, timestamps, scenarioId, personalityId, optional name, and optional path.

```json
{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "scenarioId": "string",
  "personalityId": "string",
  "name": "Eligible Path with Confused User",
  "path": "string"
}
```

--------------------------------

### 200 response for listing tools

Source: https://docs.vapi.ai/api-reference/tools/list

Example JSON response returned when the request succeeds. Contains an array of tool objects with fields like type, createdAt, id, method, orgId, updatedAt, url, backoffPlan, and body.

```json
[
  {
    "type": "apiRequest",
    "createdAt": "2024-01-15T09:30:00Z",
    "id": "string",
    "method": "POST",
    "orgId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "url": "string",
    "backoffPlan": {
      "type": "fixed",
      "maxRetries": 0,
      "baseDelaySeconds": 1,
      "excludedStatusCodes": [
        400,
        401,
        403,
        404
      ]
    },
    "body": {
      "type": "string",
      "items": {
        "type": "string",
        "items": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": "string",
                        "items": {
                          "type": {},
                          "items": {},
                          "properties": {},
                          "description": {},
                          "pattern": {},
                          "format": {},
                          "required": {},
                          "enum": {},
                          "title": {}
                        },
                        "properties": {},
                        "description": "string",
                        "pattern": "string",
                        "format": "date-time",
                        "required": [
                          "string"
                        ],
                        "enum": [
                          "string"
                        ],
                        "title": "string"
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "properties": {},
        "description": "string",
        "pattern": "string",
        "format": "date-time",
        "required": [
          "string"
        ],
        "enum": [
          "string"
        ],
        "title": "string"
      },
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    }
  }
]
```

--------------------------------

### Get Boards 200 Response

Source: https://docs.vapi.ai/api-reference/board/board-controller-find-all

Example 200 response returned by the Get Boards endpoint. Contains a list of board objects with layout, items, and time range override fields, plus pagination metadata.

```json
{
  "results": [
    {
      "id": "string",
      "orgId": "string",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "name": "string",
      "layout": {
        "columns": 6
      },
      "items": [
        {
          "insightId": "string",
          "position": {
            "x": 1.1,
            "y": 1.1
          },
          "size": {
            "height": 1.1,
            "width": 1.1
          },
          "systemKey": "string",
          "type": "insight"
        }
      ],
      "systemKey": "string",
      "timeRangeOverride": {
        "step": "minute",
        "start": "\"2025-01-01\" or \"-7d\" or \"now\"",
        "end": "\"2025-01-01\" or \"now\"",
        "timezone": "string"
      }
    }
  ],
  "metadata": {
    "itemsPerPage": 1.1,
    "totalItems": 1.1,
    "currentPage": 1.1,
    "totalPages": 1.1,
    "hasNextPage": true,
    "nextCursor": "string",
    "sortOrder": "ASC",
    "itemsBeyondRetention": true,
    "createdAtLe": "2024-01-15T09:30:00Z",
    "createdAtGe": "2024-01-15T09:30:00Z"
  }
}
```

--------------------------------

### Get Assistant 200 Response

Source: https://docs.vapi.ai/api-reference/assistants/get

Example 200 response body for the Get Assistant endpoint. Shows the structure of an assistant object, including transcriber, model, and tool configurations. The response is truncated in the source at the nested 'items' field.

```json
{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "transcriber": {
    "agentContext": "string",
    "agentContextAutoUpdateEnabled": false,
    "confidenceThreshold": 0.4,
    "disablePartialTranscripts": true,
    "endOfTurnConfidenceThreshold": 0.7,
    "endUtteranceSilenceThreshold": 1.1,
    "fallbackPlan": {
      "transcribers": [
        {
          "agentContext": "string",
          "agentContextAutoUpdateEnabled": false,
          "confidenceThreshold": 0.4,
          "disablePartialTranscripts": true,
          "endOfTurnConfidenceThreshold": 0.7,
          "endUtteranceSilenceThreshold": 1.1,
          "formatTurns": true,
          "keytermsPrompt": [
            "string"
          ],
          "language": "multi",
          "languageCodes": [
            "en"
          ],
          "maxTurnSilence": 400,
          "minEndOfTurnSilenceWhenConfident": 160,
          "mode": "max_accuracy",
          "prompt": "string",
          "provider": "assembly-ai",
          "realtimeUrl": "string",
          "speechModel": "universal-streaming-english",
          "vadAssistedEndpointingEnabled": true,
          "wordBoost": [
            "string"
          ],
          "wordFinalizationMaxWaitTime": 160
        }
      ]
    },
    "formatTurns": true,
    "keytermsPrompt": [
      "string"
    ],
    "language": "multi",
    "languageCodes": [
      "en"
    ],
    "maxTurnSilence": 400,
    "minEndOfTurnSilenceWhenConfident": 160,
    "mode": "max_accuracy",
    "prompt": "string",
    "provider": "assembly-ai",
    "realtimeUrl": "string",
    "speechModel": "universal-streaming-english",
    "vadAssistedEndpointingEnabled": true,
    "wordBoost": [
      "string"
    ],
    "wordFinalizationMaxWaitTime": 160
  },
  "model": {
    "emotionRecognitionEnabled": true,
    "knowledgeBase": {
      "provider": "custom-knowledge-base",
      "server": {
        "backoffPlan": {
          "baseDelaySeconds": 1,
          "excludedStatusCodes": [
            400,
            401,
            403,
            404
          ],
          "maxRetries": 0,
          "type": "fixed"
        },
        "credentialId": "550e8400-e29b-41d4-a716-446655440000",
        "encryptedPaths": [
          "string"
        ],
        "headers": {},
        "staticIpAddressesEnabled": false,
        "timeoutSeconds": 20,
        "url": "string"
      }
    },
    "maxTokens": 5030,
    "messages": [
      {
        "content": "string",
        "role": "assistant"
      }
    ],
    "model": "claude-3-opus-20240229",
    "numFastTurns": 1.1,
    "provider": "anthropic",
    "temperature": 1.1,
    "thinking": {
      "budgetTokens": 50500,
      "type": "enabled"
    },
    "toolIds": [
      "string"
    ],
    "toolRefs": [
      {
        "toolId": "string",
        "version": "string"
      }
    ],
    "tools": [
      {
        "backoffPlan": {
          "baseDelaySeconds": 1,
          "excludedStatusCodes": [
            400,
            401,
            403,
            404
          ],
          "maxRetries": 0,
          "type": "fixed"
        },
        "body": {
          "description": "string",
          "enum": [
            "string"
          ],
          "format": "date-time",
          "items": {
            "description": "string",
            "enum": [
              "string"
            ],
            "format": "date-time",
            "items": {
              "description": "string",
              "enum": [
                "string"
              ],
              "format": "date-time",
              "items": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": {},
                        "enum": {},
                        "format": {},
                        "items": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    ]
  }
}
```

--------------------------------

### POST /eval/simulation/suite

Source: https://docs.vapi.ai/api-reference/simulation-suites/simulation-suite-controller-create

Creates a simulation suite, a group of simulations that run together. Requires authentication with a private Vapi API key.

```APIDOC
## POST /eval/simulation/suite

### Description
Creates a simulation suite, a group of simulations that run together.

### Method
POST

### Endpoint
https://api.vapi.ai/eval/simulation/suite

### Authentication
Authorization: Bearer <token>
Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

### Parameters
#### Request Body
- **name** (string) - Required - The display name of the suite. Maximum 80 characters.
- **simulationIds** (list of strings) - Required - The IDs of the simulations included in the suite.
- **slackWebhookUrl** (string) - Optional - A Slack incoming-webhook URL notified when the suite runs.
- **targetAssignments** (list of objects) - Optional - The assistants or squads the suite's simulations run against. (Show 2 properties)
- **path** (string or null) - Optional - Optional folder path for organizing simulation suites. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure. Format: "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/", maximum 255 characters.

### Request Example
```json
{
  "name": "Checkout Flow Tests",
  "simulationIds": [
    "string"
  ]
}
```

### Response
#### Success Response (201)
- **id** (string) - This is the unique identifier for the simulation suite. Format: "uuid".
- **orgId** (string) - This is the unique identifier for the organization this suite belongs to. Format: "uuid".
- **createdAt** (datetime) - This is the ISO 8601 date-time string of when the suite was created.
- **updatedAt** (datetime) - This is the ISO 8601 date-time string of when the suite was last updated.
- **name** (string) - This is the name of the simulation suite. Maximum 80 characters.
- **simulationIds** (list of strings) - This is the list of simulation IDs in this suite.
- **targetAssignments** (list of objects) - This is the ordered list of assistant or squad assignments for the suite. (Show 2 properties)
- **slackWebhookUrl** (string) - Optional - This is the Slack webhook URL for notifications.
- **path** (string or null) - Optional - Optional folder path for organizing simulation suites. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure. Format: "/^[a-zA-Z0-9][a-zA-Z0-9._-]*(?:\/[a-zA-Z0-9][a-zA-Z0-9._-]*){0,2}$/", maximum 255 characters.

#### Response Example
```json
{
  "id": "string",
  "orgId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "name": "Checkout Flow Tests",
  "simulationIds": [
    "string"
  ],
  "targetAssignments": [
    {
      "targetType": "assistant",
      "targetId": "string"
    }
  ],
  "slackWebhookUrl": "string",
  "path": "string"
}
```
```

--------------------------------

### 201 Created response for create simulation run

Source: https://docs.vapi.ai/api-reference/simulation-runs/simulation-run-controller-create

Example response body returned when the simulation run is successfully created. Contains the run ID, org ID, status 'queued', timestamps, and simulation details.

```json
{
  "id": "string",
  "orgId": "string",
  "status": "queued",
  "queuedAt": "2024-01-15T09:30:00Z",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "simulations": [
    {
      "name": "string",
      "personality": {
        "assistant": {
          "analysisPlan": {
            "minMessagesThreshold": 1.1,
            "outcomeIds": [
              "string"
            ],
            "structuredDataMultiPlan": [
              {
                "key": "string",
                "plan": {
                  "enabled": true,
                  "messages": [
                    {}
                  ],
                  "schema": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": "string",
                        "enum": [
                          "string"
                        ],
                        "format": "date-time",
                        "items": {
                          "description": "string",
                          "enum": [
                            "string"
                          ],
                          "format": "date-time",
                          "items": {
                            "description": {},
                            "enum": {},
                            "format": {},
                            "items": {},
                            "pattern": {},
                            "properties": {},
                            "required": {},
                            "title": {},
                            "type": {}
                          },
                          "pattern": "string",
                          "properties": {},
                          "required": [
                            "string"
                          ],
                          "title": "string",
                          "type": "string"
                        },
                        "pattern": "string",
                        "properties": {},
                        "required": [
                          "string"
                        ],
                        "title": "string",
                        "type": "string"
                      },
                      "pattern": "string",
                      "properties": {},
                      "required": [
                        "string"
                      ],
                      "title": "string",
                      "type": "string"
                    },
                    "pattern": "string",
                    "properties": {},
                    "required": [
                      "string"
                    ],
                    "title": "string",
                    "type": "string"
                  },
                  "timeoutSeconds": 1.1
                }
              }
            ],
            "structuredDataPlan": {
              "enabled": true,
              "messages": [
                {}
              ],
              "schema": {
                "description": "string",
                "enum": [
                  "string"
                ],
                "format": "date-time",
                "items": {
                  "description": "string",
                  "enum": [
                    "string"
                  ],
                  "format": "date-time",
                  "items": {
                    "description": "string",
                    "enum": [
                      "string"
                    ],
                    "format": "date-time",
                    "items": {
                      "description": "string",
                      "enum": [
                        "string"
                      ],
                      "format": "date-time",
                      "items": {
                        "description": "string",
                        "enum": [
                          "string"
                        ],
                        "format": "date-time",
                        "items": {}
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  ]
}
```

--------------------------------

### GET /eval/simulation/concurrency

Source: https://docs.vapi.ai/api-reference/simulations/simulation-controller-get-concurrency

Retrieves the organization's simulation concurrency limit, active simulations, and available slots to start new simulations.

```APIDOC
## GET /eval/simulation/concurrency

### Description
Returns the organization's simulation concurrency limit, the number of active simulations, and how many more can start.

### Method
GET

### Endpoint
https://api.vapi.ai/eval/simulation/concurrency

### Authentication
Authorization: Bearer <token>

Authenticate server-side requests with a private Vapi API key. Create or copy a key from the Vapi Dashboard and send it in the `Authorization` header as `Bearer <token>`. Keep private API keys out of client-side code and public repositories.

### Response
#### Success Response (200)
- **orgId** (string) - Organization ID
- **concurrencyLimit** (double) - Max call slots for simulations (each voice simulation uses 2 call slots: tester + target)
- **activeSimulations** (double) - Number of call slots currently in use by running simulations
- **availableToStart** (double) - Number of voice simulations that can start now (available call slots / 2)
- **createdAt** (datetime or null) - Creation timestamp
- **updatedAt** (datetime or null) - Last update timestamp
- **isDefault** (boolean) - True if org is using platform default concurrency limit

#### Response Example
```json
{
  "orgId": "string",
  "concurrencyLimit": 1.1,
  "activeSimulations": 1.1,
  "availableToStart": 1.1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "isDefault": true
}
```
```

--------------------------------

### 200 Response for Get Tool

Source: https://docs.vapi.ai/api-reference/tools/get

Example 200 response body for a successful GET /tool/:id request. Shows the structure of a tool object, including type, timestamps, method, URL, backoff plan, body schema, credential ID, and headers.

```json
{
  "type": "apiRequest",
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "method": "POST",
  "orgId": "string",
  "updatedAt": "2024-01-15T09:30:00Z",
  "url": "string",
  "backoffPlan": {
    "type": "fixed",
    "maxRetries": 0,
    "baseDelaySeconds": 1,
    "excludedStatusCodes": [
      400,
      401,
      403,
      404
    ]
  },
  "body": {
    "type": "string",
    "items": {
      "type": "string",
      "items": {
        "type": "string",
        "items": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": {},
                        "items": {},
                        "properties": {},
                        "description": {},
                        "pattern": {},
                        "format": {},
                        "required": {},
                        "enum": {},
                        "title": {}
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "properties": {},
        "description": "string",
        "pattern": "string",
        "format": "date-time",
        "required": [
          "string"
        ],
        "enum": [
          "string"
        ],
        "title": "string"
      },
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    },
    "properties": {},
    "description": "string",
    "pattern": "string",
    "format": "date-time",
    "required": [
      "string"
    ],
    "enum": [
      "string"
    ],
    "title": "string"
  },
  "credentialId": "550e8400-e29b-41d4-a716-446655440000",
  "description": "string",
  "encryptedPaths": [
    "string"
  ],
  "headers": {
    "type": "string",
    "items": {
      "type": "string",
      "items": {
        "type": "string",
        "items": {
          "type": "string",
          "items": {
            "type": "string",
            "items": {
              "type": "string",
              "items": {
                "type": "string",
                "items": {
                  "type": "string",
                  "items": {
                    "type": "string",
                    "items": {
                      "type": "string",
                      "items": {
                        "type": {},
                        "items": {},
                        "properties": {},
                        "description": {},
                        "pattern": {},
                        "format": {},
                        "required": {},
                        "enum": {},
                        "title": {}
                      },
                      "properties": {},
                      "description": "string",
                      "pattern": "string",
                      "format": "date-time",
                      "required": [
                        "string"
                      ],
                      "enum": [
                        "string"
                      ],
                      "title": "string"
                    },
                    "properties": {},
                    "description": "string",
                    "pattern": "string",
                    "format": "date-time",
                    "required": [
                      "string"
                    ],
                    "enum": [
                      "string"
                    ],
                    "title": "string"
                  },
                  "properties": {},
                  "description": "string",
                  "pattern": "string",
                  "format": "date-time",
                  "required": [
                    "string"
                  ],
                  "enum": [
                    "string"
                  ],
                  "title": "string"
                },
                "properties": {},
                "description": "string",
                "pattern": "string",
                "format": "date-time",
                "required": [
                  "string"
                ],
                "enum": [
                  "string"
                ],
                "title": "string"
              },
              "properties": {},
              "description": "string",
              "pattern": "string",
              "format": "date-time",
              "required": [
                "string"
              ],
              "enum": [
                "string"
              ],
              "title": "string"
            },
            "properties": {},
            "description": "string",
            "pattern": "string",
            "format": "date-time",
            "required": [
              "string"
            ],
            "enum": [
              "string"
            ],
            "title": "string"
          },
          "properties": {},
          "description": "string",
          "pattern": "string",
          "format": "date-time",
          "required": [
            "string"
          ],
          "enum": [
            "string"
          ],
          "title": "string"
        },
        "properties": {},
        "description": "string",
        "pattern": "string",
        "format": "date-time",
        "required": [
          "string"
        ],
        "enum": [
          "string"
        ],
        "title": "string"
      },
      "properties": {},
      "description": "string",
      "pattern": "string",
      "format": "date-time",
      "required": [
        "string"
      ],
      "enum": [
        "string"
      ],
      "title": "string"
    },
    "properties": {},
    "description": "string",
    "pattern": "string",
    "format": "date-time",
    "required": [
      "string"
    ],
    "enum": [
      "string"
    ],
    "title": "string"
  }
}
```

--------------------------------

### POST /assistant

Source: https://docs.vapi.ai/api-reference/assistants/create

Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.

```APIDOC
## POST /assistant

### Description
Creates a reusable assistant configuration containing the model, voice, transcriber, tools, prompts, and call behavior.

### Method
POST

### Endpoint
/assistant

### Authentication
Authorization: Bearer <token>

### Parameters
#### Request Body
- **transcriber** (object) - Optional - These are the options for the assistant's transcriber.
- **model** (object) - Optional - These are the options for the assistant's LLM.
- **voice** (object) - Optional - These are the options for the assistant's voice.
- **firstMessage** (string) - Optional - This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.). If unspecified, assistant will wait for user to speak and use the model to respond once they speak.
- **firstMessageInterruptionsEnabled** (boolean) - Optional - Defaults to `false`. Set to `true` to allow the user to interrupt the assistant while it speaks the first message.
- **firstMessageMode** (enum) - Optional - This is the mode for the first message. Default is 'assistant-speaks-first'. Use 'assistant-speaks-first' to have the assistant speak first, 'assistant-waits-for-user' to have the assistant wait for the user to speak first, or 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state.

### Request Example
{
  "transcriber": {},
  "model": {},
  "voice": {},
  "firstMessage": "string",
  "firstMessageInterruptionsEnabled": true,
  "firstMessageMode": "assistant-speaks-first"
}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the created assistant.
- **orgId** (string) - The organization ID that owns the assistant.
- **name** (string) - The name of the assistant.
- **model** (object) - The model configuration.
- **voice** (object) - The voice configuration.
- **transcriber** (object) - The transcriber configuration.
- **firstMessage** (string) - The first message.
- **firstMessageInterruptionsEnabled** (boolean) - Whether interruptions are enabled.
- **firstMessageMode** (string) - The mode for the first message.
- **createdAt** (string) - The creation timestamp.
- **updatedAt** (string) - The last update timestamp.

#### Response Example
{
  "id": "string",
  "orgId": "string",
  "name": "string",
  "model": {},
  "voice": {},
  "transcriber": {},
  "firstMessage": "string",
  "firstMessageInterruptionsEnabled": true,
  "firstMessageMode": "assistant-speaks-first",
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-01T00:00:00Z"
}
```
Tokens:
Raw