Extractions

Get an extraction's full record

The stable record of one extraction: the original prompt and options, every file name, and the page-level results, prompt notes and Review Needed items of a completed one. Unlike getExtraction, this endpoint always answers success: true; a failed extraction is a valid record with its failure inside error. It carries no download URLs; use getOutputDownloadUrl for those.

Rate limit: 60 requests per minute per API key.

get/extractions/{extraction_id}/details

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/extractions/{extraction_id}/details
  • Auth: HTTP bearer

Path parameters

extraction_idstring uuid required

The extraction_id returned by submitExtraction.

Query parameters

scope'own' | 'team'

own or team. Team admins default to team and see every team member's extractions; everyone else defaults to own, and a non-admin passing team gets 403 FORBIDDEN. Under team, items carry submitted_by.

Response

The record.

successtrue required

Changes

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