OUouterport
Documents

Update document file content

Changed on

Trigger processing of a document after client has uploaded to storage.

put/api/v0/documents/{document_id}/upload-url

Request

Path parameters

document_idstring uuid required

Request body

upload_urlstring required

The signed upload URL for the document.

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

knowledge_base_idstring uuid nullable

Collection whose persisted processing settings apply.

skip_page_processingboolean nullable

When True, skip per-page visual processing entirely (no layout detection, OCR, or component extraction). The document is stored, converted to PDF, and its page count recorded.

text_mode'auto' | 'extract'

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

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

  • fcd15f6d35b4Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property default value false was removed

    • info

      request property list-of-types was widened by adding types null to media type application/json