Generate Carousel and Wait for Output
postnitro_generate_and_waitConvenience tool: generates a carousel with AI, polls until completion, and returns the final output. May take 30-180 seconds.
For a single-image post instead of a carousel, use postnitro_generate_image_and_wait.
templateId, brandId, presetId, and responseType are optional if you've saved defaults via postnitro_set_defaults.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"aiGeneration": "<aiGeneration>"
},
"name": "postnitro_generate_and_wait"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| brandId | No | Brand ID (optional if saved via postnitro_set_defaults) | |
| presetId | No | AI preset 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 | |
| aiGeneration | Yes | ||
| 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. | |
| idempotencyKey | No | Optional key that makes this call safe to retry. Generate a new one (e.g. a UUID) for each new action. If the call times out, fails with a network or 5xx error, or you are unsure it went through, call again with the SAME key and the same arguments: PostNitro returns the first call's result instead of creating a second post, charging credits again or scheduling a duplicate. Only a successful call is remembered, so after an error you can fix the arguments and retry with the same key; reusing a successful call's key with different arguments is rejected (422). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Public URL of the rendered file — a single URL for PDF and MP4, an array of them for PNG (one per page). Omitted for responseType 'DESIGN'. | |
| name | No | Design name | |
| status | Yes | Job status, e.g. 'COMPLETED' | |
| success | Yes | True when the post finished processing | |
| designId | No | Design ID — the value to pass as designId when scheduling. Absent only when it could not be resolved from the output. | |
| duration | No | Video posts: how long the video runs, in seconds | |
| mimeType | No | MIME type of the rendered file. Omitted for responseType 'DESIGN' (no file is rendered). | |
| warnings | No | Non-fatal issues worth surfacing to the user (e.g. AI image generation did not complete) | |
| editorUrl | Yes | Deep link that opens the design in the PostNitro editor; null when it cannot be resolved | |
| outputType | No | Rendered output type: 'pdf', 'png', or 'mp4'. Omitted for responseType 'DESIGN'. | |
| aspectRatio | No | Design aspect ratio, e.g. '4:5' | |
| creditsUsed | No | Credits consumed by this post | |
| embedPostId | Yes | The generation-job ID | |
| responseType | Yes | Output format of the post: 'PDF', 'PNG', 'DESIGN', or 'MP4' (video posts) | |
| usedDefaults | Yes | The values actually applied — explicit arguments, saved defaults, or an auto-selected sole candidate |