Skip to main content
GET
/
v0
/
definitions
JavaScript
import Avido from 'avido';

const client = new Avido({
  apiKey: process.env['AVIDO_API_KEY'], // This is the default and can be omitted
  applicationID: process.env['AVIDO_APPLICATION_ID'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const evalDefinition of client.definitions.list()) {
  console.log(evalDefinition.id);
}
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "type": "NATURALNESS",
      "name": "<string>",
      "globalConfig": {
        "criterion": "<string>"
      },
      "styleGuideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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...",
        "language": "en",
        "type": "CHATBOT",
        "environment": "DEV",
        "createdAt": "2024-01-05T12:34:56.789Z",
        "modifiedAt": "2024-01-05T12:34:56.789Z"
      }
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4,
    "totalCount": 100
  }
}

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
string
default:createdAt

Field to order by in the result set.

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"

​
status
enum<string>

Filter by evaluation status (e.g. COMPLETED)

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

"COMPLETED"

​
type
string

Filter by evaluation type (e.g. NATURALNESS)

Example:

"NATURALNESS"

Response

Successfully retrieved evaluation definitions

Paginated response containing eval definitions

​
data
object[]
required
​
pagination
PaginationResponse · object
required

Pagination metadata returned in a paginated response.