Skip to navigation
Visão geral

A API HTTP

O Gateway por HTTP puro, para programas.
View as Markdown

A API HTTP dá a um programa as mesmas ferramentas que um agente tem pelo MCP. Cada ferramenta é uma operação. Os SDKs para TypeScript e Python chamam esta API para você.

Endereço e entrada

URL basehttps://mcp.basement.chat
EntradaAuthorization: Bearer bsmt_sua_chave
FormatoJSON na entrada e na saída

Crie a chave no Basement: Agentes, Conectar agente, Programa. Veja Conectar um programa.

Operações

POST /v1/tools/{name}Executa uma ferramenta. O corpo JSON leva os argumentos da ferramenta. A resposta é o resultado dela.
GET /v1/toolsLista as ferramentas que a chave pode chamar, cada uma com o esquema dos argumentos.
GET /v1/openapi.jsonEsta API como documento OpenAPI 3.1. Não precisa de chave.
curl -X POST https://mcp.basement.chat/v1/tools/create_task \
-H "Authorization: Bearer $BASEMENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "Revisar os preços do 4º trimestre"}'
{ "taskId": "k57c2m…" }

Uma ferramenta sem argumentos não precisa de corpo.

Erros

Uma chamada que falha responde um status e um corpo JSON:

{ "error": { "code": "forbidden", "message": "Role lacks write access" } }
StatuscodeSignificado
400invalid_requestOs argumentos não são válidos, ou a ferramenta recusou.
401unauthorizedA chave está ausente, errada, revogada ou vencida.
403forbiddenO nível de acesso da chave não permite a chamada.
404not_foundNão existe ferramenta com esse nome.
429rate_limitedMais de 240 chamadas em um minuto.
500internal_errorO Basement não conseguiu concluir a chamada.
502service_errorUm serviço conectado falhou ou recusou a chamada.

Veja Erros e limites para saber como os SDKs lançam esses erros.

O mesmo gateway

A API HTTP e o MCP são duas portas para um só gateway. Uma chave funciona nas duas. O nível de acesso, os limites e o registro de atividade são os mesmos. No registro de atividade, uma chamada por esta API mostra “API HTTP (SDK)” e o SDK que fez a chamada.

As descrições das operações nesta referência vêm da própria API e estão em inglês.