Documentação / Primeiros passos

Início rápido

Prévia para desenvolvedores

Três passos: obtenha um token, faça uma busca, faça uma pergunta. Os endpoints marcados como “Disponível” funcionam hoje; os marcados como “Planejado” chegarão com o núcleo aberto.

1
Obter um token
O token está no arquivo token do diretório de dados. Ele é gerado automaticamente na primeira inicialização e só pode ser lido pelo usuário atual.
Terminal
cat <diretório-de-dados>/token
# Todo endpoint /api/v1 exige o token; por padrão atende apenas em 127.0.0.1:8090
2
Busca
Busque seu material em linguagem natural. Os resultados trazem o arquivo, o local e o trecho, e não dependem dos nomes dos arquivos.
Terminal
curl http://127.0.0.1:8090/api/v1/search \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"query": "condições de pagamento no contrato do fornecedor", "top_k": 5}'
3
Perguntas
Resposta em streaming. Com a busca ativada, responde somente com base nos seus arquivos e cita as fontes.
Terminal
curl -N http://127.0.0.1:8090/api/v1/chat/stream \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"messages": [{"role": "user", "content": "O que foi decidido na reunião da semana passada?"}],
       "search": true}'

Status da API

APIO que fazStatus
MCP · ownward-mcp
Permite que agentes compatíveis com MCP usem diretamente a busca, as perguntas e a biblioteca; ferramentas com efeitos colaterais não são expostas.
Disponível
POST /api/v1/search
Uma só busca em documentos, imagens, áudio e vídeo.
Disponível
POST /api/v1/search-image
Busque imagens por imagem.
Disponível
POST /api/v1/search/video-clips
Localize o trecho exato em um vídeo.
Disponível
POST /api/v1/chat/stream
Perguntas e respostas em streaming via SSE, com fontes.
Disponível
POST /api/v1/generate
Geração de imagens e vídeo. Uma duração que a máquina não consegue concluir é recusada na hora, e o limite suportado é informado.
Disponível
GET /hub/index.json
Catálogo de cenários; verificado por sha256 antes de ser salvo.
Disponível
SDK · Python / JS / C++
Empacota os endpoints acima como bibliotecas cliente para cada linguagem.
Planejado
API compatível com OpenAI
As ferramentas existentes se conectam trocando o endereço do endpoint.
Planejado
Conectores MCP
Conecte ferramentas e fontes de dados de terceiros por meio do MCP.
Planejado

Modelos

Cada tipo de tarefa tem uma escolha padrão que você pode trocar nas configurações. Os modelos na nuvem são opcionais e vêm desativados.

Busca
Texto e multimodal
Embeddings · reranking · esparso · visão de páginas de documento
Imagens
Compreensão de imagens
Semântica imagem-texto · rostos · OCR · legendas
Áudio
Compreensão de áudio
Transcrição · alinhamento por palavra · falantes · eventos
Vídeo
Análise de vídeo
Detecção de cenas · detecção e rastreamento
Conversa
Perguntas e planejamento
Modelos de conversa locais
Gerar
Imagem e vídeo
Imagens · vídeo · síntese de voz
Documentação
Compreensão de layout
Estrutura da página · compreensão elemento a elemento
Substituível
Sem dependência de fornecedor
Troque por tipo nas configurações
Inscrição na prévia para desenvolvedores em breve
A inscrição está sendo preparada e será anunciada aqui quando abrir.