Starting the Ingest Process
Discover how to create documents from uploaded files and initiate the ingestion process using the Vulgate API.
Creating a document and initiating an ingest job
To create a new document from the uploaded file(s) and initiate a job, make a request to the following endpoint:
POST /api/jobsRequest schema
The request body must include either files or document_id:
| Field | Type | Default | Description |
|---|---|---|---|
files | array | Conditional* | Array of file objects with id (string). Required if document_id is not provided. |
document_id | string (UUID) | Conditional* | UUID of an existing document. Required if files is not provided. |
team | string | — | Team identifier |
model | string | — | Model to use for processing |
pipeline | object | — | Ingest pipeline configuration |
ingest_mode | string | — | Mode for ingestion |
scope | object | — | Document scope configuration |
audio_options | object | — | Audio processing options |
audio_options.transcription | boolean | — | Enable audio transcription |
audio_options.music_analysis | boolean | — | Enable music analysis |
The created document’s document_format is set automatically on the server from the first uploaded file’s content type; this field is not part of the request body.
* Either files or document_id must be provided, but not both.