---
title: "Analyze reference image"
method: GET
path: "/local-post-ideas/analyze-reference-image"
tags: ["Local Post Ideas"]
---

# Analyze reference image

`GET /local-post-ideas/analyze-reference-image`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/local-post-ideas/analyze-reference-image`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/local-post-ideas/analyze-reference-image/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Query parameters

- `imageUrl` string, required
- `category` string

## Headers

- `Synup-Version` string, required
- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `analyzeReferenceImage` ReferenceImageAnalysis
      - `description` string: Textual description of the analyzed image.

## Other responses

- `401`: Unauthorized - Invalid or missing API key

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)