Convert a document to markdown (OCR / parser pipeline)

Convert a document to markdown via VLM (fast) or full parser pipeline (default).

Optional Idempotency-Key header. The fingerprint covers the normalized request body (including file_uri, mode, etc.) so retries that point at the same S3 object with the same options replay the cached markdown instead of re-running OCR. 24 h TTL.

post/v1/ocr/to-markdown

Request

  • Base URL: https://api.clichefactory.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.clichefactory.com/v1/ocr/to-markdown
  • Auth: none declared

Headers

Idempotency-Keystring nullable
X-API-KEYstring nullable

Request body

tenant_idstring

Tenant scope for this operation; must match the authenticated user API key's tenant (e.g. Emio uses str(user.pk)). Admin keys ignore this field.

file_uristring required

S3 URI of the file to convert (s3://bucket/key)

file_namestring nullable

Original filename (used for MIME detection). Inferred from file_uri if omitted.

mode'fast' | 'default' nullable

Conversion mode. 'fast' sends file bytes directly to VLM. 'default' (or None) uses the full OCR pipeline.

Response

Successful Response

statusstring
markdownstring required

Extracted markdown text

plain_textstring nullable

Plain text (without markdown formatting)

metaobject

Parser metadata (mode, parser, etc.)

Changes

No recorded changes to this operation across all 1 revision of this API.