Skip to main content
GET
JavaScript

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: 0 <= x <= 9007199254740991
Example:

0

limit
integer

Number of items to include in the result set.

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

25

orderBy
enum<string>
default:createdAt

Field to order the result set by.

Available options:
createdAt,
modifiedAt,
name,
type,
id
Example:

"createdAt"

orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

taskId
string<uuid>

Filter by task ID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

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

traceId
string

Filter by trace ID

Example:

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

quickstartId
string<uuid>

Filter by quickstart ID (for quickstart-scoped evals)

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

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

definitionStatus
enum<string>

Filter by eval definition status (DRAFT or ACTIVE). Defaults to ACTIVE when not provided.

Available options:
DRAFT,
ACTIVE
Example:

"DRAFT"

status
enum<string>

Filter by evaluation status (e.g. COMPLETED)

Available options:
PENDING,
IN_PROGRESS,
COMPLETED,
FAILED,
SKIPPED
Example:

"COMPLETED"

type
string

Filter by evaluation type (e.g. NATURALNESS)

Example:

"NATURALNESS"

scopeType
enum<string>

Filter by eval definition scope (topic-scoped or application-wide). Ignored if 'topicId' is specified.

Available options:
topic,
application
Example:

"topic"

topicId
string<uuid>

Filter by specific topic ID. When provided, 'scopeType' parameter is ignored as this inherently filters topic-scoped evals.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

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

Response

Successfully retrieved evaluation definitions

Paginated response containing eval definitions

data
object[]
required
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.