API Reference

Evaluation

GET /v1/evaluations

Get Evaluations

Query Parameters:

  • user_email ({'null', 'string'})

  • status ({'array', 'null'})

  • limit (integer)

  • offset (integer)

  • sort_by (string)

  • sort_order (string)

  • name ({'null', 'string'})

  • hub ({'null', 'string'})

  • model ({'null', 'string'})

  • created_at ({'integer', 'null'})

  • completed_at ({'integer', 'null'})

Status Codes:
POST /v1/evaluations

Create Evaluation

Status Codes:
GET /v1/evaluations/{evaluation_id}/response-errors

Get Response Errors

Parameters:

  • evaluation_id (string)

Query Parameters:

  • limit (integer) – Maximum number of error types to return

Status Codes:
GET /v1/evaluations/{id}

Get Evaluation

Parameters:

  • id (string)

Status Codes:
PUT /v1/evaluations/{id}

Update Evaluation Name

Parameters:

  • id (string)

Status Codes:
GET /v1/evaluations/metadata/{id}

Get Evaluation With Metadata

Parameters:

  • id (string)

Status Codes:
POST /v1/evaluations/{id}/score

Calculate Evaluation Score

Parameters:

  • id (string)

Status Codes:
POST /v1/evaluations/{id}/delete

Delete Evaluation

Parameters:

  • id (string)

Status Codes:
POST /v1/evaluations/{id}/cancel

Cancel Evaluation

Parameters:

  • id (string)

Status Codes:
POST /v1/evaluation-estimate

Calculate Evaluation Estimate

Status Codes:

Harness

GET /v1/harness

Get Harnesses

Query Parameters:

  • evaluation_id (string) – (Required)

  • ids ({'array', 'null'})

Status Codes:
GET /v1/harness/{id}

Get Harness By Id

Parameters:

  • id (string)

Status Codes:
POST /v1/harness/create

Config File To Db Sync

Status Codes:
GET /v1/harness-configs/versions

Get Harness Config Versions

Status Codes:

  • 200 OK – Successful Response

GET /v1/harness-configs

Get Harness Configs

Query Parameters:

  • harness_type ({'array', 'null'})

Status Codes:
PUT /v1/harness-configs

Create Harness Config

Triggers harness creation after harness input files have been uploaded using signed URLs. Delegates the actual creation process to the harness creation service.

Status Codes:
PUT /v1/harness-configs/files

Create File Upload

Creates a signed URL for a file upload and an entry in the database.

Status Codes:

Scenario

GET /v1/scenarios

Get Scenarios

Query Parameters:

  • evaluation_id (string) – (Required)

  • ids ({'array', 'null'})

Status Codes:
GET /v1/scenarios/{id}

Get Scenario By Id

Parameters:

  • id (string)

Status Codes:

Probe

GET /v1/probes

Get Probes

Query Parameters:

  • evaluation_id (string) – (Required)

  • ids ({'array', 'null'})

Status Codes:
GET /v1/probes/{id}

Get Probe By Id

Parameters:

  • id (string)

Status Codes:

Prompt

GET /v1/prompts/{id}

Get Prompt By Id

Parameters:

  • id (string)

Status Codes:

Response

GET /v1/responses/{id}

Get Response By Id

Parameters:

  • id (string)

Status Codes:
GET /v1/responses

Get Responses

Query Parameters:

  • evaluation_id ({'null', 'string'})

  • status ({'array', 'null'})

  • ids ({'array', 'null'})

  • probe_ids ({'array', 'null'})

  • prompt_ids ({'array', 'null'})

  • is_visible ({'null', 'string'})

  • order_by ({'null', 'string'})

  • limit (integer) – The maximum number of items to return

  • offset (integer) – The number of items to skip before starting to collect the result set

Status Codes:

Detector

GET /v1/detectors

Get Detectors

Query Parameters:

  • version ({'null', 'string'}) – (Required)

  • ids (array)

Status Codes:
GET /v1/detectors/{id}

Get Detector By Id

Parameters:

  • id (string)

Query Parameters:

  • version ({'null', 'string'}) – (Required)

Status Codes:
GET /v1/detections/{id}

Get Detection By Id

Parameters:

  • id (string)

Status Codes:
POST /v1/detections

