OpenAPI 1.3.0

Documentação da API

API pública do PM8 AI. Autentique com uma chave de API criada no Security Center (Authorization: Bearer pm8_live_…). Cada chave pertence a uma aplicação e tem escopos.

Escopos

  • knowledge:read — listar bases e buscar trechos (apenas bases visíveis à empresa toda).
  • copilot:query — perguntas com resposta fundamentada e citações.
  • agents:run — reservado; execução de agentes via API está no roadmap.

Políticas da empresa valem para a API: lista de IPs liberados, orçamento mensal e remoção de dados pessoais.

GET
/health

Verifica a chave e o tenant

curl -X GET "$ORIGIN/api/public/v1/health" \
  -H "Authorization: Bearer $PM8_API_KEY"
GET
/knowledge-bases
knowledge:read

Lista Knowledge Bases visíveis à empresa

curl -X GET "$ORIGIN/api/public/v1/knowledge-bases" \
  -H "Authorization: Bearer $PM8_API_KEY"
POST
/knowledge/search
knowledge:read

Busca semântica em Knowledge Bases

curl -X POST "$ORIGIN/api/public/v1/knowledge/search" \
  -H "Authorization: Bearer $PM8_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Qual a carga horária de Ciência de Dados?","k":3}'
POST
/copilot/query
copilot:query

Pergunta ao Copilot com respostas fundamentadas e citações

curl -X POST "$ORIGIN/api/public/v1/copilot/query" \
  -H "Authorization: Bearer $PM8_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"question":"Posso trancar a matrícula no meio do semestre?"}'