Skip to main content
Browse Docs
On This Page
View Markdown~317 tokensDownload Markdown~317 tokens

Job endpoints

After submitting a job, poll status and download the result.

Get job status

GET /job/{id}
X-Fast-Api-Key: YOUR_API_KEY

Typical statuses:

StatusMeaning
queuedThe job is waiting to start.
runningThe job is processing.
succeededThe ZIP is ready.
failedThe job failed; inspect the stable error code.
canceledThe job was canceled.

Poll with backoff. A practical starting point is every 1 to 2 seconds while queued or running, then slower after repeated unchanged responses.

Download result

GET /job/{id}/download
X-Fast-Api-Key: YOUR_API_KEY

Downloads a ZIP when the job has succeeded. The ZIP is deleted automatically after the configured retention window.

Cancel job

POST /job/{id}/cancel
X-Fast-Api-Key: YOUR_API_KEY

Cancellation mirrors the other Tools.FAST APIs. It can cancel queued or running work when the job state allows it. If a charged job is canceled or fails after debit, refund handling follows the service billing state machine.

Delete job

DELETE /job/{id}
X-Fast-Api-Key: YOUR_API_KEY

Deletes job metadata and stored artifacts when the job is accessible to the caller and the state allows deletion.

Copied