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
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
id | path | string | yes |
Example request
curl https://wavegrain.com/api/v1/jobs/ID \
-H "Authorization: Bearer $WAVEGRAIN_KEY"
Responses
| Status | Meaning |
|---|---|
| 200 | The job. |
| 401 | No access key, or an unknown, revoked or expired one |
| 403 | The key lacks the permission, or the account has no active plan |
| 404 | No such job of yours, or it finished more than 24 hours ago. |
| 429 | Too many requests for the key or the account |
| 500 | Something 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
}
More in the Carousel API
- Estimate a slideshow's price:
POST /api/v1/slideshows/estimate - Make a slideshow from a topic:
POST /api/v1/slideshows - List slideshows:
GET /api/v1/slideshows - Make a slideshow in a post's look:
POST /api/v1/slideshows/copies - Get a slideshow:
GET /api/v1/slideshows/{id} - Download a slideshow:
POST /api/v1/slideshows/{id}/export - All endpoints
Something wrong or missing? Write to support@wavegrain.com.