Initiate carousel creation from your own slide content

Creates a carousel post from caller-provided slide content. Slide order rules: exactly one starting_slide first, at least one body_slide in the middle, exactly one ending_slide last. Returns immediately with an embedPostId; poll GET /post/status/{embedPostId} until COMPLETED, then call GET /post/output/{embedPostId}. Content import costs 1 credit per slide. Docs: https://postnitro.ai/docs/embed/api/initiate/import.md

post/post/initiate/import

Request

Base URL
https://embed-api.postnitro.ai
Auth
API key in header embed-api-key

Headers

Idempotency-Keystring

Makes the request safe to retry. Send a new unique value (a UUID is ideal) for each new action. For 24 hours after a successful (2xx) request, the same key and body return the first response with the header Idempotent-Replayed: true, instead of creating, charging or scheduling again. Only successes are kept: after an error, fix the request and send it again with the same key. The same key with a different body returns 422; a retry while the first request is still running returns 409 with Retry-After. Keys are scoped to the API key. See https://postnitro.ai/docs/embed/api/idempotency

Request body

postType'CAROUSEL' | 'IMAGE' | 'VIDEO' required

Type of post to create. Must be uppercase. CAROUSEL and VIDEO take an array of slides (for VIDEO each slide is a scene); IMAGE takes a single slide object

requestorIdstring

Optional custom identifier for tracking

templateIdstring required

ID of the design template to use

brandIdstring required

ID of the brand configuration to apply

responseType'DESIGN' | 'PDF' | 'PNG' | 'MP4'

Output format. DESIGN (default) creates and saves the design without rendering a file. PNG produces one image per slide. PDF produces a single document. MP4 produces a single video and is valid only for postType VIDEO, which in turn accepts only MP4 or DESIGN. Send a rendering format explicitly if you need a file

Example request

{
  "videoSettings": {
    "motionStyle": "bold",
    "backgroundMusicVolume": 25,
    "voiceover": {
      "voice": "nova",
      "tone": "Hype and punchy"
    }
  }
}

Response

Generation initiated

successboolean

messagestring

Example response

{
  "message": "CAROUSEL generation initiated"
}

Changes

No recorded changes to this operation across all 1 revision of this API.