DocumentaçãoReferência da API

Palavras-chave

As palavras-chave de um site: listar, adicionar, alterar e excluir.

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 as palavras-chaveGET /sites/{siteId}/keywordsGrátis
Adicionar uma palavra-chavePOST /sites/{siteId}/keywordsGrátis
Atualizar uma palavra-chavePATCH /sites/{siteId}/keywords/{keywordId}Grátis
Excluir uma palavra-chaveDELETE /sites/{siteId}/keywords/{keywordId}Grátis

Listar as palavras-chave

GET/sites/{siteId}/keywordsGrátis

As palavras-chave alvo do site, vindas da análise ou adicionadas à mão, com volume, dificuldade e posição atual.

  • O texto volta como está salvo, no idioma em que foi escrito (source_lang; null = o idioma do conteúdo do site). O aplicativo traduz o texto na exibição; a API não.

Ferramenta MCP list_keywords

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
Requisição
curl https://app.semchat.io/api/v1/sites/{siteId}/keywords \
  -H "Authorization: Bearer sk_live_…"
Resposta · 200
{
  "data": [
    {
      "id": "01a15ea4-c1e0-7957-b667-9b025ed3641e",
      "keyword": "agence seo lyon",
      "volume": 1900,
      "difficulty": 45,
      "cpc": 1.8,
      "competition": 40,
      "current_position": 4,
      "traffic": 475,
      "url": "https://alpha.example.com/services",
      "intent": "commercial",
      "priority": "high",
      "rationale": "Opportunité sur « agence seo lyon ».",
      "source": "auto",
      "source_lang": "fr",
      "created_at": "2026-10-21T13:26:58.000Z"
    },
    {
      "id": "01a15ea4-c1e0-7e93-9a50-38742b693311",
      "keyword": "audit seo",
      "volume": 2400,
      "difficulty": 60,
      "cpc": 1.8,
      "competition": 40,
      "current_position": 12,
      "traffic": 200,
      "url": "https://alpha.example.com/services",
      "intent": "commercial",
      "priority": "high",
      "rationale": "Opportunité sur « audit seo ».",
      "source": "auto",
      "source_lang": "fr",
      "created_at": "2026-10-21T13:26:58.000Z"
    }
  ]
}

Adicionar uma palavra-chave

POST/sites/{siteId}/keywordsGrátis

Adiciona uma palavra-chave alvo ao site.

  • Salva como foi enviada, como palavra-chave manual: nenhum dado da palavra-chave é buscado (nada é cobrado). Responde com a palavra-chave.

Ferramenta MCP add_keyword

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
keywordobrigatóriostringA palavra-chave.1–255 caracteres
volumeopcionalstring | nullO volume de busca mensal dela, se você souber.
difficultyopcionalstring | nullA dificuldade dela, 0–100, se você souber.
intentopcionalstring | nullinformational, commercial, transactional ou navigational.
priorityopcionalstringhigh, medium (padrão) ou low.high | medium | low
rationaleopcionalstring | nullPor que mirar nela.
source_langopcionalstringO idioma em que o texto está escrito (por exemplo "fr", "en"). Se omitido: o idioma do conteúdo do site.2–5 caracteres
Requisição
curl -X POST https://app.semchat.io/api/v1/sites/{siteId}/keywords \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"keyword": "…"}'

Responde 201 com { "data": … }.

Atualizar uma palavra-chave

PATCH/sites/{siteId}/keywords/{keywordId}Grátis

Altera uma palavra-chave alvo: a palavra-chave, os números dela, a intenção, a prioridade ou a justificativa.

  • Responde com a palavra-chave como ela ficou.

Ferramenta MCP update_keyword

ArgumentoTipoDescrição
siteIdno caminhostringO id dele.
keywordIdno caminhostringO id dele.
keywordopcionalstring1–255 caracteres
volumeopcionalstring | null
difficultyopcionalstring | null
intentopcionalstring | null
priorityopcionalstringhigh | medium | low
rationaleopcionalstring | null
source_langopcionalstringO idioma da nova palavra-chave / da nova justificativa. Ignorado quando nenhuma das duas muda.2–5 caracteres
Requisição
curl -X PATCH https://app.semchat.io/api/v1/sites/{siteId}/keywords/{keywordId} \
  -H "Authorization: Bearer sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{"keyword": "…"}'

Responde 200 com { "data": … }.

Excluir uma palavra-chave

DELETE/sites/{siteId}/keywords/{keywordId}Grátis

Remove uma palavra-chave alvo do site.

Ferramenta MCP delete_keyword

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

Responde 204 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