Recursos · Referência da API

Referência da API

Referência completa de todos os endpoints do OpenQCore, organizada por superfície de runtime e por camada de execução.

Catálogo da API

Um índice rápido e orientado à execução. Detalhes técnicos estão nas páginas dedicadas de cada API.

Autenticação

POST /auth/login

POST /auth/refresh

Autenticação, chaves de API, gerenciamento de escopos e controle de acesso.

[Ver documentação de autenticação]

Chaves de API

POST /api-keys

GET /api-keys

POST /api-keys/{key_id}/revoke

POST /api-keys/{key_id}/disable

Criar, listar, revogar e desativar chaves de API pessoais usadas para autenticação não interativa.

Ver referência de chaves de API →

Runtime de chat

GET /chat/health

POST /chat/completions

Execução conversacional central, streaming, persistência e controles de tempo de execução.

[Ver API de Chat]

Sessões de Chat e Mensagens

POST /sessions

GET /sessions

GET /sessions/{session_id}/messages

PATCH /sessions/{session_id}

DELETE /sessions/{session_id}

GET /messages/{message_id}

PATCH /messages/{message_id}

GET /messages/{message_id}/history

POST /messages/{message_id}/undo

DELETE /messages/{message_id}

Criar, listar, renomear, fixar/marcar com estrela e excluir sessões de chat; editar uma mensagem com histórico rastreado, desfazer a última edição ou excluir uma mensagem.

Ver API de Sessões e Mensagens →

Runtime de Voz

POST /voice/chat

POST /voice/chat/meta

POST /voice/interrupt/{session_id}

WS /voice/ws

STT, LLM e TTS em tempo real, tratamento de interrupções e áudio em streaming.

[Ver API de Voz]

Iris Multimodal

POST /iris/generate

POST /iris/video

POST /iris/ocr

POST /iris/verify

Fluxos multimodais para imagem, vídeo e OCR.

[Ver API Iris]

Conhecimento

GET /console/knowledge

POST /console/knowledge

POST /console/knowledge/upload

POST /console/knowledge/ask

PATCH /console/knowledge/{id}

DELETE /console/knowledge/{id}

Ingestão e recuperação de conhecimento, com execução aumentada por recuperação.

[Ver API de Conhecimento]

Arquivo

POST /archive/units

GET /archive/units

GET /archive/units/{unit_id}

PATCH /archive/units/{unit_id}

DELETE /archive/units/{unit_id}

Criar, listar, recuperar, atualizar e excluir unidades de conhecimento arquivadas associadas a um usuário ou espaço de trabalho.

Ver API do Arquivo →

Cabeçalhos de Runtime

Referência rápida dos cabeçalhos obrigatórios nas diferentes interfaces de runtime.

Cabeçalho	Obrigatório
`Authorization`	✅
`X-API-Key`	Alternativa ao Authorization
`X-Scope-Type`	✅
`X-Workspace-ID`	Somente para espaços de trabalho
`X-Agent-ID`	Opcional

Códigos de Resposta

Classes de resposta operacionais comuns.

Código	Significado
200	Sucesso
400	Solicitação inválida
401	Não autorizado
403	Proibido
409	Conflito de bloqueio
422	Erro de validação
429	Limite de requisições excedido
503	Sobrecarregado

Estatísticas da Plataforma

Visão geral operacional.

Endpoints

Ambientes de execução

Integrações de provedores

Unified

Contrato de saída

Dual

Streaming + Não-Streaming