API referenceCarousels
Get a carousel
Check whether a carousel is ready and get its rendered slide images for publishing.
curl -X GET "https://example.com/api/v1/carousels/cccccccc-cccc-4ccc-8ccc-cccccccccccc"{ "carouselId": "cccccccc-cccc-4ccc-8ccc-cccccccccccc", "status": "processing"}Return the generation status and result of a carousel in the API key's workspace. Use the carouselId from the create request. When status is completed, images lists the rendered slides in order; pass their mediaId values to a publishing or scheduling request, and use caption as the post text if you like. A failed carousel includes an error code and message. Generation credits are refunded on failure, except RENDER_FAILED, where the carousel was saved and can be finished in the Posteady editor. This endpoint only reads stored state and never starts a new generation.
Authorization
apiKey AuthorizationBearer <token>
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json