GETapi.synup.com/api/v4/local-post-ideas/analyze-reference-image

Analyze reference image

Analyzes a reference image at the given URL and returns a textual description that can be used to ground post-idea generation. Optionally pass a category hint to focus the analysis.

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

Parameters

Query

Name	Type	Required	Description
`imageUrl`	string	required	URL of the image to analyze.
`category`	string	optional	Optional category hint to focus the analysis.

Headers

Name	Type	Required	Description
`Synup-Version`	string	required	API version date (YYYY-MM-DD).

Request

curl -X GET 'https://api.synup.com/api/v4/local-post-ideas/analyze-reference-image?imageUrl=&category=' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const res = await fetch('https://api.synup.com/api/v4/local-post-ideas/analyze-reference-image?imageUrl=&category=', {
  method: 'GET',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
});
const data = await res.json();

import requests
res = requests.get(
    "https://api.synup.com/api/v4/local-post-ideas/analyze-reference-image?imageUrl=&category=",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = res.json()

req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/local-post-ideas/analyze-reference-image?imageUrl=&category=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`401`	Unauthorized - Invalid or missing API key

Example response (generated from the schema)

{
  "data": {
    "analyzeReferenceImage": {
      "description": "string"
    }
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.analyzeReferenceImage`	object	optional
`data.analyzeReferenceImage.description`	string	optional	Textual description of the analyzed image.