seo-connect

GET /v1/seo-connection/images/{runId}

One image run; when complete, the picture itself.

All seo-connect endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The endpoint checks sites.view; 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 GET https://api.zinndigital.com/v1/seo-connection/images/{runId} \
  -H "Authorization: Bearer zdk_live_…"

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

A complete run carries images — the picture as base64 with its type — for the plugin to save to the site's media library. A failed run says why in error and charged nothing. Reading costs nothing.

Parameters

NameTypeRequiredWhat it is
runId (path)UuidYes—

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
kindstring<originality, image>Yes—
statusstring<queued, complete, partial, failed>Yes—
unitsintegerYes—
price_microsintegerYes—
charged_microsintegerYes—
refunded_microsintegerYes—
currencystringYes—
resultobjectYesOriginality: phrases [{phrase, answered, copies [{url, domain, title, snippet}], own}], answered, found_elsewhere, original_percent. Image: mime.
imagesobject[]No—
errorstringYes—
created_atstringYes—
finished_atobjectNo—

Errors this endpoint can return

401 · 404