Skip to main content
POST
Start Batch Run

Authorizations

X-API-Key
string
header
required

Cookies

wos-session
string
datalab_active_team
string

Body

application/json
collection_id
integer
required

ID of the collection to run against

eval_rubric_id
integer | null

ID of the eval rubric to use. Required for standard pipelines, optional for custom pipelines (falls back to pipeline's eval_definition).

pipeline_type
enum<string>
default:convert

One of: convert, extract, segment

Available options:
convert,
extract,
segment
pipeline_id
string | null

Optional custom pipeline ID

page_schema
string | null

Required when pipeline_type=extract

segmentation_schema
string | null

Required when pipeline_type=segment

output_format
string | null

Comma-separated output formats (e.g. 'markdown,json,html')

run_evals
boolean
default:true

Set false to process the collection through a pipeline WITHOUT scoring (e.g. S3 output writeback) — no rubric is required and none runs. Requires pipeline_id; incompatible with eval_rubric_id.

Response

Successful Response

id
integer
required
collection_id
integer
required
eval_rubric_id
integer | null
required
pipeline_id
string | null
required
pipeline_type
string
required
status
string
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
total_files
integer
required
completed_files
integer
required
avg_score
number | null
required
created
string<date-time> | null
required
eval_rubric_version
integer | null
eval_definition_snapshot
Eval Definition Snapshot · object | null
pipeline_version
integer | null