Follow a slideshow job

Follow a slideshow job with the Wavegrain Carousel API: GET /api/v1/jobs/{id}. Parameters, responses and an example request.

GET /api/v1/jobs/{id} is part of the Carousel API. Every call needs an access key: see Authentication.

Needs the read permission. Where a job from POST /api/v1/slideshows or /copies stands. Ask about every 20 seconds until it is ready, needs_images or failed; a finished job stays readable for 24 hours.

Parameters

NameInTypeRequiredNotes
idpathstringyes

Example request

curl https://wavegrain.com/api/v1/jobs/ID \
  -H "Authorization: Bearer $WAVEGRAIN_KEY"

Responses

StatusMeaning
200The job.
401No access key, or an unknown, revoked or expired one
403The key lacks the permission, or the account has no active plan
404No such job of yours, or it finished more than 24 hours ago.
429Too many requests for the key or the account
500Something went wrong on Wavegrain's side; try again, and send the request id if it keeps failing.

A successful answer:

{
  "id": "mcpgen_8Qz2Lk",
  "kind": "canvas",
  "state": "ready",
  "slideshowId": "ses_Ry4kP2",
  "creditsCharged": 9,
  "emptySlides": [],
  "queuePosition": null,
  "message": null
}

Something wrong or missing? Write to support@wavegrain.com.