Introdução
Cada endpoint e evento da API pública, com parâmetros, corpo, respostas e erros.
A referência sai do documento OpenAPI 3.1 gerado das mesmas operações que a API e o servidor MCP executam. Baixe em /openapi.json para gerar um cliente.
https://app.postline.com.br/api/v1Toda lista aceita limit e cursor e responde { data, nextCursor }. Todo erro é { error: { code, message, param?, requestId } }, com o id da requisição também no cabeçalho x-request-id. Os campos são camelCase.
Endpoints
Cada endpoint tem uma ferramenta MCP com o mesmo nome e as mesmas regras.
| Método | Caminho | Permissão | Ferramenta MCP |
|---|---|---|---|
GET | /projects | projects:read | list_projects |
GET | /projects/{id}/brand | projects:read | get_brand |
GET | /articles | articles:read | list_articles |
POST | /articles | articles:write | create_article |
GET | /articles/{id} | articles:read | get_article |
PATCH | /articles/{id} | articles:write | update_article |
DELETE | /articles/{id} | articles:write | delete_article |
POST | /articles/{id}/submit | articles:write | submit_article |
POST | /articles/{id}/approve | articles:approve | approve_article |
POST | /articles/{id}/schedule | articles:write | schedule_article |
GET | /articles/{id}/comments | comments:read | list_comments |
POST | /articles/{id}/comments | comments:write | create_comment |
POST | /comments/{id}/resolve | comments:write | resolve_comment |
GET | /posts | posts:read | list_posts |
POST | /posts | posts:write | create_post |
POST | /posts/generate | posts:write | generate_post |
GET | /posts/{id} | posts:read | get_post |
PATCH | /posts/{id} | posts:write | update_post |
DELETE | /posts/{id} | posts:write | delete_post |
POST | /posts/{id}/destinations/{destination}/schedule | posts:write | schedule_post |
POST | /posts/{id}/render | posts:write | render_post |
POST | /posts/{id}/images | posts:write | generate_post_images |
POST | /images | images:write | upload_image |
DELETE | /images/{id} | images:write | delete_image |
GET | /images/{id} | — | — |
GET | /topics | calendar:read | list_topics |
POST | /topics/suggest | articles:write | suggest_topics |
GET | /calendar | calendar:read | get_calendar |
GET | /results | results:read | get_results |
GET /articles e GET /articles/{id} também respondem ao token de leitura do site (pl_read_…), só com os artigos publicados do projeto.
Eventos
Os eventos da organização vão para os endpoints de Webhooks; os do site, para o /api/postline/webhook do seu site Next.js. Todos usam o mesmo envelope Standard Webhooks.
| Evento | Para | Quando |
|---|---|---|
article.published | Organização | Um artigo foi ao ar no destino principal do projeto. |
article.review_requested | Organização | Um artigo está pronto para revisão. |
article.scheduled | Organização | Um artigo foi agendado, ou a data mudou. |
post.scheduled | Organização | Um post social foi agendado numa rede. |
post.published | Organização | Um post social saiu numa rede. |
delivery.failed | Organização | Uma publicação não foi ao ar. |
credits.low | Organização | O consumo de créditos do ciclo passou de um limite. |
ping | Organização | Um evento de teste. |
article.published | Site | Um artigo foi ao ar: o site o mostra. |
article.updated | Site | Um artigo publicado tem uma nova revisão. |
article.unpublished | Site | Um artigo saiu do site. |
article.deleted | Site | Um artigo foi excluído. |
article.slug_changed | Site | Um artigo publicado mudou de slug. |
Os tokens e as permissões estão em Autenticação; os códigos de erro e o limite de 60 chamadas por minuto, em Erros e limites.