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çãoChamada
Obter o espaço de trabalhoGET /workspaceGrátis
Obter o usoGET /usageGrátis
Listar as competênciasGET /skillsGrátis
Listar os conectoresGET /connectorsGrátis
Buscar no espaço de trabalhoPOST /searchGrátis
Atualizar o espaço de trabalhoPATCH /workspaceGrátis
Ativar ou desativar uma competênciaPATCH /skills/{skillId}Grátis
Listar as preferências de ferramentasGET /workspace/toolsGrátis
Listar as preferências de ferramentas de um siteGET /sites/{siteId}/toolsGrátis
Definir uma preferência de ferramentaPATCH /workspace/toolsGrátis
Desconectar um conectorDELETE /connectors/{provider}Grátis
Desconectar um conector de um siteDELETE /sites/{siteId}/connectors/{provider}Grátis

Obter o espaço de trabalho

GET/workspaceGrátis

O 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

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

GET/usageGrátis

O uso do período atual, em porcentagem, dividido por categoria.

Ferramenta MCP get_usage

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

GET/skillsGrátis

As competências disponíveis para o chat do espaço de trabalho.

Ferramenta MCP list_skills

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

GET/connectorsGrátis

As 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

Requisição
curl https://app.semchat.io/api/v1/connectors \
  -H "Authorization: Bearer sk_live_…"

Responde 200 com { "data": … }.

Buscar no espaço de trabalho

POST/searchGrátis

Busca 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

ArgumentoTipoDescrição
queryobrigatóriostringO que buscar, ignorando acentos e maiúsculas. Vazio: os mais recentes de cada tipo.até 100 caracteres
limitopcionalintegerNo máximo esta quantidade de cada tipo (padrão e máximo de 50).≥ 1, ≤ 50
Requisição
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

PATCH/workspaceGrátis

Edita 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

ArgumentoTipoDescrição
nameopcionalstring1–255 caracteres
descriptionopcionalstring | null
custom_instructionsopcionalstring | nullInstruções que o assistente segue em todas as conversas do espaço de trabalho.
company_nameopcionalstring | null
company_websiteopcionalstring | null
company_sirenopcionalstring | nullO número de registro da empresa.
company_addressopcionalstring | null
Requisição
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

PATCH/skills/{skillId}Grátis

Ativa 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

ArgumentoTipoDescrição
skillIdno caminhostringO id dele.
enabledobrigatórioboolean
Requisição
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

GET/workspace/toolsGrátis

As 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

Requisição
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

GET/sites/{siteId}/toolsGrátis

As 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

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

PATCH/workspace/toolsGrátis

Ativa ou desativa uma ferramenta para o assistente, no espaço de trabalho ou em um único site.

Ferramenta MCP set_tool_pref

ArgumentoTipoDescrição
tool_nameobrigatóriostringA ferramenta, com o nome que list_tool_prefs dá a ela.1–64 caracteres
enabledobrigatórioboolean
site_idopcionalstringSó para este site (padrão: o espaço de trabalho).pelo menos 1 caractere
Requisição
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

DELETE/connectors/{provider}Grátis

Desconecta 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

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

DELETE/sites/{siteId}/connectors/{provider}Grátis

Desconecta uma ferramenta conectada a este site (o acesso salvo é apagado).

  • provider como list_site_connectors mostra.

Ferramenta MCP disconnect_site_connector

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

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