Trigger Parse
Explicitly kick the parsing pipeline over one or more files and/or
folders that were already uploaded and finalized. For each target the
server resolves the parse-stage task from {company, flow} and enqueues the
extract step, which then hands off to the resolved create_<flow>_v<N> task.
Each target becomes ONE parse run: a fileId parses that single file, and a
folderId recursively flattens the folder to its live, ready files and parses
them together as one run (a folder of N documents is one run, not N). Provide
at least one of fileIds or folderIds.
This is the only way to start parsing: upload and finalize a file (or a folder of files), then POST here to parse it. 3rd-party callers and the inbound-email forwarder both use this to parse (or re-parse) content uploaded earlier. Poll the outcome with List Parse Runs.
Enqueuing is idempotent at the boundary: re-posting the same target for the
same flow collapses to duplicate outcomes rather than enqueuing twice. Set
force: true to bypass this dedupe and force a fresh run for each target.
Content that has not finished scanning is safe to trigger — extract
self-gates and backs off until every file in the target is ready.
A folder that is an email-sourced import from a sender the company has not
recognized is never parsed: its outcome is skipped_unrecognized_sender
(with runId: null) and no run is created. An operator can recognize the
sender on the in-app Imports page to make the folder parseable.
Required permission: company.file:create
Authorizations
API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.
Path Parameters
Company identifier
Body
Which parsing flow to run for these targets.
submission, policy Ids of already-uploaded, finalized files to parse (each a run of one file). Optional, but provide at least one of fileIds or folderIds.
Ids of folders to parse. Each folder is recursively flattened to its live, ready files and parsed together as a single run. Optional, but provide at least one of fileIds or folderIds.
Optional pin for the parse-stage task version (e.g. create_submission_v1). Must be a registered parse-stage task name or the request is rejected with a 400.
Blind re-trigger. When true, bypass the per-target dedupe so each requested target always mints a fresh run (a full extract+parse) instead of collapsing to duplicate. Defaults to false, which keeps the idempotent dedupe behavior.