GET
/api/v1/me
A conta a que a chave pertence, e o nome e prefixo da própria chave. Útil sobretudo para uma coisa: dizer-lhe que a chave neste ambiente é a chave que pensa que é.
Exemplo
curl https://seonis.ai/api/v1/me \
-H "Authorization: Bearer $SEONIS_API_KEY"
GET
/api/v1/sites
Todos os sites da conta. O id é o que a lista de artigos usa para filtrar, e o domínio está lá para que um script de build possa corresponder a algo que já conhece em vez de transportar um id.
Exemplo
curl https://seonis.ai/api/v1/sites \
-H "Authorization: Bearer $SEONIS_API_KEY"
{
"sites": [
{
"id": 5,
"name": "Peppervale",
"domain": "peppervale.co.uk",
"url": "https://peppervale.co.uk",
"language": "en",
"country": "GB",
"market": "en-GB",
"status": "active",
"articles_published": 34,
"created_at": "2026-06-02T11:04:19+00:00"
}
]
}
GET
/api/v1/articles
Uma página de artigos, com a alteração mais recente primeiro, sem o texto. Ordenada pela última alteração de cada artigo e não pela data em que foi escrito, o que torna updated_since útil: um artigo que já está publicado pode ser editado mais tarde, quando uma ligação é inserida nele ou removida.
Parâmetros de consulta
| Nome |
O que faz |
| site_id |
Um site, de /sites. Um id que não está na sua conta responde 404. |
| status |
Um de draft, qa, needs_repair, review, ready, published, failed. Qualquer outra coisa dá 422 em vez de uma página vazia. "ready" é o que uma build quer: escrito, verificado e ainda não publicado em lado nenhum. |
| updated_since |
ISO 8601, como 2026-09-06T00:00:00Z. Guarde o timestamp da sua última execução e volte a passá-lo na seguinte. |
| per_page |
Até 100. O valor predefinido é 25. |
| page |
A partir de 1. meta.has_more indica se deve pedir outra. |
Exemplo
curl -G https://seonis.ai/api/v1/articles \
-H "Authorization: Bearer $SEONIS_API_KEY" \
-d site_id=5 \
-d status=ready \
-d updated_since=2026-09-01T00:00:00Z \
-d per_page=50
{
"articles": [
{
"id": 918,
"site_id": 5,
"language": "en",
"status": "ready",
"title": "How to choose a pepper grinder",
"slug": "how-to-choose-a-pepper-grinder",
"meta_title": "How to choose a pepper grinder | Peppervale",
"meta_description": "Burr or blade, ceramic or steel: what matters in a grinder.",
"meta_keywords": ["pepper grinder", "burr grinder"],
"tags": ["Kitchen"],
"excerpt": "A burr grinder gives an even grind; a blade one does not.",
"key_takeaways": ["A burr grinder gives an even grind; a blade one does not."],
"faq": [{ "question": "Ceramic or steel?", "answer": "Steel for pepper, ceramic for salt." }],
"hero_image": { "url": "https://seonis.ai/storage/images/5/918.jpg", "alt": "A pepper grinder" },
"infographic_url": null,
"word_count": 1812,
"published_url": null,
"published_at": null,
"updated_at": "2026-09-06T06:31:12+00:00",
"created_at": "2026-09-05T02:14:55+00:00",
"quality": { "seo_score": 88, "language_score": 96, "language_findings": [] }
}
],
"meta": { "page": 1, "per_page": 50, "total": 1, "last_page": 1, "has_more": false }
}
GET
/api/v1/articles/{id}
Um artigo, com tudo o que a lista deixa de fora: content_markdown, content_html, as FAQ como schema.org JSON-LD prontas a inserir na página, e quaisquer ligações de troca que o artigo tenha.
Os nomes dos campos são os que o nosso webhook envia, de propósito. Se já tiver um recetor de webhook, o mesmo analisador lê isto.
Exemplo
curl https://seonis.ai/api/v1/articles/918 \
-H "Authorization: Bearer $SEONIS_API_KEY"
{
"article": {
"id": 918,
"site_id": 5,
"language": "en",
"status": "ready",
"title": "How to choose a pepper grinder",
"slug": "how-to-choose-a-pepper-grinder",
"meta_description": "Burr or blade, ceramic or steel: what matters in a grinder.",
"content_markdown": "Grinders differ.\n\n## Burr or blade\n\nA **burr** grinder ...",
"content_html": "<p>Grinders differ.</p>\n<h2>Burr or blade</h2> ...",
"faq_schema": { "@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [] },
"hero_image": { "url": "https://seonis.ai/storage/images/5/918.jpg", "alt": "A pepper grinder" },
"word_count": 1812,
"published_url": null,
"updated_at": "2026-09-06T06:31:12+00:00",
"quality": { "seo_score": 88, "language_score": 96, "language_findings": [] },
"exchange_links": []
}
}
POST
/api/v1/articles/{id}/published
Publica o artigo; é aqui que nos indica o endereço. É o único endpoint que altera alguma coisa.
Faz exatamente o mesmo que uma entrega feita por nós: o artigo fica marcado como publicado, conta para o seu limite mensal, o item do plano é fechado, quaisquer ligações de troca nele recebem o endereço que o verificador estava à espera, e a sua Página do Facebook é informada se tiver ligado uma. Sem esta chamada o artigo fica pronto para sempre e nada disso acontece.
Exemplo
curl -X POST https://seonis.ai/api/v1/articles/918/published \
-H "Authorization: Bearer $SEONIS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url": "https://peppervale.co.uk/blog/how-to-choose-a-pepper-grinder"}'
Respostas
| 200 |
Registado. O artigo volta com o novo estado, published_at e published_url. |
| 422 |
Falta o url ou não é um endereço http:// ou https:// completo. |
| 409 |
O artigo não está pronto para ser publicado, ou já está registado como publicado. O artigo volta com a recusa, para que possa ver qual é o caso. |