v1

latestOpenAPI 3.1.0Apache-2.02026-07-226091175.5 KB

Evaluation

Run dataset example

Start an asynchronous run using the input from one dataset example. Poll GET /api/v1/runs/{id} for completion and use run scores or review endpoints to review the result.

post/api/v1/automations/{id}/examples/{exampleId}/run

Path parameters

idstring required

Automation id or typed alias.

exampleIdstring required

Dataset example id to run.

Response

Example run accepted

idstring required

Run id created for this example.

type'workflow' | 'agent' required

Implementation type behind the automation.

batchIdstring nullable required

Experiment batch id when the run is associated with a batch. The API also calls this an experiment id in experiment routes.

finishedfalse required

Example runs are accepted asynchronously.