Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão links.edit; uma chave sem ela é recusada com 403, e não 404.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/ai/recipes/{recipeId}/run \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
**Returns as soon as the run is recorded — it does not wait for the article.** Writing takes longer than an HTTP request may live: the dashboard aborts at 20s and the engine's own worker timeout is 30s, so a synchronous run was killed mid-call every time. The response carries a run whose `state` is `queued`; poll `GET /v1/ai/recipes/{recipeId}/runs` until it reaches `succeeded`, `partial` or `failed`. A queued run normally starts within two minutes. The work then happens on the customer's own key when they have one, on Zinn® AI credits otherwise — **one meter either way** (owner directive D4). What happens after the drafts exist is the recipe's `publish_mode`, which defaults to `draft`: nothing is scheduled or published unless the customer turned that on for that recipe. A `422` means nothing was queued and nothing was charged — funding is checked before the run is recorded, so an unaffordable run is refused here rather than failing later. Requires `links.edit`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
recipeId (path) | Uuid | Sim | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
recipe_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
trigger | string<manual, schedule> | Sim | — |
state | string<queued, running, succeeded, partial, failed> | Sim | ⛔ `partial` is a real state, not a rounding of failure: some posts were written and a later step failed. Telling the customer the run failed would make them run it again and pay… |
started_at | object | Não | — |
finished_at | object | Não | — |
posts_created | integer | Não | — |
post_ids | string[] | Não | — |
anchor_warnings | string[] | Não | Anchors the model did not place verbatim, aggregated across the run so the customer sees it once instead of opening ten drafts to find out. |
funding | string | Não | Who paid. `byo` means the article was written on the customer's own key and we charged nothing. |
model | string | Não | — |
workflow_id | string | Não | The durable execution, when there is one. |
error_code | string | Não | A stable machine code for what went wrong, empty on a clean run. ⛔ Set on a `partial` run as well as a `failed` one — `no_target_sites` (the recipe schedules but names no site)… |
error | string | Não | The engine's own English sentence, for a code a client does not recognise. ⛔ A client SHOULD render its own translated copy from `error_code` and fall back to this only for an u… |
created_at | string | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429