Create Detection

Status Codes:

API Key

POST /v1/api-keys

Create Api Key

Status Codes:
GET /v1/api-keys

Get Api Keys

Query Parameters:

  • hubs ({'null', 'string'})

Status Codes:
POST /v1/api-keys/test

Test Api Key

Status Codes:
PUT /v1/api-keys/{id}

Update Api Key

Parameters:

  • id (string)

Status Codes:
DELETE /v1/api-keys/{id}

Delete Api Key

Parameters:

  • id (string)

Status Codes:
GET /v1/api-keys/{id}

Get Api Key By Id

Parameters:

  • id (string)

Status Codes:

Hub

GET /v1/hubs

Get Hubs

Status Codes:

  • 200 OK – Successful Response

Test

GET /v1/tests/{id}

Get Test By Id

Parameters:

  • id (string)

Status Codes:
GET /v1/tests

Get Tests

Query Parameters:

  • evaluation_id ({'null', 'string'})

  • ids ({'array', 'null'})

  • probe_ids ({'array', 'null'})

  • status ({'null', 'string'})

  • limit (integer) – The maximum number of items to return

  • offset (integer) – The number of items to skip before starting to collect the result set

Status Codes:

Users

GET /v1/users

Get Users By Ids

Query Parameters:

  • ids ({'array', 'null'})

Status Codes:
GET /v1/users/me

Get Current User

Status Codes:

  • 200 OK – Successful Response

GET /v1/users/{id}

Get User By Id

Parameters:

  • id (string)

Status Codes:
POST /v1/users/{id}/set-role

Set Role

Parameters:

  • id (string)

Status Codes:

Teams

GET /v1/teams

Get Teams

Query Parameters:

  • limit (integer)

  • offset (integer)

Status Codes:
POST /v1/teams

Create Team

Status Codes:
GET /v1/teams/{id}

Get Team By Id

Parameters:

  • id (string)

Status Codes:
PUT /v1/teams/{id}

Update Team

Parameters:

  • id (string)

Status Codes:
DELETE /v1/teams/{id}

Delete Team

Parameters:

  • id (string)

Status Codes:
GET /v1/teams/{id}/users

Get Users By Team Id

Parameters:

  • id (string)

Query Parameters:

  • status ({'null', 'string'})

  • team_role ({'null', 'string'})

  • limit (integer)

  • offset (integer)

Status Codes:

Invite

GET /v1/invites/{invite_id}

Get Invite By Id

Parameters:

  • invite_id (string)

Status Codes:
DELETE /v1/invites/{invite_id}

Delete Invite

Parameters:

  • invite_id (string)

Status Codes:
GET /v1/invites/team/{team_id}

Get Invite By Team

Parameters:

  • team_id (string)

Status Codes:
GET /v1/invites/status/{status}

Get Invite By Status

Parameters:

  • status (string)

Status Codes:
POST /v1/invites

Create Invite

Status Codes:
POST /v1/invites/{invite_id}/accept

Accept Invite

Parameters:

  • invite_id (string)

Status Codes:
POST /v1/invites/{invite_id}/decline

Decline Invite

Parameters:

  • invite_id (string)

Status Codes:

Events

POST /v1/events

Post Event

Status Codes:

Leaderboard

GET /v1/leaderboard

Get Leaderboard

Status Codes:

  • 200 OK – Successful Response

User Feedback

GET /v1/results-feedback/{id}

Get Feedback By Id

Parameters:

  • id (string)

Status Codes:
PUT /v1/results-feedback/{id}

Update Feedback

Parameters:

  • id (string)

Status Codes:
GET /v1/results-feedback

Get Feedback

Query Parameters:

  • response_id (string) – (Required)

  • detector_id ({'null', 'string'})

  • prompt_id ({'null', 'string'})

  • created_by ({'null', 'string'})

  • limit (integer)

  • offset (integer)

Status Codes:
POST /v1/results-feedback

Create Feedback

Status Codes:

Chat Completion

POST /v1/chat_complete

Chat Complete

Status Codes:

Monitoring

GET /healthz

Health Check

Endpoint for health check. Returns the status of the service.

Status Codes:

  • 200 OK – Successful Response

GET /metrics

Metrics

Status Codes:

  • 200 OK – Successful Response