Skip to content
SynupAPI
Get an API key
POSTapi.synup.com/api/v4/social-post-ideas/generate-idea-visual

Generate idea visual

Generates an on-demand visual (image) for a social post idea from a prompt, optionally grounded by up to two referenceImageUrls and a target imageSize.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Headers

NameTypeRequiredDescription
Synup-VersionstringrequiredAPI version date (YYYY-MM-DD).

Body

NameTypeRequiredDescription
ideaIdstringrequired
promptstringoptional
referenceImageUrlsarray of stringoptional
imageSizestringoptional

Request

Request
curl -X POST 'https://api.synup.com/api/v4/social-post-ideas/generate-idea-visual' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "ideaId": "91b2...",
  "prompt": "bright storefront on a sunny day"
}'

Responses

StatusDescription
200Successful response
401Unauthorized - Invalid or missing API key
Example response (generated from the schema)
{
  "data": {
    "generateIdeaVisual": {
      "success": true,
      "idea": {},
      "error": {
        "message": "string",
        "code": "string",
        "contextInfo": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    }
  }
}

Response body

NameTypeRequiredDescription
dataobjectoptional
data.generateIdeaVisualobjectoptional
data.generateIdeaVisual.successbooleanoptional
data.generateIdeaVisual.ideaobjectoptionalThe updated post idea (see Post idea for the full shape).
data.generateIdeaVisual.errorobjectoptional
data.generateIdeaVisual.error.messagestringoptional
data.generateIdeaVisual.error.codestringoptional
data.generateIdeaVisual.error.contextInfoarray of objectoptional
data.generateIdeaVisual.error.contextInfo[].keystringoptional
data.generateIdeaVisual.error.contextInfo[].valuestringoptional