Create a carousel
Submit a topic, text, or link and let Posteady write and design a multi-slide carousel.
curl -X POST "https://example.com/api/v1/carousels" \ -H "Content-Type: application/json" \ -d '{ "requestId": "77777777-7777-4777-8777-777777777777", "topic": "Five mistakes first-time cafe owners make in their opening month", "slideCount": 7, "language": "en" }'{ "carouselId": "cccccccc-cccc-4ccc-8ccc-cccccccccccc", "status": "completed", "editorUrl": "https://www.posteady.com/carousel/cccccccc-cccc-4ccc-8ccc-cccccccccccc", "title": "Five mistakes first-time cafe owners make", "caption": "Opening a cafe? Avoid these five mistakes in your first month.", "aspectRatio": "4:5", "slideCount": 7, "images": [ { "mediaId": "dddddddd-dddd-4ddd-8ddd-dddddddddddd", "url": "https://media.posteady.com/media/example/slide-01.jpg", "width": 1080, "height": 1350 } ]}Accept a carousel generation request. Posteady writes the slide copy and designs the slides from a topic, source text, or a link, then renders each slide as a JPEG image in the workspace media library. One generation costs the credits reported by the options endpoint; imageMode ai is charged per generated image in addition. The request only queues the work and returns 202 with a carouselId: generation usually takes one to three minutes. Poll the carousel endpoint until status is completed or failed. If generation fails, its generation credits are refunded. Problems you can fix (invalid input, plan, credits, an unknown template or brand) are returned immediately instead of becoming a failed carousel.
Authorization
apiKey In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Provide exactly one of topic, text, or url as the content source. With templateId, Posteady keeps the template's design and writes new copy into it; without it, Posteady designs the carousel.
Response Body
application/json
application/json
application/json
application/json
application/json