Workspace AI
Integra Chat, Biblioteca, Dashboard, API e integrações com sistemas da empresa.
Documentação developer
API Apeirum
Integre recursos do Workspace AI aos sistemas da sua empresa com autenticação, respostas estruturadas, rastreabilidade e fluxos sob acesso aprovado.
Visão geral
A API Apeirum é o caminho técnico para conectar partes do Workspace AI a produtos digitais, sistemas internos e rotinas empresariais. O acesso é aprovado por escopo e os contratos finais de integração são definidos com a equipe Apeirum.
Respostas estruturadas
Pode retornar resposta, dados estruturados, evidências, status, job_id e metadados.
Escopo aprovado
Credenciais, limites, schemas e suporte são definidos antes de produção.
Acesso e contratação
A API não é um endpoint público irrestrito. O uso depende de aprovação, contrato comercial e alinhamento técnico.
Acesso aprovado antes de uso em produção
Contratação por plano, escopo e/ou uso por requisição quando aplicável
Uso para empresas, produtos digitais e sistemas internos
Schemas, limites e SLAs definidos conforme proposta
Autenticação
O padrão de integração usa chave de API em header. Em produção, trate a chave como segredo de servidor e nunca exponha no cliente.
Enviar x-api-key em todas as requisições aprovadas
Usar Content-Type: application/json para payloads JSON
Guardar a chave em variável de ambiente ou cofre de segredos
Planejar rotação e revogação de chave quando necessário
Quickstart
Os exemplos abaixo mostram o formato esperado de integração. A base URL, endpoints e schemas finais podem variar conforme o contrato aprovado.
cURL
examplecurl -X POST "$APEIRUM_BASE_URL/v1/answers" \
-H "x-api-key: $APEIRUM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "Quais itens exigem revisão?",
"scope": "workspace_contract",
"include_evidence": true
}'JavaScript / TypeScript
exampleconst response = await fetch(
`${process.env.APEIRUM_BASE_URL}/v1/answers`,
{
method: "POST",
headers: {
"x-api-key": process.env.APEIRUM_API_KEY,
"Content-Type": "application/json"
},
body: JSON.stringify({
question: "Quais itens exigem revisão?",
scope: "workspace_contract",
include_evidence: true
})
}
);
const data = await response.json();PowerShell
example$headers = @{
"x-api-key" = $env:APEIRUM_API_KEY
"Content-Type" = "application/json"
}
$body = @{
question = "Quais itens exigem revisão?"
scope = "workspace_contract"
include_evidence = $true
} | ConvertTo-Json
Invoke-RestMethod `
-Method POST `
-Uri "$env:APEIRUM_BASE_URL/v1/answers" `
-Headers $headers `
-Body $bodyFluxo básico de integração
Uma integração típica envia documento ou dado, consulta contexto autorizado, recebe resposta estruturada e acompanha status quando o processamento é assíncrono.
1. Enviar entrada
Documento, dado, evento ou pergunta chega com finalidade definida.
2. Criar ou consultar contexto
A integração informa escopo, usuário, rotina ou coleção autorizada.
3. Obter resposta
A API retorna answer, structured_data, evidence, status e metadata quando aplicável.
4. Consultar job
Fluxos assíncronos expõem job_id e status para acompanhamento.
5. Receber callback
Quando contratado, webhooks devolvem eventos relevantes ao sistema de destino.
Endpoints e contratos de integração
Os caminhos abaixo são exemplos de contrato de integração sob escopo. Eles documentam o desenho esperado, sem prometer disponibilidade pública irrestrita.
Contrato
Base URL, versão e payload final são definidos no escopo aprovado.
POST /v1/documents
Enviar documento ou arquivo para processamento aprovado.
GET /v1/jobs/{job_id}
Consultar status, erro ou conclusão de processamento assíncrono.
POST /v1/answers
Enviar pergunta ou dado e receber resposta estruturada.
POST /v1/webhooks
Registrar callback quando o fluxo contratado exigir retorno assíncrono.
Exemplo de response
Responses podem combinar texto, dados estruturados, evidências e metadados. Campos finais dependem do schema contratado.
response.json
example{
"job_id": "job_01hx_example",
"status": "completed",
"answer": "Há três itens que exigem revisão antes de seguir.",
"structured_data": {
"items": [
{
"label": "Prazo de renovação",
"risk": "medium",
"requires_review": true
}
]
},
"evidence": [
{
"document_id": "doc_01hx_example",
"excerpt": "Renovação automática por 12 meses salvo aviso prévio.",
"location": "page 4"
}
],
"metadata": {
"request_id": "req_01hx_example",
"scope": "workspace_contract"
}
}Erros
Os códigos abaixo orientam tratamento de falhas em clientes e integrações. Mensagens finais podem variar por contrato.
400
bad_request
Corrigir payload, campos obrigatórios ou formato.
401
unauthorized
Verificar ausência ou validade da chave de API.
403
forbidden
Confirmar se o escopo contratado permite a ação.
404
not_found
Verificar identificador, job ou recurso solicitado.
429
rate_limited
Respeitar rate limit e aplicar retry com backoff.
500
server_error
Registrar request_id e acionar suporte técnico se persistir.
Limites e uso
Limites são definidos por escopo, plano ou contrato. A cobrança pode considerar plano, volume, endpoints autorizados, suporte e uso por requisição.
Rate limits por chave, organização ou fluxo
Quotas por plano, contrato ou janela de uso
Medição de consumo quando aplicável
Sem tabela final de preço quando o escopo ainda depende de proposta
Segurança e revisão
A integração deve preservar controle operacional. Casos sensíveis precisam de logs, permissões, revisão humana e limites antes de ações externas.
Logs e request_id para auditoria
Permissões por organização, chave e escopo
Rastreabilidade e evidências quando exigidas pelo fluxo
Revisão humana antes de registrar, enviar ou acionar ações externas
Limites de automação definidos por contrato
API
Pronto para mapear uma integração?
Fale sobre sistema de destino, volume, dados, respostas esperadas, callbacks e requisitos de revisão. A Apeirum define o contrato técnico a partir do escopo aprovado.