Extract text

The PDF's text (also as a .txt output file). ocr: auto reads scans with OCR when there's no text layer. Counts as one operation when it succeeds.

post/extract-text

Request

  • Base URL: https://marqpdf.com/v1
  • URL: https://marqpdf.com/v1/extract-text
  • Auth: HTTP bearer

Request body

filestring required

A file id from POST /files.

ocr'auto' | 'always' | 'never'
waitinteger

Seconds to wait for the result before answering 202 with a job to poll. 0 = answer at once.

webhook_urlstring uri

POSTed the finished job, signed with your webhook secret (MarqPDF-Signature).

Example request

{
  "file": "file_…"
}

Response

Finished: the job with its output

object'job' required
idstring required
operationstring required
status'queued' | 'running' | 'succeeded' | 'failed' required
created_atstring date-time required
started_atstring nullable
finished_atstring nullable
webhook_urlstring nullable
webhookobject nullable

Example response

{
  "id": "job_3Fq…",
  "output": {
    "files": [
      {
        "id": "file_8rX2…"
      }
    ]
  }
}

Changes

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