Get a single run by ID
Retrieves detailed information about a specific run.
curl --request GET \
--url https://api.avidoai.com/v0/runs/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <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",
"taskId": "456e4567-e89b-12d3-a456-426614174000",
"threadId": null,
"result": "PASSED",
"status": "COMPLETED",
"evals": []
}Authorizations
Your unique Avido API key
Your unique application ID. Get this from the Connections page in Avido.
Path Parameters
The unique identifier of the run
"123e4567-e89b-12d3-a456-426614174000"
Response
Successful response containing the run data
A Run represents a batch of tests triggered by a single task
Unique identifier of the run
"123e4567-e89b-12d3-a456-426614174000"
When the run was created
"2024-01-05T12:34:56.789Z"
When the run 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"
A Test represents a single test applying all the linked evals on a Trace
Unique identifier of the run
"123e4567-e89b-12d3-a456-426614174000"
When the run was created
"2024-01-05T12:34:56.789Z"
When the run 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"
Array of evaluations in this run
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: GEVAL, STYLE, BLACKLIST.
GEVAL, STYLE, BLACKLIST "GEVAL"
Results of the evaluation (structure depends on eval type).
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"
The baseline score of the task
0.5
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: GEVAL, STYLE, BLACKLIST.
GEVAL, STYLE, BLACKLIST "GEVAL"
Optional ID of the trace this run is associated with
"789e4567-e89b-12d3-a456-426614174000"
Result of the run (if completed)
PASSED, FAILED "PASSED"
Result of the run (if completed)
PASSED, FAILED "PASSED"
curl --request GET \
--url https://api.avidoai.com/v0/runs/{id} \
--header 'x-api-key: <api-key>' \
--header 'x-application-id: <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",
"taskId": "456e4567-e89b-12d3-a456-426614174000",
"threadId": null,
"result": "PASSED",
"status": "COMPLETED",
"evals": []
}