For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve generation results

Retrieve a completed asynchronous generation.

GET /generate/{_id} retrieves a generation request.

Requires the X-Api-Key header.

Path parameters

Parameter
In
Type
Required
Description

_id

path

string

Yes

Generation identifier.

Responses

Status
Description
Schema

200

OK

GetGenerationResponse

400

Bad Request

ValidationError

401

The API key is missing or invalid.

500

Every input returns Invalid generation ID format, including the generationId from POST /generate. This endpoint is unusable. Use POST /generate/sync or a completion webhook instead. Known defect.

Example

curl -X GET "https://<api-host>/generate/{_id}" \
  -H "X-Api-Key: $DOCAI_API_KEY"

Last updated