ai

GET /v1/ai/site-publications/{publicationId}

How far a publication has got.

All ai endpoints

All developer docs →

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; 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/ai/site-publications/{publicationId} \
  -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

step is the stage currently running and steps is the full ordered list, so a client renders progress without hardcoding the workflow's shape. status held is neither success nor failure: the generated files are safe in the repository and nothing on the site was overwritten, because the destination held files we did not put there. The customer chooses which version wins on the site's sync screen. Do not retry a held publication automatically. Requires sites.view.

Parameters

NameTypeRequiredWhat it is
publicationId (path)UuidYes—

Response

NameTypeRequiredWhat it is
publicationSiteMakerPublicationYes—

Errors this endpoint can return

401 · 403 · 404 · 429