Sign in

v1

latestOpenAPI 3.1.0Apache-2.02026-07-226091175.5 KB
Evaluation

Get dataset example

Fetch one dataset example, including input, expected output, expected files, metadata, and overrides.

get/api/v1/automations/{id}/examples/{exampleId}

Path parameters

idstring required

Automation id or typed alias.

Automation id or typed alias.

exampleIdstring required

Dataset example id. Agent examples may use deterministic name-derived ids returned by list/create responses.

Dataset example id. Agent examples may use deterministic name-derived ids returned by list/create responses.

Response

Dataset example.

idstring required

Stable public example id. Workflow examples use DB ids; agent examples use deterministic name-derived ids.

namestring required

Human-readable dataset example name.

automationIdstring required

Automation that owns this example.

automationType'workflow' | 'agent' required
inputobject nullable required

Input arguments used when this example is run.

{"stackTrail":"components:schemas:DatasetExample:properties:expected:anyOf","oasType":"schema","type":"unknown","description":"Expected JSON output for evaluator comparisons.","nullable":true}
metadataobject nullable required

Caller-managed metadata for sorting or filtering examples.

annotationstring nullable required

Human note about the example.

rowOrdernumber nullable required

Optional display order within the dataset.

overridesobject nullable required

Step output overrides used when running this example.

latestRunIdstring nullable required

Most recent run id created from this example.