v1Resources/Posts/postGenerate an idea image
Generate an idea image
Requires Social and owning-client access, a location-level idea and a ready content generator. Uses one monthly image credit, reserved before generation and released if generation fails. Replaces replaceUrl when found, otherwise the cover; preserves other images. referenceIntents supplies text guidance; reference images are not supported. Refuses another person’s import-review lock. If edited during generation, returns status:not_attached, reason:idea_changed and the paid imageUrl without overwriting the idea; do not automatically generate again. Does not publish.
post
ideas:write/api/v1/post-ideas/{id}/generate-visualQuery parameters
idstringrequired
Request body
promptstringoptional
imageSizestring (landscape_16_9 | square_hd | square | portrait_16_9)optional
referenceIntentsarray of stringoptional
replaceUrlstringoptional
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The idea, settings, affected clients or image credit reservation changed; read the current state before retrying.
422The operation is not valid for this idea or its destinations.
423Another person is reviewing this imported calendar.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The generator or operation is temporarily unavailable.
post/api/v1/post-ideas/{id}/generate-visual
Your API key
id *
Request body
{}Guides that use this resource
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Add Local Marketing Functionality to Vertical SaaSAdd local marketing to a vertical SaaS by mapping existing customers to clients and locations, and shipping only the features your niche needs.
- How to Publish Google Business Profile Posts ProgrammaticallyPublish announcements, offers and events to Google Business Profile via API, schedule them, handle the missing-connection draft, and measure post performance.
- How to Retrieve Google Business Profile Analytics via APIPull Google Business Profile analytics through an API, portfolio-wide and per location, with views, calls, direction requests and a maps-versus-search split.
- Publish a Google Business Profile Post via APIPublish an announcement, offer or event to a location's connected platforms, and handle the draft returned when a platform is not connected.