GET
/
v0
/
tests
curl --request GET \
  --url https://api.avidoai.com/v0/tests \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "traceId": "789e4567-e89b-12d3-a456-426614174000",
      "result": "PASSED",
      "status": "COMPLETED",
      "evals": [
        {
          "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",
          "results": "<any>",
          "definition": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "<string>",
            "modifiedAt": "<string>",
            "type": "GEVAL",
            "name": "<string>",
            "globalConfig": "<any>",
            "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        }
      ],
      "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": "123e4567-e89b-12d3-a456-426614174000",
          "orgId": "org_123456",
          "title": "Customer Support Bot",
          "slug": "customer-support-bot",
          "description": "AI assistant for customer support inquiries",
          "context": "You are a helpful customer support assistant...",
          "type": "CHATBOT",
          "environment": "DEV",
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z"
        },
        "topic": {
          "id": "789e4567-e89b-12d3-a456-426614174000",
          "orgId": "org_123456",
          "title": "Code Quality",
          "baseline": 0.85,
          "createdAt": "2024-01-05T12:34:56.789Z",
          "modifiedAt": "2024-01-05T12:34:56.789Z"
        },
        "definitions": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "<string>",
            "modifiedAt": "<string>",
            "type": "GEVAL",
            "name": "<string>",
            "globalConfig": "<any>",
            "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique application ID. Get this from the Connections page in Avido.

Query Parameters

​
skip
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
limit
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
Example:

25

​
orderBy
string

Field to order by

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction

Available options:
asc,
desc
Example:

"desc"

​
taskId
string

Filter by task ID

Example:

"456e4567-e89b-12d3-a456-426614174000"

​
traceId
string

Filter by trace ID

Example:

"789e4567-e89b-12d3-a456-426614174000"

​
status
string

Filter by evaluation status

Example:

"COMPLETED"

​
type
string

Filter by evaluation type

Example:

"GEVAL"

Response

200
application/json
Successfully retrieved evaluations

Paginated response containing tests

​
data
object[]
required

A Test represents a single test applying all the linked evals on a Trace

​
pagination
object
required

Pagination metadata returned in a paginated response.

Get a single evaluation by IDGet a single test by ID