For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Search
/
Ask AI
Website
Status
Support
Dashboard
Documentation
API Reference
MCP
SDKs
CLI (new)
What's New?
Observability Scorecard
List Scorecards
Copy page
GET
https://api.vapi.ai
/
observability
/
scorecard
Documentation
API Reference
MCP
SDKs
CLI (new)
What's New?
Assistants
GET
List Assistants
POST
Create Assistant
GET
Get Assistant
DEL
Delete Assistant
PATCH
Update Assistant
Squads
GET
List Squads
POST
Create Squad
GET
Get Squad
DEL
Delete Squad
PATCH
Update Squad
Calls
GET
List Calls
POST
Create Call
GET
Get Call
DEL
Delete Call
PATCH
Update Call
Chats
GET
List Chats
POST
Create Chat
GET
Get Chat
DEL
Delete Chat
POST
Create Chat (OpenAI Compatible)
Campaigns
GET
List Campaigns
POST
Create Campaign
GET
Get Campaign
DEL
Delete Campaign
PATCH
Update Campaign
Sessions
GET
List Sessions
POST
Create Session
GET
Get Session
DEL
Delete Session
PATCH
Update Session
Phone Numbers
GET
List Phone Numbers
POST
Create Phone Number
GET
List Phone Numbers
GET
Get Phone Number
DEL
Delete Phone Number
PATCH
Update Phone Number
Tools
GET
List Tools
POST
Create Tool
GET
Get Tool
DEL
Delete Tool
PATCH
Update Tool
Files
GET
List Files
POST
Upload File
GET
Get File
DEL
Delete File
PATCH
Update File
Structured Outputs
GET
List Structured Outputs
POST
Create Structured Output
GET
Get Structured Output
DEL
Delete Structured Output
PATCH
Update Structured Output
POST
Run Structured Output
Insight
GET
Get Insights
POST
Create Insight
GET
Get Insight
DEL
Delete Insight
PATCH
Update Insight
POST
Run Insight
POST
Preview Insight
Eval
GET
List Evals
POST
Create Eval
GET
Get Eval
DEL
Delete Eval
PATCH
Update Eval
GET
Get Eval Run
DEL
Delete Eval Run
GET
List Eval Runs
POST
Create Eval Run
Observability Scorecard
GET
Get Scorecard
DEL
Delete Scorecard
PATCH
Update Scorecard
GET
List Scorecards
POST
Create Scorecard
Provider Resources
GET
List Provider Resources
POST
Create Provider Resource
GET
Get Provider Resource
DEL
Delete Provider Resource
PATCH
Update Provider Resource
Analytics
POST
Create Analytics Queries
Webhooks
POST
Server Message
POST
Client Message
Swagger
OpenAPI
Website
Status
Support
Dashboard
Authentication
Authorization
Bearer
Retrieve your API Key from
Dashboard
.
Query parameters
id
string
Optional
page
double
Optional
>=1
This is the page number to return. Defaults to 1.
sortOrder
enum
Optional
This is the sort order for pagination. Defaults to 'DESC'.
Allowed values:
ASC
DESC
limit
double
Optional
0-1000
This is the maximum number of items to return. Defaults to 100.
createdAtGt
datetime
Optional
This will return items where the createdAt is greater than the specified value.
createdAtLt
datetime
Optional
This will return items where the createdAt is less than the specified value.
createdAtGe
datetime
Optional
This will return items where the createdAt is greater than or equal to the specified value.
createdAtLe
datetime
Optional
This will return items where the createdAt is less than or equal to the specified value.
updatedAtGt
datetime
Optional
This will return items where the updatedAt is greater than the specified value.
updatedAtLt
datetime
Optional
This will return items where the updatedAt is less than the specified value.
updatedAtGe
datetime
Optional
This will return items where the updatedAt is greater than or equal to the specified value.
updatedAtLe
datetime
Optional
This will return items where the updatedAt is less than or equal to the specified value.
Response
results
list of objects
Show 8 properties
metadata
object
Show 6 properties