Recursos · Documentação
Documentação da plataforma.
Projetada para uso em produção.
Documentação do OpenQCore para equipes que desenvolvem produtos de IA confiáveis em chat, voz, geração multimodal e fluxos de conhecimento, com controle de runtime por escopo.
Início rápido
Da primeira requisição ao ambiente de produção em minutos.
1) Autenticar
Use autenticação por sessão JWT ou por chave de API com controle de acesso por escopo.
2) Escolher escopo de runtime
Defina o contexto pessoal ou do workspace usando cabeçalhos de runtime quando necessário.
3) Executar chat completions
Use /api/v1/chat/completions para executar o núcleo do assistente.
4) Adicionar voz e multimodal
Use /api/v1/voice e os endpoints Iris para fluxos de STT/TTS, imagem, vídeo e OCR.
5) Integrar conhecimento
Use /api/v1/console/knowledge para upload, ingestão e perguntas orientadas por recuperação.
URL base
Base da API pública
/api/v1Todos os endpoints públicos da plataforma estão sob /api/v1.
Autenticação e Escopo
Acesso sensível ao contexto para execuções pessoais e do workspace.
Métodos de autenticação
JWT/session ou API key
Cabeçalho de escopo
X-Scope-Type: personal | workspace
Cabeçalho do workspace
X-Workspace-ID: [uuid] (obrigatório quando o escopo for workspace)
Cabeçalho do agente
X-Agent-ID: [uuid] (opcional)
Regras de validação
- Se o scope for personal, workspace_id não é permitido.
- Se o scope for workspace, workspace_id é obrigatório.
- Cabeçalhos de scope inválidos retornam 422.
Limites de taxa
Limitação de requisições por políticas conforme o contexto de autenticação.
API key
60 requisições por minuto
A chave do bucket usa o hash da API key para identificação.
JWT/session
120 requisições por minuto
A chave do bucket usa o workspace id quando presente; caso contrário, usa o user id.
Cabeçalhos de resposta do controle de taxa
Ambiente de execução do Chat
/chat/completions com camadas de controle em produção.
GET /api/v1/chat/healthPOST /api/v1/chat/completionsComportamentos de execução
- Monitoramento de backpressure e rejeição por sobrecarga do sistema (503).
- Bloqueio distribuído para evitar processamento duplicado em andamento (409).
- Cache de deduplicação para respostas não em streaming.
- Persistência de sessão e de mensagens para interações entre usuário e assistente.
- Validação em tempo de execução de requisição, anexos e acesso à sessão.
Runtime de Voz
Pipeline STT → LLM → TTS com streaming e interrupção.
POST /api/v1/voice/chat/metaPOST /api/v1/voice/chatPOST /api/v1/voice/interrupt/{session_id}WS /api/v1/voice/wsRecursos de voz
- Roteamento para provedores de fallback (OpenAI e Azure).
- Circuit breakers para as fases STT, LLM e TTS.
- Pipeline de conversão de áudio para entradas que não estão em WAV.
- Respostas de áudio em streaming com cabeçalhos de metadados.
- Contexto de cancelamento para interrupções em nível de sessão.
- Alívio de carga e degradação da qualidade sob carga elevada.
Iris Multimodal
Fluxos de trabalho de imagem, vídeo, OCR e verificação roteados por modelo.
Catálogo de modelos
iris-orbit
Modo de roteamento automático
iris-genesis
Geração de imagens
iris-edit
Edição de imagem (não implementada)
iris-lens
Análise de imagem (não implementada)
iris-video
Geração de vídeo
iris-ocr
OCR de documentos
iris-verify
Verificação de identidade
iris-guard
Detecção de fraude (não implementado)
iris-face
Verificação facial (não implementado)
Conhecimento do Console
APIs de conhecimento do console do espaço de trabalho para ingestão e consulta.
/api/v1/console/knowledgeGET /api/v1/console/knowledgePOST /api/v1/console/knowledgePOST /api/v1/console/knowledge/uploadGET /api/v1/console/knowledge/{item_id}PATCH /api/v1/console/knowledge/{item_id}DELETE /api/v1/console/knowledge/{item_id}POST /api/v1/console/knowledge/askRestrições de conhecimento
- Tamanho máximo do arquivo: 20 MB
- Tipos permitidos: PDF, DOC, DOCX, TXT, Markdown
- A ingestão é processada de forma assíncrona em segundo plano
- Estados: pendente → em processamento → processado | falha
Semântica de erros
Classes de resposta comuns da plataforma.
400
Requisição inválida, dados ausentes ou entrada malformada
401
Autenticação ausente ou inválida
403
Escopo não permitido / restrição de função no espaço de trabalho
404
Recurso não encontrado
409
Requisição já em processamento (conflito de bloqueio)
413
Carga útil muito grande (ex.: limites de áudio/arquivo)
415
Tipo de conteúdo não suportado
422
Falha de validação (escopo/contexto/esquema)
429
Limite de taxa excedido
503
Sobrecarga do sistema / provedor indisponível
Observabilidade
Execução rastreável nos ciclos de vida de chat e voz.
- IDs de rastreamento para correlação de requisições.
- Pipeline de middleware para registro de uso.
- Inicialização do OpenTelemetry com exportação OTLP.
- Cabeçalhos de resposta expõem sinais de timing em fluxos de voz.
Navegação da documentação
Explore as seções da documentação
Acesse diretamente os guias de implementação e as referências de produção para cada ambiente de execução.
Autenticação
Autenticação via JWT/chave de API, cabeçalhos de escopo e modelo de validação.
API de Chat
Geração de respostas, comportamento em streaming e controles de tempo de execução.
API de Voz
Pipeline de voz em tempo real, fluxo de interrupção e cabeçalhos de metadados.
Iris API
Endpoints de imagem, vídeo, OCR e verificação, além do roteamento.
API de Conhecimento
Envio, ciclo de vida de indexação, recuperação e fluxos de trabalho de consulta.
Provedores
Matriz de capacidades, política de roteamento e estratégia de failover.
Contratos de Saída
Envelope de resposta unificado entre provedores e modalidades.
Arquitetura
Camadas de tempo de execução, abstração de provedores e garantias do sistema.
Construa com confiança no runtime do OpenQCore.
Use a documentação como seu mapa de produção para chat, voz, geração multimodal e execução baseada em conhecimento.