Webhook
Assistant
Authentication
App Config
Applications
Feedback
Traces
Tasks
Eval Definitions
- POSTLink an evaluation definition to a task
- POSTUnlink an evaluation definition from a task
- PUTUpdate task-specific config for an evaluation definition
- POSTLink evaluation definitions to topics
- POSTUnlink evaluation definitions from topics
- POSTLink evaluation definitions to the application
- POSTUnlink evaluation definitions from the application
- GETGet application-level evaluation definitions
- GETList evaluation definitions
- POSTCreate an evaluation definition
- PUTUpdate an evaluation definition
- DELDelete an evaluation definition
Experiments
Facts
Inference Steps
Evals
Topics
Annotations
Issues
Assignments
Contradictions
Style Guides
Documents
- GETList documents
- POSTCreate a new document
- GETGet document counts
- GETGet document counts by assignee
- POSTDelete multiple documents
- POSTBulk export documents as CSV
- GETGet all document IDs
- POSTBulk optimize multiple documents
- POSTBulk update status of multiple document versions
- POSTBulk activate latest versions of multiple documents
- GETGet a single document by ID
- PUTUpdate a document's topic
- DELDelete a document
- PUTAssign a document to a user
- POSTOptimize a document
- PUTUpdate a document version
- POSTUpload documents via CSV or PDF file
- POSTAdd tags to multiple documents
Document Chunks
Document Versions
Document Tests
Tags
Document Tags
Scrape Jobs
Quickstarts
QuickstartsV2
- GETList quickstarts
- POSTCreate a quickstart
- GETGet a quickstart
- PUTUpdate a quickstart
- GETList topics for a quickstart
- GETList tasks for a quickstart topic
- GETList topics for a quickstart with document statistics
- GETList documents for a quickstart topic
- GETGet KB material counts for a quickstart
- GETGet policy eval counts for a quickstart
FileProcessings
File Processings
Reports
- GETList reports
- POSTCreate a new report
- GETGet a single report
- PUTUpdate a report
- DELDelete a report
- GETGet eval stats aggregated by date
- GETGet eval stats aggregated by date and eval definition
- GETGet eval stats aggregated by date and topic
- GETGet eval stats aggregated by eval definition
- POSTQuery reporting data
- GETList available datasources
- GETGet columns for a datasource
- POSTGet context-aware columns for a datasource
- GETGet distinct values for a column
Model Pricing
Organization Config
Organization Members
Get install setup status
curl --request GET \
--url https://api.avidoai.com/v0/setup/status{
"needsOnboarding": true
}Setup
Get install setup status
Returns whether the install needs onboarding. An install needs onboarding when no organizations exist in the database; the dashboard uses this to show a sign-up-first bootstrap flow on fresh deployments. This endpoint is unauthenticated so the login UI can call it before the user has a session.
GET
/
v0
/
setup
/
status
Get install setup status
curl --request GET \
--url https://api.avidoai.com/v0/setup/status{
"needsOnboarding": true
}Response
Setup status retrieved successfully
Response body for the setup-status endpoint. Changes from true to false exactly once, when the first organization is created.
True when the install has no organizations yet and should present the onboarding flow instead of the login screen.
Example:
false
⌘I