Import Custom Carousel
postnitro_import_carouselCreate a carousel by importing your own slide content.
IMPORTANT: Call postnitro_get_import_template FIRST to see the exact slide structure and rules.
templateId, brandId, and responseType are optional if you've saved defaults via postnitro_set_defaults.
Strict rules (violations will cause errors):
First slide MUST be type "starting_slide" (exactly 1)
Middle slides MUST be type "body_slide" (at least 1)
Last slide MUST be type "ending_slide" (exactly 1)
Infographic columnCount must not exceed 3
When columnDisplay is "cycle", put ALL data in the FIRST columnData entry only
Setting layoutType "infographic" replaces the image field
Minimal example: slides: [ { type: "starting_slide", heading: "Welcome!", description: "Intro", cta_button: "Swipe →" }, { type: "body_slide", heading: "Key Point", description: "Details here" }, { type: "ending_slide", heading: "Thanks!", cta_button: "Learn More" } ]
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slides | Yes | Array of slides | |
| brandId | No | Brand ID (optional if saved via postnitro_set_defaults) | |
| templateId | No | Template ID (optional if saved via postnitro_set_defaults) | |
| requestorId | No | Optional custom tracking ID | |
| responseType | No | Output format. 'DESIGN' (default) creates the design with no rendered file — fastest, and enough for scheduling/editing. Use 'PDF' or 'PNG' when you need a rendered file back. Optional if saved via postnitro_set_defaults. | |
| generateImages | No | Optional AI image generation — include this object to enable it, omit it for no images. When included, `context` is required and you (the agent) must author it from the post. Best-effort: the post still COMPLETES if images fail or aren't permitted (free plan / exhausted AI-image quota); check the GENERATE_IMAGES step via postnitro_check_status. Requires a paid plan, consumes the org's AI-image quota (separate from post credits), and adds latency. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Initial job status ('PENDING') | |
| message | No | Message returned by the PostNitro API | |
| success | Yes | True when the job was accepted | |
| nextStep | Yes | The suggested follow-up call | |
| warnings | No | Non-fatal issues worth surfacing to the user (e.g. AI image generation did not complete) | |
| embedPostId | Yes | Generation-job ID — pass to postnitro_check_status, then postnitro_get_output | |
| usedDefaults | Yes | The values actually applied — explicit arguments, saved defaults, or an auto-selected sole candidate |