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çãoChamada
Listar os sitesGET /sitesGrátis
Criar um sitePOST /sitesGrátis
Obter um siteGET /sites/{siteId}Grátis
Analisar um sitePOST /sites/{siteId}/analyzeCobrado
Listar os conectores de um siteGET /sites/{siteId}/connectorsGrátis
Atualizar um sitePATCH /sites/{siteId}Grátis
Excluir um siteDELETE /sites/{siteId}Grátis
Marcar um site como favoritoPATCH /sites/{siteId}/favoriteGrátis
Obter a saúde de um siteGET /sites/{siteId}/healthGrátis
Obter a acessibilidade de um siteGET /sites/{siteId}/accessibilityGrátis
Obter uma regra de acessibilidadeGET /sites/{siteId}/accessibility/{ruleId}Grátis

Listar os sites

GET/sitesGrátis

Todos os sites do espaço de trabalho.

Ferramenta MCP list_sites

Requisição
curl https://app.semchat.io/api/v1/sites \
  -H "Authorization: Bearer sk_live_…"
Resposta · 200
{
  "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

POST/sitesGrátis

Cria um site e, se você quiser, inicia a análise dele.

Ferramenta MCP create_site

ArgumentoTipoDescrição
nameobrigatóriostringO nome do site.1–255 caracteres
site_urlopcionalstringO endereço dele. Necessário para uma análise.até 500 caracteres
descriptionopcionalstringaté 2000 caracteres
auto_analyzeopcionalbooleanInicia a análise na hora (cobrada). Ignorado sem créditos: needs_credits fica então true.
Requisição
curl -X POST https://app.semchat.io/api/v1/sites \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"name": "…"}'
Resposta · 201
{
  "data": {
    "id": "01a168f1-9d83-7253-a7ec-af716d6279e1",
    "analysis_status": "idle",
    "needs_credits": false
  }
}

Obter um site

GET/sites/{siteId}Grátis

Um site, com tudo o que a última análise dele salvou (visão geral, saúde, acessibilidade, palavras-chave…).

Ferramenta MCP get_site

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
curl https://app.semchat.io/api/v1/sites/{siteId} \
  -H "Authorization: Bearer sk_live_…"
Resposta · 200
{
  "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

POST/sites/{siteId}/analyzeCobrado

Executa (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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
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

GET/sites/{siteId}/connectorsGrátis

As ferramentas conectadas a este site.

Ferramenta MCP list_site_connectors

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
curl https://app.semchat.io/api/v1/sites/{siteId}/connectors \
  -H "Authorization: Bearer sk_live_…"

Responde 200 com { "data": … }.

Atualizar um site

PATCH/sites/{siteId}Grátis

Edita 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
nameopcionalstringO nome do site (não pode ficar em branco).1–255 caracteres
site_urlopcionalstring | nullO endereço dele. Em branco ou null limpa o campo.
descriptionopcionalstring | nullEm branco ou null limpa o campo.
instructionsopcionalstring | nullO que o assistente leva em conta para este site. Em branco ou null limpa o campo.
writing_styleopcionalstring | nullA voz dos artigos escritos para o site; null limpa o campo.
technologiesopcionalarrayAs tecnologias que o site usa (as chaves delas); [] limpa a lista.
Requisição
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

DELETE/sites/{siteId}Grátis

Exclui 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
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

PATCH/sites/{siteId}/favoriteGrátis

Marca 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
favoriteobrigatóriobooleantrue marca o site com estrela, false desmarca.
Requisição
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

GET/sites/{siteId}/healthGrátis

A 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
curl https://app.semchat.io/api/v1/sites/{siteId}/health \
  -H "Authorization: Bearer sk_live_…"
Resposta · 200
{
  "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

GET/sites/{siteId}/accessibilityGrátis

A 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
curl https://app.semchat.io/api/v1/sites/{siteId}/accessibility \
  -H "Authorization: Bearer sk_live_…"

Responde 200 com { "data": … }.

Obter uma regra de acessibilidade

GET/sites/{siteId}/accessibility/{ruleId}Grátis

Todas 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

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
ruleIdno caminhostringO id dele.
Requisição
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.

Pronto para fazer seu site decolar?

Faça sua primeira pergunta - o semchat responde com um plano de ação claro em segundos.

Grátis · sem cadastro · em 5 segundos