Layout-preserving Markdown conversion

post/ocr/markdown

Request

  • Base URL: https://api.space-ocr.com
  • URL: https://api.space-ocr.com/ocr/markdown
  • Auth: HTTP bearer

Request body

imagestring required

base64 or URL of the image. The JSON body caps at 28MB; base64 inflates a file by ≈1.33×, so that is roughly a 20MB original image. Over the cap returns 413 with details.limitBytes / details.receivedBytes.

imageType'base64' | 'url'

Type of image — "base64" or "url". Required (also accepted via the deprecated alias image_type).

image_type'base64' | 'url'

Deprecated alias of imageType.

promptstring

Optional extra instruction for the layout pass (e.g. keep table borders).

languageHintsstring[]

BCP-47-ish OCR language hints, e.g. ["ja","en"]. Defaults to ja/ko/en.

language_hintsstring[]

Deprecated alias of languageHints.

includeElementsboolean

Default true — the response carries the per-element list with boxes and text_verified. Set false for the assembled Markdown string only.

include_elementsboolean

Deprecated alias of includeElements.

Example request

{
  "imageType": "url",
  "image_type": "url"
}

Response

OK

statusstring required
messagestring

Example response

{
  "status": "success"
}

Changes

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