DocumentaçãoReferência da API
Concorrentes
Os concorrentes de um site, a análise e os backlinks 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 concorrentes | GET /sites/{siteId}/competitors | Grátis |
| Adicionar um concorrente | POST /sites/{siteId}/competitors | Grátis |
| Excluir um concorrente | DELETE /sites/{siteId}/competitors/{competitorId} | Grátis |
| Analisar um concorrente | POST /sites/{siteId}/competitors/{competitorId}/profile | Cobrado |
| Obter os backlinks de um concorrente | GET /sites/{siteId}/competitors/{competitorId}/backlinks | Cobrado |
Listar os concorrentes
/sites/{siteId}/competitorsGrátisOs concorrentes do site, com o perfil de cada um depois de analisado.
Ferramenta MCP list_competitors
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/competitors \
-H "Authorization: Bearer sk_live_…"{
"data": [
{
"id": "01a15ea4-c1e0-7285-bdde-d36e70d2d1b9",
"url": "https://comp1.example.com",
"name": "Concurrent Un",
"source": "auto",
"profiled_at": "2026-10-21T13:26:58.000Z",
"metrics": {
"traffic": 5200,
"keywords": 400,
"overlap": 40,
"reason": "Mêmes mots-clés à Lyon."
},
"profile": {
"summary": "Concurrent Un accompagne les PME.",
"positioning": "Agence généraliste.",
"topics": [
"SEO",
"SEA"
],
"strengths": [
"Notoriété"
],
"tech": [
"wordpress"
],
"pageCount": 24
}
},
{
"id": "01a15ea4-c1e0-7042-931d-3fa2cb1f4ffc",
"url": "https://comp2.example.com",
"name": "Concurrent Deux",
"source": "auto",
"profiled_at": "2026-10-21T13:26:58.000Z",
"metrics": {
"traffic": 4200,
"keywords": 350,
"overlap": 30,
"reason": "Mêmes mots-clés à Lyon."
},
"profile": {
"summary": "Concurrent Deux accompagne les PME.",
"positioning": "Agence généraliste.",
"topics": [
"SEO",
"SEA"
],
"strengths": [
"Notoriété"
],
"tech": [
"wordpress"
],
"pageCount": 24
}
}
]
}Adicionar um concorrente
/sites/{siteId}/competitorsGrátisAdiciona um concorrente e, se você quiser, analisa o perfil dele (cobrado).
- Responde com o id dele e
analyzing: false quando nenhuma análise foi iniciada (nenhuma foi pedida, ou não há créditos; o concorrente é salvo do mesmo jeito).
Ferramenta MCP add_competitor
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
urlobrigatório | string | O endereço do concorrente.1–500 caracteres |
nameopcional | string | até 255 caracteres |
auto_analyzeopcional | boolean | Analisa o perfil em segundo plano (cobrado). Ignorado sem créditos. |
curl -X POST https://app.semchat.io/api/v1/sites/{siteId}/competitors \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'Responde 201 com { "data": … }.
Excluir um concorrente
/sites/{siteId}/competitors/{competitorId}GrátisRemove um concorrente da lista do site.
Ferramenta MCP delete_competitor
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
competitorIdno caminho | string | O id dele. |
curl -X DELETE https://app.semchat.io/api/v1/sites/{siteId}/competitors/{competitorId} \
-H "Authorization: Bearer sk_live_…"Responde 204 com { "data": … }.
Analisar um concorrente
/sites/{siteId}/competitors/{competitorId}/profileCobradoAnalisa um concorrente (um rastreamento rápido do site dele e um resumo feito por IA: o que ele faz, o posicionamento, os temas, os pontos fortes, o que falta nele em relação ao seu site) e salva tudo no concorrente.
- Cobrado como a mesma análise no aplicativo (uma chamada de IA). 402 INSUFFICIENT_TOKENS sem créditos.
- Sem background, espera o perfil (até alguns minutos) e responde com o concorrente e o perfil dele.
Ferramenta MCP profile_competitor
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
competitorIdno caminho | string | O id dele. |
backgroundopcional | boolean | Responde na hora (202, status analyzing) e salva o perfil quando ele chegar: leia list_competitors para obtê-lo. |
localeopcional | string | O idioma em que o perfil é escrito (fr, en, es, de, pt, it). Padrão: o de quem criou a chave.2–5 caracteres |
curl -X POST https://app.semchat.io/api/v1/sites/{siteId}/competitors/{competitorId}/profile \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"background": true}'Responde 200 com { "data": … }.
Obter os backlinks de um concorrente
/sites/{siteId}/competitors/{competitorId}/backlinksCobradoOs números de backlinks de um concorrente: rank (0–100), domínios de referência, backlinks, pontuação de spam.
- Grátis quando o perfil de backlinks salvo do site (get_backlinks) já cobre este concorrente; senão, uma chamada de dados cobrada, como no aplicativo.
- 402 INSUFFICIENT_TOKENS sem créditos quando uma chamada cobrada seria necessária.
Ferramenta MCP get_competitor_backlinks
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
competitorIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/competitors/{competitorId}/backlinks \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Não encontrou a resposta? Fale com a gente.

