DocumentaçãoReferência da API
Espaço de trabalho
O espaço de trabalho, o uso, a busca, as competências, as preferências de ferramentas e os conectores.
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 | |
|---|---|---|
| Obter o espaço de trabalho | GET /workspace | Grátis |
| Obter o uso | GET /usage | Grátis |
| Listar as competências | GET /skills | Grátis |
| Listar os conectores | GET /connectors | Grátis |
| Buscar no espaço de trabalho | POST /search | Grátis |
| Atualizar o espaço de trabalho | PATCH /workspace | Grátis |
| Ativar ou desativar uma competência | PATCH /skills/{skillId} | Grátis |
| Listar as preferências de ferramentas | GET /workspace/tools | Grátis |
| Listar as preferências de ferramentas de um site | GET /sites/{siteId}/tools | Grátis |
| Definir uma preferência de ferramenta | PATCH /workspace/tools | Grátis |
| Desconectar um conector | DELETE /connectors/{provider} | Grátis |
| Desconectar um conector de um site | DELETE /sites/{siteId}/connectors/{provider} | Grátis |
Obter o espaço de trabalho
/workspaceGrátisO espaço de trabalho, o plano dele e quanto dos créditos do período já foi usado.
- Os créditos nunca aparecem como números brutos: só como porcentagens do período.
Ferramenta MCP get_workspace
curl https://app.semchat.io/api/v1/workspace \
-H "Authorization: Bearer sk_live_…"{
"data": {
"id": "01995d03-8ea0-79ee-8ee3-c2eed260b3bc",
"name": "Acme",
"plan": {
"id": "starter",
"name": "Starter",
"features": {
"gsc": true,
"market_data": true,
"agents": 11,
"backlinks": true,
"weekly_reports": true,
"ai_writer": true
}
},
"balance": {
"used_pct": 12.5,
"remaining_pct": 87.5,
"period_resets_at": "2026-11-12T13:26:58.000Z"
},
"settings": {
"description": null,
"custom_instructions": "Nous sommes une agence SEO lyonnaise.",
"company_name": null,
"company_website": null,
"company_siren": null,
"company_address": null
}
}
}Obter o uso
/usageGrátisO uso do período atual, em porcentagem, dividido por categoria.
Ferramenta MCP get_usage
curl https://app.semchat.io/api/v1/usage \
-H "Authorization: Bearer sk_live_…"{
"data": {
"period": "current",
"used_pct": 12.5,
"remaining_pct": 87.5,
"by_category_pct": {
"conversations": 2.5,
"seo_tools": 2.5,
"visuals": 2.5,
"documents": 2.5,
"site_analysis": 2.5
}
}
}Listar as competências
/skillsGrátisAs competências disponíveis para o chat do espaço de trabalho.
Ferramenta MCP list_skills
curl https://app.semchat.io/api/v1/skills \
-H "Authorization: Bearer sk_live_…"{
"data": [
{
"id": "cocon-semantique",
"name": "Topic cluster",
"when_to_use": "Quand l'utilisateur demande : cocon sémantique.",
"enabled": true
},
{
"id": "seo-audit",
"name": "SEO audit",
"when_to_use": "Quand l'utilisateur demande : audit seo.",
"enabled": true
}
]
}Listar os conectores
/connectorsGrátisAs ferramentas conectadas no nível do espaço de trabalho (Search Console, GA4, Slack, Notion…).
- A maioria das conexões é por site: veja list_site_connectors.
Ferramenta MCP list_connectors
curl https://app.semchat.io/api/v1/connectors \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Buscar no espaço de trabalho
/searchGrátisBusca as conversas, os sites, as tarefas agendadas, os conectores e as competências do espaço de trabalho por nome, endereço, mensagem ou conta, como a busca do aplicativo (⌘K).
- Cada tipo vem com
more: true quando há outros além dos retornados. - As conversas são buscadas pelo título.
Ferramenta MCP search_workspace
| Argumento | Tipo | Descrição |
|---|---|---|
queryobrigatório | string | O que buscar, ignorando acentos e maiúsculas. Vazio: os mais recentes de cada tipo.até 100 caracteres |
limitopcional | integer | No máximo esta quantidade de cada tipo (padrão e máximo de 50).≥ 1, ≤ 50 |
curl -X POST https://app.semchat.io/api/v1/search \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"query": "…"}'Responde 200 com { "data": … }.
Atualizar o espaço de trabalho
/workspaceGrátisEdita as configurações do espaço de trabalho: o nome, a descrição, as instruções personalizadas para o assistente, os dados da empresa.
- Só o proprietário ou um administrador (a função de quem criou a chave): caso contrário, 403 FORBIDDEN.
- Só os campos enviados mudam; um texto vazio (ou null) limpa um campo. Pelo menos um campo é obrigatório.
Ferramenta MCP update_workspace
| Argumento | Tipo | Descrição |
|---|---|---|
nameopcional | string | 1–255 caracteres |
descriptionopcional | string | null | |
custom_instructionsopcional | string | null | Instruções que o assistente segue em todas as conversas do espaço de trabalho. |
company_nameopcional | string | null | |
company_websiteopcional | string | null | |
company_sirenopcional | string | null | O número de registro da empresa. |
company_addressopcional | string | null |
curl -X PATCH https://app.semchat.io/api/v1/workspace \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"name": "…"}'Responde 200 com { "data": … }.
Ativar ou desativar uma competência
/skills/{skillId}GrátisAtiva ou desativa uma das competências do espaço de trabalho para o chat dele.
- Só o proprietário ou um administrador (a função de quem criou a chave): caso contrário, 403 FORBIDDEN.
Ferramenta MCP set_skill
| Argumento | Tipo | Descrição |
|---|---|---|
skillIdno caminho | string | O id dele. |
enabledobrigatório | boolean |
curl -X PATCH https://app.semchat.io/api/v1/skills/{skillId} \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"enabled": true}'Responde 200 com { "data": … }.
Listar as preferências de ferramentas
/workspace/toolsGrátisAs ferramentas dos conectores que o assistente pode usar, cada uma ativada ou desativada para o espaço de trabalho.
- Uma ferramenta fica ativada, a menos que tenha sido desativada. Cada site herda essas escolhas, a menos que defina as suas: veja list_site_tool_prefs.
Ferramenta MCP list_tool_prefs
curl https://app.semchat.io/api/v1/workspace/tools \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Listar as preferências de ferramentas de um site
/sites/{siteId}/toolsGrátisAs ferramentas dos conectores que o assistente pode usar nas conversas deste site, cada uma ativada ou desativada.
- A escolha do próprio site, quando ele fez uma; senão, a do espaço de trabalho.
Ferramenta MCP list_site_tool_prefs
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
curl https://app.semchat.io/api/v1/sites/{siteId}/tools \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Definir uma preferência de ferramenta
/workspace/toolsGrátisAtiva ou desativa uma ferramenta para o assistente, no espaço de trabalho ou em um único site.
Ferramenta MCP set_tool_pref
| Argumento | Tipo | Descrição |
|---|---|---|
tool_nameobrigatório | string | A ferramenta, com o nome que list_tool_prefs dá a ela.1–64 caracteres |
enabledobrigatório | boolean | |
site_idopcional | string | Só para este site (padrão: o espaço de trabalho).pelo menos 1 caractere |
curl -X PATCH https://app.semchat.io/api/v1/workspace/tools \
-H "Authorization: Bearer sk_live_…" \
-H "Content-Type: application/json" \
-d '{"tool_name": "…", "enabled": true}'Responde 200 com { "data": … }.
Desconectar um conector
/connectors/{provider}GrátisDesconecta uma ferramenta conectada no nível do espaço de trabalho (o acesso salvo é apagado).
- provider como list_connectors mostra (google_search_console, google_analytics_4, notion, slack, wordpress, webflow, microsoft_clarity, bing_webmaster_tools, yandex_metrica).
- As conexões próprias dos sites não são afetadas: veja disconnect_site_connector. A conexão de uma ferramenta é feita no aplicativo.
Ferramenta MCP disconnect_connector
| Argumento | Tipo | Descrição |
|---|---|---|
providerno caminho | string | O id dele. |
curl -X DELETE https://app.semchat.io/api/v1/connectors/{provider} \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Desconectar um conector de um site
/sites/{siteId}/connectors/{provider}GrátisDesconecta uma ferramenta conectada a este site (o acesso salvo é apagado).
- provider como list_site_connectors mostra.
Ferramenta MCP disconnect_site_connector
| Argumento | Tipo | Descrição |
|---|---|---|
siteIdno caminho | string | O id dele. |
providerno caminho | string | O id dele. |
curl -X DELETE https://app.semchat.io/api/v1/sites/{siteId}/connectors/{provider} \
-H "Authorization: Bearer sk_live_…"Responde 200 com { "data": … }.
Não encontrou a resposta? Fale com a gente.

