seo-connect
POST /v1/seo-connection/images
Draw one image from a description on Zinn® credits. Spends credits.
Authentication
Send an API key as a bearer token. The endpoint checks sites.create; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/seo-connection/images \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "prompt": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Needs the seo.spend scope (stage X1C, zs-720). The image is drawn in the background by the cheapest image model Zinn® has measured and is metered on the one meter only when it arrived; read it with getSeoImage. Refused before anything is spent: no description (422), not enough credit for one image, the site's monthly limit or an account not in good standing (403). A run that could not be started costs nothing (503).
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
prompt | string | Yes | — |
shape | string<landscape, square, portrait> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | string<originality, image> | Yes | — |
status | string<queued, complete, partial, failed> | Yes | — |
units | integer | Yes | — |
price_micros | integer | Yes | — |
charged_micros | integer | Yes | — |
refunded_micros | integer | Yes | — |
currency | string | Yes | — |
result | object | Yes | Originality: phrases [{phrase, answered, copies [{url, domain, title, snippet}], own}], answered, found_elsewhere, original_percent. Image: mime. |
images | object[] | No | — |
error | string | Yes | — |
created_at | string | Yes | — |
finished_at | object | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503