DocumentaçãoReferência da API
Sites
Os sites, a análise, a saúde e a acessibilidade deles.
Cada operação abaixo também é uma ferramenta MCP, com o mesmo nome. As operações marcadas Grátis não custam nada; as marcadas Cobrado usam os créditos do espaço de trabalho, como no aplicativo (Quanto custa).
| Operação | Chamada | |
|---|---|---|
| Listar os sites | GET /sites | Grátis |
| Criar um site | POST /sites | Grátis |
| Obter um site | GET /sites/{siteId} | Grátis |
| Analisar um site | POST /sites/{siteId}/analyze | Cobrado |
| Listar os conectores de um site | GET /sites/{siteId}/connectors | Grátis |
| Atualizar um site | PATCH /sites/{siteId} | Grátis |
| Excluir um site | DELETE /sites/{siteId} | Grátis |
| Marcar um site como favorito | PATCH /sites/{siteId}/favorite | Grátis |
| Obter a saúde de um site | GET /sites/{siteId}/health | Grátis |
| Obter a acessibilidade de um site | GET /sites/{siteId}/accessibility | Grátis |
| Obter uma regra de acessibilidade | GET /sites/{siteId}/accessibility/{ruleId} | Grátis |
Listar os sites
/sitesGrátisTodos os sites do espaço de trabalho.
Ferramenta MCP list_sites
curl https://app.semchat.io/api/v1/sites \
-H "Authorization: Bearer sk_live_…"{
"data": [
{
"id": "01a08133-4de0-7b5b-87f5-c4c169f01517",
"name": "Alpha Conseil",
"site_url": "https://alpha.example.com",
"analysis_status": "ready",
"created_at": "2026-09-08T13:26:58.000Z"
},
{
"id": "01a0ce72-b1e0-738d-9205-34630681ef77",
"name": "Beta Shop",
"site_url": "https://beta.example.com",
"analysis_status": "idle",
"created_at": "2026-09-23T13:26:58.000Z"
}
]
}Criar um site
/sitesGrátisCria um site e, se você quiser, inicia a análise dele.
Ferramenta MCP create_site
| Argumento | Tipo | Descrição |
|---|---|---|
nameobrigatório | string | O nome do site.1–255 caracteres |
site_urlopcional | string | O endereço dele. Necessário para uma análise.até 500 caracteres |
descriptionopcional | string | até 2000 caracteres |
auto_analyzeopcional | boolean | Inicia a análise na hora (cobrada). Ignorado sem créditos: needs_credits fica então true. |
curl -X POST https://app.semchat.io/api/v1/sites \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"name": "…"}'{
"data": {
"id": "01a168f1-9d83-7253-a7ec-af716d6279e1",
"analysis_status": "idle",
"needs_credits": false
}
}Obter um site
/sites/{siteId}GrátisUm site, com tudo o que a última análise dele salvou (visão geral, saúde, acessibilidade, palavras-chave…).
Ferramenta MCP get_site
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId} \
-H "Authorization: Bearer sk_live_…"{
"data": {
"id": "01a08133-4de0-7b5b-87f5-c4c169f01517",
"name": "Alpha Conseil",
"site_url": "https://alpha.example.com",
"description": null,
"analysis_status": "ready",
"analysis_stage": null,
"last_analyzed_at": "2026-10-21T13:26:58.000Z",
"site_context": {
"description": "Alpha Conseil, agence de référencement naturel pour les PME lyonnaises.",
"platform": "inconnu",
"language": "fr",
"country": "FR",
"positioning": "Le SEO durable et expliqué sans jargon pour les PME.",
"primaryTopics": [
"audit SEO",
"contenus"
],
"targetKeywords": [
"…",
"…"
],
"kpis": {
"organic_traffic_estimate": 1840,
"keywords_count": 312,
"authority_score": null
},
"suggestedInstructions": "Parle simplement à des dirigeants de PME non techniques.",
"analyzedAt": "2026-10-21T13:26:58.272Z",
"contentLang": "fr",
"health": {
"score": 72,
"label": "good",
"pagesChecked": 6,
"items": [
"…",
"…"
],
"checkedAt": "2026-10-21T13:26:58.272Z"
},
"accessibility": {
"score": 78,
"totalIssues": 4,
"byLevel": "…",
"findings": [
"…",
"…"
],
"checkedAt": "2026-10-21T13:26:58.272Z"
},
"pageVisibility": {
"checkedPages": 6,
"indexable": 6,
"noindex": 0,
"visibleButShouldnt": "…",
"hiddenButShould": "…",
"checkedAt": "2026-10-21T13:26:58.272Z"
},
"actionPlan": {
"scorecard": "…",
"focus": "…",
"priorityOrder": [
"content",
"backlinks"
],
"summary": "Un site sain qui manque de contenus et de liens.",
"generatedAt": "2026-10-21T13:26:58.272Z"
}
},
"instructions": null,
"writing_style": null,
"technologies": [],
"favorite": false,
"created_at": "2026-09-08T13:26:58.000Z"
}
}Analisar um site
/sites/{siteId}/analyzeCobradoExecuta (ou executa de novo) a análise completa do site: rastreamento, saúde técnica, concorrentes, palavras-chave, plano de ação.
- Roda em segundo plano (alguns minutos): leia get_site até analysis_status ser ready ou error.
- Cobrada exatamente como uma análise iniciada no aplicativo. 402 INSUFFICIENT_TOKENS sem créditos.
- Uma nova análise mantém o plano de ação existente e acrescenta o que é novo.
Ferramenta MCP analyze_site
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl -X POST https://app.semchat.io/api/v1/sites/{siteId}/analyze \
-H "Authorization: Bearer sk_live_…"Responde 202 com { "data": … }.
Listar os conectores de um site
/sites/{siteId}/connectorsGrátisAs ferramentas conectadas a este site.
Ferramenta MCP list_site_connectors
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/connectors \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Atualizar um site
/sites/{siteId}GrátisEdita as configurações do site: nome, endereço, descrição, instruções, estilo de escrita, tecnologias.
- Só os campos enviados mudam. Responde com o site e as configurações dele.
- Mudar o endereço não refaz a análise: chame analyze_site para isso.
Ferramenta MCP update_site
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
nameopcional | string | O nome do site (não pode ficar em branco).1–255 caracteres |
site_urlopcional | string | null | O endereço dele. Em branco ou null limpa o campo. |
descriptionopcional | string | null | Em branco ou null limpa o campo. |
instructionsopcional | string | null | O que o assistente leva em conta para este site. Em branco ou null limpa o campo. |
writing_styleopcional | string | null | A voz dos artigos escritos para o site; null limpa o campo. |
technologiesopcional | array | As tecnologias que o site usa (as chaves delas); [] limpa a lista. |
curl -X PATCH https://app.semchat.io/api/v1/sites/{siteId} \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"name": "…"}'Responde 200 com { "data": … }.
Excluir um site
/sites/{siteId}GrátisExclui o site.
- Exclusão lógica, como no aplicativo: o site sai das listas e os endpoints dele respondem 404. Nada mais muda: as conversas, os documentos e os dados salvos dele continuam.
Ferramenta MCP delete_site
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl -X DELETE https://app.semchat.io/api/v1/sites/{siteId} \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Marcar um site como favorito
/sites/{siteId}/favoriteGrátisMarca ou desmarca o site com estrela.
- Marcar com estrela não conta como atividade: o site mantém a posição na ordenação “Atividade”.
Ferramenta MCP set_site_favorite
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
favoriteobrigatório | boolean | true marca o site com estrela, false desmarca. |
curl -X PATCH https://app.semchat.io/api/v1/sites/{siteId}/favorite \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"favorite": true}'Responde 200 com { "data": … }.
Obter a saúde de um site
/sites/{siteId}/healthGrátisA saúde técnica do site: a pontuação e os problemas da última análise, o histórico da pontuação e quais contagens de problemas mudaram desde a análise anterior.
Ferramenta MCP get_site_health
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/health \
-H "Authorization: Bearer sk_live_…"{
"data": {
"health": {
"score": 72,
"label": "good",
"pages_checked": 6,
"items": [
"…",
"…"
],
"checked_at": "2026-10-21T13:26:58.272Z"
},
"history": [
{
"score": 61,
"label": "fair",
"pages_checked": 6,
"analyzed_at": "2026-09-23T13:26:58.000Z"
},
{
"score": 72,
"label": "good",
"pages_checked": 6,
"analyzed_at": "2026-10-21T13:26:58.000Z"
}
],
"changes": [
{
"key": "noDescription",
"before": 3,
"after": 1
},
{
"key": "thin",
"before": 3,
"after": 2
}
]
}
}Obter a acessibilidade de um site
/sites/{siteId}/accessibilityGrátisA acessibilidade do site (WCAG 2.1 A e AA): a pontuação e os resultados por regra da última análise, e o histórico da pontuação.
Ferramenta MCP get_site_accessibility
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/accessibility \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Obter uma regra de acessibilidade
/sites/{siteId}/accessibility/{ruleId}GrátisTodas as páginas em que uma regra de acessibilidade falha (o rule_id de um resultado), com os elementos que falham.
- pages tem um limite; page_count é o número exato de páginas afetadas.
Ferramenta MCP get_accessibility_rule
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
ruleIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/accessibility/{ruleId} \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Não encontrou a resposta? Fale com a gente.

