Skip to navigation

Answer questions from the text

Extractive question answering: each answer is a span of the text, with its position. Null when nothing fits. On an image the vision model answers directly and start and end are null.

Send text for one result, texts for a batch wrapped as { results: [...] }, or image (one image, at most 5 MB decoded, optionally with text; never with texts). The response carries x-input-chars (input characters) and x-input-tokens (input tokens billed for this call) headers. Each item of texts (and each of statements or questions) counts as one request against the requests-per-minute limit.

Authentication

AuthorizationBearer

A milliseconds API key, test_sk-{namespace}-{entropy} or prod_sk-{namespace}-{entropy}. Every /v1 route requires it.

Request

This endpoint expects an object.
textstringOptional1-20000 characters
The text to decide about.
textslist of stringsOptional

Batch form: one result per text.

imagestringOptional>=1 character

One image: a data:image/(jpeg|png|webp);base64, URL, or bare base64 of a JPEG, PNG or WebP. 5 MB decoded at most. URLs are never fetched. May travel with text (extra context), never with texts.

detailenumOptional

Image resolution: low 512 px, medium 768 px (default), high 1024 px longest edge. Higher sees more and bills more.

Allowed values:
questionstringOptional>=1 character
questionslist of stringsOptional

Response

Result, or { results } for a batch

object
OR
object

Errors

400
Bad Request Error
502
Bad Gateway Error