Guia da API de Recuperação de Conhecimento

Endpoint da requisição

POST /external/use/seek-knowledge/seek HTTP/1.1

Solicitar a lista de modelos disponíveis

GET /external/use/seek-knowledge/models HTTP/1.1

Cabeçalhos da requisição

CabeçalhoValorDescrição
AuthorizationBearer <your_token>Token de autenticação para verificar a identidade do usuário. Substitua <your_token> pelo seu token real.
Content-Typeapplication/jsonIndica que o corpo da requisição está em formato JSON.
Hostedge.flowith.netEndereço do servidor da API.
User-AgentHTTPie(Opcional) Identificador do cliente.

Corpo da requisição (JSON)

ParâmetroTipoDescrição
messagesArrayLista de mensagens da conversa. Cada objeto de mensagem contém os campos role e content.
modelStringNome do modelo. Exemplo: "gpt-4o-mini"
streamBooleanHabilitar resposta em streaming? true para habilitar, false para desabilitar.
kb_listString ArrayLista de IDs de bases de conhecimento. Especifica o escopo da recuperação de conhecimento.

Detalhes do campo messages

  • role: Papel da mensagem, pode ser "assistant" ou "user".
  • content: Conteúdo da mensagem, como consultas sofisticadas ou instruções.

Resposta

Quando stream é true (resposta em streaming)

  • Código de status da resposta: 200 OK
  • Cabeçalhos da resposta: Inclui cabeçalhos HTTP padrão como Content-Type: text/plain; charset=UTF-8, etc.
  • Corpo da resposta: Fluxo de texto começando com data:. Cada bloco data: contém um objeto JSON com os seguintes valores possíveis de tag:
    • searching: Indica busca em andamento; o campo content inclui atualizações de progresso.
    • seeds: Resultados intermediários da busca; content é um array JSON em que cada elemento é um fragmento de conhecimento distinto contendo id, tokens, content, order, source_id, source_title e nip.
    • final: Indica os resultados finais; content contém o texto completo da resposta.

Quando stream é false

  • Código de status da resposta: 200 OK
  • Cabeçalhos da resposta: Inclui cabeçalhos HTTP padrão como Content-Type: application/json, etc.
  • Corpo da resposta: Um objeto JSON contendo os campos tag e content.
    • tag: Sempre "final".
    • content: Texto completo da resposta.

Exemplos com curl

Resposta em streaming (stream = true)

curl -X POST "https://edge.flowith.net/external/use/knowledge-base/seek" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -H "Host: edge.flowith.net" \
  -d '{
    "messages": [
      {"role": "assistant", "content": "I'd like to explore effective social dynamics and interpersonal relationships"},
      {"role": "user", "content": "Share your best strategies for authentic connection and building rapport in professional settings"}
    ],
    "model": "gpt-4.1-mini",
    "stream": true,
    "kb_list": ["<knowledge_base_id>"]
  }' 

Resposta sem streaming (stream = false)

curl -X POST "https://edge.flowith.net/external/use/knowledge-base/seek" \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -H "Host: edge.flowith.net" \
  -d '{
    "messages": [
      {"role": "assistant", "content": "I'd like to explore effective social dynamics and interpersonal relationships"},
      {"role": "user", "content": "Share your best strategies for authentic connection and building rapport in professional settings"}
    ],
    "model": "gpt-4.1-mini",
    "stream": false,
    "kb_list": ["<knowledge_base_id>"]
  }' 

Lembre-se de substituir <your_token> e <knowledge_base_id> pelos seus valores reais.

Limites de taxa

  • Requisições: 12 requisições por minuto (RPM)
  • Nota: Exceder esse limite resultará em erros HTTP 429 (Too Many Requests)

Cobrança

  • Uso de cota: As cobranças são calculadas com base na cota de Créditos da conta correspondente da Flowith
  • Ciclo de cobrança: O uso é calculado e deduzido em tempo real do saldo da sua conta