Shotstash
API referenceREST referencePipeline

Report progress

Percent done (0 to 100). A cancelled job answers 409 JOB_TERMINAL: stop and drop the work.

Try the REST routes against the public demo at https://demostash.aldyernesto.my.id. Get a read-only token (valid for 60 minutes), then paste it as the Bearer token in the console of any route.

POST
/api/v1/pipeline/jobs/{id}/progress

Percent done (0 to 100). A cancelled job answers 409 JOB_TERMINAL: stop and drop the work.

Authorization

WorkerToken
headerX-Worker-Token<token>

Per-worker token returned once by worker registration.

Path Parameters

id*string

Job id (UUID).

Header Parameters

X-Claim-Token*string

Claim token from the claim answer.

Request Body

application/json
  1. body
progress*number

Percent done, 0 to 100.

Response Body

Progress stored

application/json
  1. response
status*"running"

Always running after a progress report.

Value in"running"
progress*number

The stored percent.

seq*number

Event sequence number of the job (realtime ordering).

curl -X POST "https://example.com/api/v1/pipeline/jobs/string/progress" \  -H "X-Claim-Token: string" \  -H "Content-Type: application/json" \  -d '{    "progress": 0  }'
{  "status": "running",  "progress": 0,  "seq": 0}

Upload the job output PUT

The raw bytes of the one output; streamed. Content-Type is its media type (video/mp4) and X-Output-Ext its extension (mp4). The size limit is SHOTSTASH_PIPELINE_MAX_OUTPUT_MB.

Release the job POST

Puts a claimed or running job back in the queue without spending an attempt (use it on shutdown). Another worker can claim it at once.