Documentation Index
Fetch the complete documentation index at: https://docs.verial.ai/llms.txt
Use this file to discover all available pages before exploring further.
Manage benchmark runs that execute all tasks in a benchmark and collect results.
Actions
| Action | Description |
|---|
list | List all benchmark runs in the organization |
create | Start a new benchmark run |
get | Get a benchmark run by ID |
complete | Mark a benchmark run as complete |
cancel | Cancel a benchmark run |
Parameters
list
No parameters.
create
| Parameter | Type | Required | Description |
|---|
benchmarkId | string | yes | Benchmark ID to run |
get
| Parameter | Type | Required | Description |
|---|
id | string | yes | Benchmark run ID |
complete
| Parameter | Type | Required | Description |
|---|
id | string | yes | Benchmark run ID |
cancel
| Parameter | Type | Required | Description |
|---|
id | string | yes | Benchmark run ID |
Examples
Start a benchmark run
{
"action": "create",
"benchmarkId": "bm_abc123"
}
Get run results
{
"action": "get",
"id": "br_xyz789"
}
Cancel a running benchmark
{
"action": "cancel",
"id": "br_xyz789"
}