GET
/
v0
/
evals
curl --request GET \
  --url https://api.avidoai.com/v0/evals \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "eval_1",
      "orgId": "org_123456",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "status": "PENDING",
      "runId": "run_1",
      "definitionId": "def_1",
      "results": null
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 1,
    "totalPages": 1
  }
}

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 evaluations

​
data
object[]
required

Complete evaluation information

​
pagination
object
required

Pagination metadata returned in a paginated response.

Run a taskGet a single evaluation by ID