NaceDocs
DashboardGet an API key
DocumentationAPI ReferenceSDKsCLI

Perception

Cancel or delete a job

Other errors (500, 502, 503, 504, 529) are on Errors.

DELETE
/v1/documents/jobs/{id}

Other errors (500, 502, 503, 504, 529) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The job's job_id, as returned when it was created.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/documents/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty

Get a document job GET

The job with its result once it has finished.

Get a job artifact GET

A file the job produced (parse images, transcripts, ground crops, converted files), its request echo, or its events stream, at the path the job body links to.