Skip to main content

Get slide images

GET https://api.rollstack.com/public/v1/reports/{id}/slides/images

Renders slides of a report as images, as viewers see them, so you can check how they look: text that overflows or overlaps, or a chart too small to read. After a message's turn, pass its replies' changedSlideIds. At most 10 slides a call; hidden slides are left out. Counts against the 10 exports a minute per user.

Requires the slide_decks:read scope.

Operation ID: getReportSlideImages.

Path parameters

  • id (string, required): The report to act on, by its id from listReports or createReport. Only reports whose type is SlideDeck work here: another type, such as a Google Slides presentation, returns 400. You can also copy it from the report's link in Rollstack: it's the part right after /slides/.

Query parameters

  • slideIds (string or array of string, required): The slides to render, from getReportContent or a reply's changedSlideIds. Hidden slides and ids that are not slides of the report are ignored. 1 to 10 ids: repeat the parameter for each one, as in ?slideIds=a&slideIds=b. Example: f1e2d3c4-b5a6-4978-8a1b-2c3d4e5f6a7b.

Response 200

Success

application/json

  • slides (array of object, required): The rendered slides, in report order, whatever order slideIds lists them in. Hidden slides, and any slide that could not be rendered, are left out.
    • id (string, required): The slide the image shows, as passed in slideIds.
    • mimeType (image/jpeg, required): The format of the image. Always image/jpeg.
    • data (string (base64), required): The slide as viewers see it, as a JPEG image encoded in base64.