Skip to main content
Glama

Edit a Post and Wait for Output

postnitro_edit_post_and_wait

Edit a post made through the API, poll until it completes, and return the output. It replaces ALL the slides, in place: the post's design keeps its designId and name, its template's look and size and its brand unless templateId or brandId gives new ones, and a video its style and audio unless videoSettings says otherwise, so scheduled posts using it show the edit. Read it first with postnitro_get_post and send back every slide you want kept. Only posts made through the API can be edited. Costs 1 credit per slide sent.

Input Schema

NameRequiredDescriptionDefault
slideNoFor an IMAGE: its new slide object
slidesNoFor a CAROUSEL or VIDEO: all its new slides, as import takes them
brandIdNoA new brand for the design (postnitro_list_brands). Omit to keep the design's; saved defaults don't apply to an edit
templateIdNoA new template for the design (postnitro_list_templates): the slides take its look and size. Omit to keep the design's; saved defaults don't apply to an edit
embedPostIdYesThe post to edit: the embedPostId its generate or import tool returned, or one an earlier edit returned
requestorIdNoOptional custom tracking ID
responseTypeNo'DESIGN' (default), 'PDF' or 'PNG'; a video takes 'MP4' or 'DESIGN'
videoSettingsNoA video's motion, music and voiceover, all optional: without it the video is still animated. It runs as long as its motion and narration take, up to 2:00. When it's later scheduled as a reel, the API reuses its music.
generateImagesNoOptional 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.
idempotencyKeyNoOptional 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

NameRequiredDescriptionDefault
dataNoPublic 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'.
nameNoDesign name
statusYesJob status, e.g. 'COMPLETED'
successYes
designIdNoDesign ID — the value to pass as designId when scheduling. Absent only when it could not be resolved from the output.
durationNoVideo posts: how long the video runs, in seconds
mimeTypeNoMIME type of the rendered file. Omitted for responseType 'DESIGN' (no file is rendered).
warningsNoNon-fatal issues worth surfacing to the user (e.g. AI image generation did not complete)
editorUrlYesDeep link that opens the design in the PostNitro editor; null when it cannot be resolved
outputTypeNoRendered output type: 'pdf', 'png', or 'mp4'. Omitted for responseType 'DESIGN'.
aspectRatioNoDesign aspect ratio, e.g. '4:5'
creditsUsedNoCredits consumed by this post
embedPostIdYesThe generation-job ID
responseTypeYesOutput format of the post: 'PDF', 'PNG', 'DESIGN', or 'MP4' (video posts)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / idempotencyKey
      Added value: +{
      +  "description": "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).",
      +  "pattern": "^[\\x21-\\x7E]{1,200}$",
      +  "type": "string"
      +}
  2. Added

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Discloses what is destroyed and what is preserved: ALL slides are replaced in place, while designId, name, template look/size and video style/audio survive unless the corresponding override is given. It also notes the downstream effect on scheduled posts and the cost model ('1 credit per slide sent'), which annotations alone do not convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and the key replacement semantics in the very first sentence, but the second sentence is a long chained clause covering five separate retention rules, which is dense to parse even though nothing in it is filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers workflow, cost, retention semantics and API-only eligibility for a 10-parameter nested tool with an output schema. Gaps are small: nothing about polling timeout/failure behavior or about the idempotencyKey retry contract that the schema defines.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage the baseline is 3, and the description earns above it by explaining the keep-vs-replace semantics of templateId/brandId/videoSettings and the 'send every slide you want kept' contract for the slides array, which the schema itself does not frame as a replace-all operation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Edit a post made through the API') plus the synchronous behavior ('poll until it completes, and return the output'), which distinguishes it from postnitro_edit_post and postnitro_get_post without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit prerequisite workflow ('Read it first with postnitro_get_post and send back every slide you want kept') and a hard eligibility rule ('Only posts made through the API can be edited'), so the agent knows both how to prepare and when the call will fail.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources