Get a single evaluation by ID
Retrieves detailed information about a specific evaluation.
curl --request GET \
--url https://api.avidoai.com/v0/evals/{id} \
--header 'x-api-key: <api-key>'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orgId": "org_123456",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"status": "COMPLETED",
"evalRunId": "456e4567-e89b-12d3-a456-426614174000",
"evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
"results": {
"score": 0.9,
"message": "Evaluation passed with a high score."
}
}Authorizations
Your unique Avido API key
Path Parameters
The unique identifier of the evaluation
"123e4567-e89b-12d3-a456-426614174000"
Response
Successful response containing the evaluation data
Complete evaluation information
Unique identifier of the evaluation
"123e4567-e89b-12d3-a456-426614174000"
Organization ID that owns this evaluation
"org_123456"
When the evaluation was created
"2024-01-05T12:34:56.789Z"
When the evaluation was last modified
"2024-01-05T12:34:56.789Z"
Status of the evaluation/test. Valid options: PENDING, IN_PROGRESS, PASSED, COMPLETED, FAILED.
PENDING, IN_PROGRESS, PASSED, COMPLETED, FAILED "COMPLETED"
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"
Results of the evaluation (structure depends on eval type).
curl --request GET \
--url https://api.avidoai.com/v0/evals/{id} \
--header 'x-api-key: <api-key>'{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orgId": "org_123456",
"createdAt": "2024-01-05T12:34:56.789Z",
"modifiedAt": "2024-01-05T12:34:56.789Z",
"status": "COMPLETED",
"evalRunId": "456e4567-e89b-12d3-a456-426614174000",
"evalDefinitionId": "789e4567-e89b-12d3-a456-426614174000",
"results": {
"score": 0.9,
"message": "Evaluation passed with a high score."
}
}