Get a slideshow

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

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

Needs the read permission. One slideshow with every slide's image and words, its caption, its approval and, for a tailored one, its preview sheet: one shape for both kinds.

Parameters

NameInTypeRequiredNotes
idpathstringyes

Example request

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

Responses

StatusMeaning
200The slideshow.
401No access key, or an unknown, revoked or expired one
403The key lacks the permission, or the account has no active plan
404No such slideshow of yours.
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": "ses_Ry4kP2",
  "kind": "canvas",
  "title": "Three ways to keep rice fluffy",
  "topic": "Three ways to keep rice fluffy",
  "status": "editing",
  "reviewState": "draft",
  "caption": "Three ways to keep rice fluffy. Save this for later.",
  "scheduledFor": null,
  "link": "https://wavegrain.com/editor/ses_Ry4kP2",
  "sheetUrl": null,
  "slides": [
    {
      "number": 1,
      "imageUrl": "https://wavegrain.com/media/slides/ses_Ry4kP2/1.jpg",
      "text": [
        "Fluffy rice, every time",
        "Three steps that work"
      ]
    }
  ]
}

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