Skip to main content
POST
Run an extraction flow

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

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>