List tasks
Retrieves a paginated list of tasks with optional filtering.
curl --request GET \
--url https://api.avidoai.com/v0/tasks \
--header 'x-api-key: <api-key>'
{
"data": [],
"pagination": {
"skip": 0,
"limit": 25,
"total": 0,
"totalPages": 0
}
}
Authorizations
Your unique Avido API key
Query Parameters
Number of items to skip
x >= 0
0
Number of items per page
1 <= x <= 100
25
Field to order by
"createdAt"
Order direction
asc
, desc
"desc"
Response
Paginated response containing tasks
A task that represents a specific job-to-be-done by the LLM in the user application.
The unique identifier of the task
"123e4567-e89b-12d3-a456-426614174000"
The date and time the task was created
"2024-01-01T00:00:00.000Z"
The date and time the task was last updated
"2024-01-01T00:00:00.000Z"
The title of the task
"Credit Card Block"
The task description
"Wants to block their credit card"
Application configuration and metadata
Unique identifier of the application
"123e4567-e89b-12d3-a456-426614174000"
Organization ID that owns this application
"org_123456"
Title of the application
1
"Customer Support Bot"
URL-friendly slug for the application
1
"customer-support-bot"
Description of the application
"AI assistant for customer support inquiries"
Context/instructions for the application
"You are a helpful customer support assistant..."
Type of the application. Valid values are CHATBOT or AGENT.
CHATBOT
, AGENT
"CHATBOT"
Environment of the application. Defaults to DEV.
DEV
, PROD
"DEV"
When the application was created
"2024-01-05T12:34:56.789Z"
When the application was last modified
"2024-01-05T12:34:56.789Z"
Details about a single Topic
Unique identifier of the topic
"789e4567-e89b-12d3-a456-426614174000"
Organization ID that owns this topic
"org_123456"
Title of the topic
"Code Quality"
Optional baseline score for this topic
0.85
When the topic was created
"2024-01-05T12:34:56.789Z"
When the topic was last modified
"2024-01-05T12:34:56.789Z"
Type of evaluation. Valid options: NATURALNESS, STYLE, RECALL, LLMQA.
NATURALNESS
, STYLE
, RECALL
, LLMQA
, BLACKLIST
"NATURALNESS"
Application configuration and metadata
Unique identifier of the application
"123e4567-e89b-12d3-a456-426614174000"
Organization ID that owns this application
"org_123456"
Title of the application
1
"Customer Support Bot"
URL-friendly slug for the application
1
"customer-support-bot"
Description of the application
"AI assistant for customer support inquiries"
Context/instructions for the application
"You are a helpful customer support assistant..."
Type of the application. Valid values are CHATBOT or AGENT.
CHATBOT
, AGENT
"CHATBOT"
Environment of the application. Defaults to DEV.
DEV
, PROD
"DEV"
When the application was created
"2024-01-05T12:34:56.789Z"
When the application was last modified
"2024-01-05T12:34:56.789Z"
The 30 day pass rate for the task measured in percentage
66
The date and time this task was last tested
"2024-01-01T00:00:00.000Z"
Example inputs for the task
Pagination metadata returned in a paginated response.
Number of items skipped.
x >= 0
0
Number of items per page.
x >= 1
25
Total number of items available.
x >= 0
100
Total number of pages available.
x >= 0
4
curl --request GET \
--url https://api.avidoai.com/v0/tasks \
--header 'x-api-key: <api-key>'
{
"data": [],
"pagination": {
"skip": 0,
"limit": 25,
"total": 0,
"totalPages": 0
}
}