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ção | Chamada | |
|---|---|---|
| Listar as palavras-chave | GET /sites/{siteId}/keywords | Grátis |
| Adicionar uma palavra-chave | POST /sites/{siteId}/keywords | Grátis |
| Atualizar uma palavra-chave | PATCH /sites/{siteId}/keywords/{keywordId} | Grátis |
| Excluir uma palavra-chave | DELETE /sites/{siteId}/keywords/{keywordId} | Grátis |
Listar as palavras-chave
/sites/{siteId}/keywordsGrátisAs 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
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/keywords \
-H "Authorization: Bearer sk_live_…"{
"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
/sites/{siteId}/keywordsGrátisAdiciona 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
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
keywordobrigatório | string | A palavra-chave.1–255 caracteres |
volumeopcional | string | null | O volume de busca mensal dela, se você souber. |
difficultyopcional | string | null | A dificuldade dela, 0–100, se você souber. |
intentopcional | string | null | informational, commercial, transactional ou navigational. |
priorityopcional | string | high, medium (padrão) ou low.high | medium | low |
rationaleopcional | string | null | Por que mirar nela. |
source_langopcional | string | O idioma em que o texto está escrito (por exemplo "fr", "en"). Se omitido: o idioma do conteúdo do site.2–5 caracteres |
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
/sites/{siteId}/keywords/{keywordId}GrátisAltera 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
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
keywordIdno caminho | string | O id dele. |
keywordopcional | string | 1–255 caracteres |
volumeopcional | string | null | |
difficultyopcional | string | null | |
intentopcional | string | null | |
priorityopcional | string | high | medium | low |
rationaleopcional | string | null | |
source_langopcional | string | O idioma da nova palavra-chave / da nova justificativa. Ignorado quando nenhuma das duas muda.2–5 caracteres |
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
/sites/{siteId}/keywords/{keywordId}GrátisRemove uma palavra-chave alvo do site.
Ferramenta MCP delete_keyword
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
keywordIdno caminho | string | O id dele. |
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.

