Ask a document

Answer a question about a PDF or an image, from the document only; the answer is in output.text. Runs on MarqPDF's model or one of your own (model). Counts as one operation when it succeeds.

post/ask

Request

  • Base URL: https://marqpdf.com/v1
  • URL: https://marqpdf.com/v1/ask
  • Auth: HTTP bearer

Request body

filestring required

A file id from POST /files.

questionstring required
instructionsstring

Extra guidance, e.g. 'answer in one sentence'.

modelstring

"marqpdf" (the default) or "provider/model" on a key you've added, e.g. "anthropic/claude-opus-5-5", "openai/gpt-5.1", "gemini/gemini-2.5-pro", "openrouter/…", "custom/…".

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_…",
  "model": "anthropic/claude-opus-5-5"
}

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.