DocumentationAPI Reference
Sign in

Convert

Convert an image to Markdown

Sign in to call the API here free (20 conversions a day), or enter an API key below.

POST
/convert/image

Accepted inputs: multipart file, file/files (reference). Options: formats, image_mode, store, metadata.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

wait?integer

Header Parameters

Idempotency-Key?string
Prefer?string

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

file*file

One of .png, .jpg, .jpeg, .webp, .gif, .bmp, .tif, .tiff.

Formatbinary
formats?array<>

Output formats; Markdown when omitted.

image_mode?string

Value in

  • "ocr"
  • "understand"
metadata?

Your own data, returned unchanged.

store?boolean

Keep the result in the account library.

Response Body

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/convert/image" \  -F file="string"
{  "async_reason": "respond_async",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "files": [    {      "bytes": 0,      "content": "string",      "credits": 0,      "error": {        "detail": "string",        "error": "string",        "hint": "string",        "instance": "string",        "message": "string",        "request_id": "string",        "retryable": true,        "status": 0,        "title": "string",        "type": "string"      },      "format": "markdown",      "id": "string",      "links": {},      "mime": "string",      "name": "string",      "object": "file",      "outputs": [        {}      ],      "pages": 0,      "role": "source",      "status": "queued",      "variant": "standard"    }  ],  "files_next_cursor": "string",  "id": "string",  "links": {},  "metadata": null,  "name": "string",  "object": "conversion",  "operation": "parse",  "status": "queued",  "summary": {    "completed": 0,    "failed": 0,    "queued": 0,    "running": 0,    "sources": 0  },  "usage": {    "credits_charged": 0,    "credits_remaining": 0,    "credits_reserved": 0  }}

Errors

Sources and specs: RFC 9110: HTTP Semantics · RFC 7763: The text/markdown Media Type