Call the generateImage MCP tool
Generate a branded image for an EXISTING draft post (by post_id) and attach it to that post. Reuses the workspace brand profile for logo and colors. It spends credits (check the balance with getCreditBalance). Send idempotency_key (8 to 200 characters) and reuse the same key on a retry after a timeout: a retry with the same key returns the first result, or a conflict telling you to check the result in the app. Returns image_url and the artifact ids of the image card (read them with getArtifact).
Called through the Actions bridge: the response is that tool's own result, wrapped as { data: <tool result> } under HTTP 200. Billing, daily-cap, and confirm-step outcomes are embedded INSIDE data, never remapped to an HTTP status (see the templated /api/v1/actions/{toolName} operation above for the full protocol, and x-mcp-actions for this tool's machine-readable scope/cap/confirm_behavior fields). Authentication, request-shape, and optional idempotency-protocol failures still use their documented non-200 statuses.
Request
- Base URL: https://app.reachium.io
- URL: https://app.reachium.io/api/v1/actions/generateImage
- Auth: HTTP bearer
Headers
Optional caller-generated key (8-200 characters: letters, digits, dot, underscore, colon, or hyphen). A final tool result is replayed for the same key and body. An ambiguous result remains 409 under that key; reconcile external state before using a new key. Reuse with a different body returns 422.
Request body
Response
The result of calling this tool.
Changes
No recorded changes to this operation across all 1 revision of this API.