Skip to main content
POST
Run an extraction flow

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

flow_id
string<uuid>
required

UUID of the extraction flow

Body

application/json
document_ids
string<uuid>[]

Optional list of document UUIDs to run the flow on. If omitted or empty, the flow runs against all documents in the project.

Response

Sync started

message
string
Example:

"Sync started."

pipeline_run_id
string<uuid>