Extractions

Cancel an extraction

Stops an extraction that is queued or processing. The request is recorded at once and the extraction stops at its next opportunity; wait for it with getExtraction until its status is cancelled, whose credits_deducted covers the work done. An extraction that was about to finish may complete instead. The request has no body. Idempotent: a repeat returns the same result and records nothing new.

Rate limit: 30 requests per minute per API key.

post/extractions/{extraction_id}/cancel

Request

  • Base URL: https://api.invoicedataextraction.com/v1
  • URL: https://api.invoicedataextraction.com/v1/extractions/{extraction_id}/cancel
  • 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

While the extraction is still processing, confirmation that the request was recorded; once it has been cancelled, the cancelled status as getExtraction returns it.

OR

Changes

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