Trigger an asynchronous article ingestion from an uploaded file

Uploads a source file (for example a PDF or other document) for a given article type and processes it asynchronously into one or more versioned articles.

This is the async, job-based alternative to POST /locations-directory/articles/bulk: instead of submitting article JSON directly, you upload the original source document and a Temporal workflow extracts, validates, and writes the resulting articles on your behalf.

The request is accepted (202) as soon as the job has been recorded and the ingestion workflow has been started — it does not wait for the ingestion to finish. Poll GET /locations-directory/articles/ingestions/{id} (the URL returned in the Location response header) to track status, and to read the warnings, errors, and summary the workflow reports once it has processed the file.

type_id must reference an article type that is both enabled for the account and configured with an ingestion workflow; an unrecognized, disabled, or unconfigured type is rejected with a 422 rather than accepted and left to fail asynchronously.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Scope

locations-directory:write

Body Params
string
required
length ≥ 1

The id of the article type to ingest the file into. Must reference an article type that is both enabled for the account and configured with an ingestion workflow; otherwise the request is rejected (see the 422 responses below).

string
required
length between 1 and 255

Your own identifier for the source document being ingested — for example a file name/path or a document management system id. Stamped onto every article this ingestion writes, so that each resulting article can be traced back to the document it came from; there is no default, since an article with no traceable source document defeats the point of versioning by source.

file
required

The source file to ingest (for example a PDF or other document understood by the target article type's ingestion workflow). Must not be empty.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json