// referência · api
OpenAPI da API HTTP
okami serve expõe uma API pequena e fail-closed: GET /health sem auth e POST /chat com Bearer token. OpenAPI continua sendo o contrato exportável; a página visual u…
Visual interativo
Abrir API visualRenderização moderna com Scalar.Baixar openapi.yamlContrato importável em Postman, Insomnia, Bruno ou CI.
Contrato OpenAPI
openapi.yaml
openapi: 3.1.0
info:
title: Okami Agent HTTP API
version: 0.0.1
servers:
- url: http://127.0.0.1:8765
paths:
/health:
get:
summary: Healthcheck
responses:
'200':
description: API pronta
/chat:
post:
summary: Envia uma mensagem ao agente
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [message]
properties:
agent: { type: string, default: okami }
message: { type: string }
responses:
'200': { description: reply, state e usage }
'400': { description: JSON invalido }
'401': { description: Bearer token ausente ou invalido }
'404': { description: endpoint desconhecido }
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearerExemplo de payload
{
"agent": "okami",
"message": "resuma este repositorio"
}Resposta
{
"reply": "...",
"state": "complete",
"usage": { "input_tokens": 0, "output_tokens": 0 }
}