OUouterport
Documents

Expand an uploaded .zip or .pst container

Changed on

Queues the expansion of a container whose bytes were PUT to the URL from POST /documents/containers/upload-url into folders and documents. The response carries a job id and no document id. An upload is expanded once: a later request with the same upload_id and name, including one sent at the same moment, queues nothing and returns the first request's job in its current status, whatever collection or options it names. The folder it names must still be one the caller owns.

post/api/v0/documents/containers

Request

Request body

upload_idstring uuid required

The upload_id POST /documents/containers/upload-url returned.

namestring required

The container's file name, as sent for the upload URL.

folder_idstring uuid nullable

The folder the container's contents land in.

knowledge_base_idstring uuid nullable

Collection every expanded document joins, and whose persisted processing settings apply.

skip_page_processingboolean nullable

When True, every expanded document is stored without per-page visual processing.

text_mode'auto' | 'extract'

Per-upload text-source override accepted at the HTTP boundary.

generate_contentboolean

Whether to generate structured content (e.g., HTML tables)

generate_descriptionboolean

Whether to generate human-readable descriptions for visual components

generate_summaryboolean

Whether to generate a document summary

Response

Successful Response

job_status_idstring uuid required

The ID of the job status.

statusstring required

The status of the job. Options: pending, done, error.

error_messagestring nullable required

The error message if the job failed.

document_idstring uuid nullable required

The ID of the document that was uploaded.

Changes