API referenceCarousels
List carousel options
Find the templates and brands you can use when creating a carousel.
curl -X GET "https://example.com/api/v1/carousels/options?templateSource=posteady&cursor=eyJjcmVhdGVkQXQiOiIyMDI2LTEwLTAxVDAwOjAwOjAwWiJ9"{ "generationCredits": 20, "brands": [ { "brandId": "99999999-9999-4999-8999-999999999999", "name": "Your brand", "hasLogo": true } ], "templates": [ { "templateId": "bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb", "name": "Minimal photo essay", "aspectRatio": "4:5", "slideCount": 8, "language": "en", "previewUrl": "https://media.posteady.com/media/example/template-01.jpg" } ], "nextTemplateCursor": null}Return what a carousel request can use in the API key's workspace: brands, whose name and logo are placed on the slides, and templates, which fix the design while Posteady writes new copy. Also returns the credit cost of one generation.
Authorization
apiKey AuthorizationBearer <token>
In: header
Query Parameters
templateSource?string
posteady (default) lists templates provided by Posteady. workspace lists templates saved in this workspace.
Value in
- "posteady"
- "workspace"
cursor?string
nextTemplateCursor from the previous response.
Response Body
application/json
application/json