Skip to main content
POST
Run Pipeline

Authorizations

X-API-Key
string
header
required

Path Parameters

pipeline_id
string
required

Cookies

wos-session
string
datalab_active_team
string

Body

multipart/form-data
file_url
string | null

Optional file URL (http/https). If provided, the server will download and process it.

page_range
string | null

Page range to process, e.g. '0,2-4'.

output_format
string | null

Output format: json, html, markdown, or chunks.

skip_cache
boolean
default:false

Skip the executor cache and re-run all steps.

checkpoint_id
string | null

Checkpoint from a previous run's convert step. When provided, re-parsing is skipped and only downstream steps run. The file must still be provided.

webhook_url
string | null

URL to POST when the execution completes.

processing_location
string | null

Optional residency region override (e.g. us, eu). When provided, use file_url or direct-upload; multipart uploads are rejected. When omitted, the request uses the team's configured residency and profile.

version
integer | null

Pipeline version to execute. 0 = use draft steps. Omit to use the active published version (or draft if unpublished).

Required range: x >= 0
file
file | null

Input PDF, word document, powerpoint, or image file, uploaded as multipart form data. Images must be png, jpg, or webp format.

Response

Successful Response

execution_id
string
required
pipeline_id
string
required
pipeline_version
integer
required
status
string
required
steps
PipelineExecutionStepResponse · object[]
required
progress_percent
integer | null

Estimated overall work completed. Null when unavailable; 100 only on successful completion.

Required range: 0 <= x <= 100
started_at
string<date-time> | null
completed_at
string<date-time> | null
created
string<date-time> | null
config_snapshot
Config Snapshot · object | null
input_config
Input Config · object | null
rate_breakdown
Rate Breakdown · object | null