Get a single test by ID

curl --request GET \
  --url https://api.avidoai.com/v0/tests/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "test": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "applicationId": "<string>",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "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": {},
        "definition": {
          "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"
          }
        },
        "score": 0.9,
        "passed": true
      }
    ],
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "runId": "123e4567-e89b-12d3-a456-426614174000",
    "traceId": "789e4567-e89b-12d3-a456-426614174000",
    "result": {
      "passed": 1,
      "failed": 1,
      "total": 1,
      "passRate": 50,
      "averageScore": 0.5
    }
  }
}

GET

tests

{id}

Get a single test by ID

curl --request GET \
  --url https://api.avidoai.com/v0/tests/{id} \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'

{
  "test": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "applicationId": "<string>",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "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": {},
        "definition": {
          "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"
          }
        },
        "score": 0.9,
        "passed": true
      }
    ],
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "runId": "123e4567-e89b-12d3-a456-426614174000",
    "traceId": "789e4567-e89b-12d3-a456-426614174000",
    "result": {
      "passed": 1,
      "failed": 1,
      "total": 1,
      "passRate": 50,
      "averageScore": 0.5
    }
  }
}

Authorizations

x-api-key

string

header

required

Your unique Avido API key

x-application-id

string

header

required

Your unique Avido Application ID

Path Parameters

string<uuid>

required

The unique identifier of the test

Example:

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

Response

Successfully retrieved test

test

Test · object

required

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

Show child attributes

test.id

string<uuid>

required

Unique identifier of the run

Example:

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

test.applicationId

string

required

The ID of the application this test belongs to

test.createdAt

string<date-time>

required

When the test was created

Example:

"2024-01-05T12:34:56.789Z"

test.modifiedAt

string<date-time>

required

When the test was last modified

Example:

"2024-01-05T12:34:56.789Z"

test.status

enum<string>

required

Status of the evaluation/test

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED

Example:

"COMPLETED"

test.evals

Eval · object[]

required

Array of evaluations in this run

Show child attributes

test.evals.id

string<uuid>

required

Unique identifier of the evaluation

Example:

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

test.evals.orgId

string

required

Organization ID that owns this evaluation

Example:

"org_123456"

test.evals.createdAt

string<date-time>

required

When the evaluation was created

Example:

"2024-01-05T12:34:56.789Z"

test.evals.modifiedAt

string<date-time>

required

When the evaluation was last modified

Example:

"2024-01-05T12:34:56.789Z"

test.evals.status

enum<string>

required

Status of the evaluation/test

Available options:

PENDING,

IN_PROGRESS,

COMPLETED,

FAILED

Example:

"COMPLETED"

test.evals.results

object

required

Results of the evaluation (structure depends on eval type).

Show child attributes

test.evals.results.{key}

any

test.evals.definition

object

required

Show child attributes

test.evals.definition.id

string<uuid>

required

test.evals.definition.createdAt

string<date-time>

required

When the eval definition was created

Example:

"2024-01-05T12:34:56.789Z"

test.evals.definition.modifiedAt

string<date-time>

required

When the eval definition was last modified

Example:

"2024-01-05T12:34:56.789Z"

test.evals.definition.type

enum<string>

required

The type of evaluation

Available options:

NATURALNESS,

STYLE,

RECALL,

CUSTOM,

FACT,

OUTPUT_MATCH

Example:

"NATURALNESS"

test.evals.definition.name

string

required

test.evals.definition.globalConfig

object

Option 1
Option 2
Option 3
Option 4

Show child attributes

test.evals.definition.globalConfig.criterion

string

required

The criterion describes what our evaluation LLM must look for in the response. Remember that the answer to the criterion must be as a pass/fail.

Minimum string length: 1

test.evals.definition.styleGuideId

string<uuid> | null

test.evals.definition.application

Application · object

Application configuration and metadata

Show child attributes

test.evals.definition.application.id

string<uuid>

required

Unique identifier of the application

Example:

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

test.evals.definition.application.orgId

string

required

Organization ID that owns this application

Example:

"org_123456"

test.evals.definition.application.title

string

required

Title of the application

Minimum string length: 1

Example:

"Customer Support Bot"

test.evals.definition.application.slug

string

required

URL-friendly slug for the application

Minimum string length: 1

Example:

"customer-support-bot"

test.evals.definition.application.description

string

required

Description of the application

Example:

"AI assistant for customer support inquiries"

test.evals.definition.application.context

string

required

Context/instructions for the application

Example:

"You are a helpful customer support assistant..."

test.evals.definition.application.language

string

required

Language of the application

Example:

"en"

test.evals.definition.application.type

enum<string>

required

Type of the application. Valid values are CHATBOT or AGENT.

Available options:

CHATBOT,

AGENT

Example:

"CHATBOT"

test.evals.definition.application.environment

enum<string>

default:DEV

required

Environment of the application. Defaults to DEV.

Available options:

DEV,

PROD

Example:

"DEV"

test.evals.definition.application.createdAt

string<date-time>

required

When the application was created

Example:

"2024-01-05T12:34:56.789Z"

test.evals.definition.application.modifiedAt

string<date-time>

required

When the application was last modified

Example:

"2024-01-05T12:34:56.789Z"

test.evals.score

number

required

Overall score of the evaluation

Example:

0.9

test.evals.passed

boolean

required

Whether the evaluation passed

Example:

true

test.taskId

string<uuid>

required

The unique identifier of the task

Example:

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

test.runId

string<uuid>

required

The unique identifier of the run

Example:

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

test.traceId

string

Optional ID of the trace this run is associated with

Example:

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

test.result

object

Aggregated test result with pass/fail statistics

Show child attributes

test.result.passed

integer

required

Required range: x >= 0

test.result.failed

integer

required

Required range: x >= 0

test.result.total

integer

required

Required range: x >= 0

test.result.passRate

number

required

Required range: 0 <= x <= 100

test.result.averageScore

number

required

Required range: 0 <= x <= 1

List tests List topics

⌘I

Webhook

Applications

Threads

Ingestion

Tasks

Task Schedules

Eval Definitions

Experiments

Inference Steps

Evals

Tests

Topics

Annotations

Issues

Runs

Style Guides

Documents

Document Chunks

Document Versions

Tags

Document Tags

Task Tags

Scrape Jobs

Quickstarts

Get a single test by ID

Authorizations

Path Parameters

Response