Leitfaden zur Knowledge Retrieval API

Anfrage-Endpunkt

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

Liste der verfügbaren Modelle abfragen

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

Anfrage-Header

HeaderWertBeschreibung
AuthorizationBearer <your_token>Authentifizierungstoken zur Überprüfung der Benutzeridentität. Ersetzen Sie <your_token> durch Ihr tatsächliches Token.
Content-Typeapplication/jsonGibt an, dass der Anfragetext im JSON-Format vorliegt.
Hostedge.flowith.netAdresse des API-Servers.
User-AgentHTTPie(Optional) Client-Kennung.

Anfragetext (JSON)

ParameterTypBeschreibung
messagesArrayListe der Konversationsnachrichten. Jedes Nachrichtenobjekt enthält die Felder role und content.
modelStringModellname. Beispiel: "gpt-4o-mini"
streamBooleanStreaming-Antwort aktivieren? true zum Aktivieren, false zum Deaktivieren.
kb_listString-ArrayListe der Wissensdatenbank-IDs. Gibt den Umfang für den Wissensabruf an.

Details zum Feld messages

  • role: Nachrichtenrolle, kann "assistant" oder "user" sein.
  • content: Nachrichteninhalt, etwa komplexe Abfragen oder Anweisungen.

Antwort

Wenn stream true ist (Streaming-Antwort)

  • Antwort-Statuscode: 200 OK
  • Antwort-Header: Enthält Standard-HTTP-Header wie Content-Type: text/plain; charset=UTF-8 usw.
  • Antworttext: Textstream, der mit data: beginnt. Jeder data:-Block enthält ein JSON-Objekt mit den folgenden möglichen tag-Werten:
    • searching: Zeigt an, dass eine Suche läuft; das Feld content enthält Fortschrittsaktualisierungen.
    • seeds: Zwischenergebnisse der Suche; content ist ein JSON-Array, bei dem jedes Element ein eigenständiges Wissensstück ist, das id, tokens, content, order, source_id, source_title und nip enthält.
    • final: Zeigt die Endergebnisse an; content enthält den vollständigen Antworttext.

Wenn stream false ist

  • Antwort-Statuscode: 200 OK
  • Antwort-Header: Enthält Standard-HTTP-Header wie Content-Type: application/json usw.
  • Antworttext: Ein JSON-Objekt, das die Felder tag und content enthält.
    • tag: Immer "final".
    • content: Vollständiger Antworttext.

curl-Beispiele

Streaming-Antwort (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>"]
  }' 

Nicht-Streaming-Antwort (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>"]
  }' 

Denken Sie daran, <your_token> und <knowledge_base_id> durch Ihre tatsächlichen Werte zu ersetzen.

Ratenbegrenzungen

  • Anfragen: 12 Anfragen pro Minute (RPM)
  • Hinweis: Das Überschreiten dieses Limits führt zu HTTP-429-Fehlern (Too Many Requests)

Abrechnung

  • Kontingentnutzung: Die Abrechnung erfolgt basierend auf dem Credits-Kontingent des entsprechenden Flowith-Kontos
  • Abrechnungszyklus: Die Nutzung wird in Echtzeit berechnet und von Ihrem Kontoguthaben abgezogen