Generate Image Post with AI
postnitro_generate_imageGenerate a single-image post (postType IMAGE) using PostNitro's AI engine. Returns an embedPostId to track progress.
The content is AI-generated from your aiGeneration prompt — you do NOT provide slides. (To supply your own image content instead, use postnitro_import_image.)
templateId, brandId, presetId, and responseType are optional if you've saved defaults via postnitro_set_defaults. Otherwise provide them here (use the list tools to find valid IDs).
Use postnitro_check_status to monitor, then postnitro_get_output to retrieve. Or use postnitro_generate_image_and_wait for one step.
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_image"
}
}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 |
|---|---|---|---|
| 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 |