Get a single task by ID
Retrieves detailed information about a specific task.
curl --request GET \
--url https://api.avidoai.com/v0/tasks/{id} \
--header 'x-api-key: <api-key>'
{
"task": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-01T00:00:00.000Z",
"modifiedAt": "2024-01-01T00:00:00.000Z",
"title": "Credit Card Block",
"description": "Wants to block their credit card",
"baseline": 0.5,
"application": {
"id": "app_123",
"title": "Support Bot",
"slug": "support-bot",
"description": "",
"context": "",
"type": "CHATBOT",
"environment": "DEV",
"createdAt": "2024-01-01T00:00:00.000Z",
"modifiedAt": "2024-01-01T00:00:00.000Z",
"monitoringEnabled": true
},
"topic": {
"id": "topic_abc",
"title": "Banking Issues",
"baseline": null,
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z"
}
}
}
Authorizations
Your unique Avido API key
Path Parameters
The unique identifier of the task
"123e4567-e89b-12d3-a456-426614174000"
Response
Successful response containing the task data
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
curl --request GET \
--url https://api.avidoai.com/v0/tasks/{id} \
--header 'x-api-key: <api-key>'
{
"task": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2024-01-01T00:00:00.000Z",
"modifiedAt": "2024-01-01T00:00:00.000Z",
"title": "Credit Card Block",
"description": "Wants to block their credit card",
"baseline": 0.5,
"application": {
"id": "app_123",
"title": "Support Bot",
"slug": "support-bot",
"description": "",
"context": "",
"type": "CHATBOT",
"environment": "DEV",
"createdAt": "2024-01-01T00:00:00.000Z",
"modifiedAt": "2024-01-01T00:00:00.000Z",
"monitoringEnabled": true
},
"topic": {
"id": "topic_abc",
"title": "Banking Issues",
"baseline": null,
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z"
}
}
}