Zum Inhalt
Copyright © 2022-2026 basebox GmbH, all rights reserved.
Licensed to be used in conjunction with basebox, only.

// integration

Create Chat Completion

Gilt für

Produkt: Cloud · Server · Zielgruppe: Entwickler / Integrator

POST https://aims.basebox.ai/rest/v1/chat/completions

Fordert eine KI-Antwort für die angegebene Chat-Unterhaltung an.

Die Verwendung der Felder im Request-Body unterscheidet sich leicht von der ursprünglichen API-Spezifikation.

Request-Body

messages

Ein Array von Nachrichtenobjekten, das die gesamte bisherige Unterhaltung umfasst.

Das Nachrichtenobjekt ist wie folgt definiert:

{
  "role": "user",       // "user" or "assistant"
  "content": "Hello!"   // the text content
}

model

Application-ID der basebox-App, die die Anfrage verarbeiten soll.

Standard: ai.basebox.assistant

Beispiel:

{
  "model": "ai.basebox.assistant"
}

Die Application-ID einer App wird derzeit nur im URL-Feld des Browsers angezeigt.

Beispiel-URL: https://soccer.kiste.ai/apps/ai.basebox.soccer.5ca2b0ac-f3f9-45b6-9a2e-1a721dc9b86
Application-ID: ai.basebox.soccer.5ca2b0ac-f3f9-45b6-9a2e-1a721dc9b86

audio

Noch nicht unterstützt

frequency_penalty

Noch nicht unterstützt

Weitere Felder

Weitere Felder werden nicht unterstützt, da ihr Zweck in der aufgerufenen basebox-App festgelegt ist.

Response-Body

Ein JSON-Objekt, das die gestückelte Antwort der basebox-App enthält. Siehe Beispiel unten.

TODO: Response-Objekt dokumentieren

curl-Beispiel

api_key="<API_TOKEN>"
host="https://aims.basebox.ai"

curl -v $host/rest/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "X-Realm: myorg" \
  -H "Authorization: Bearer $api_key" \
  -d '{
    "model": "ai.basebox.assistant",
    "stream": true,
    "messages": [
      {
        "role": "user",
        "content": "Hello! Are you good?"
      }
    ]
  }'

Antwort

{"type":"message_start","message":{"usage":{"input_tokens":91,"output_tokens":5}}}
{"type":"Other"}
{"type":"Other"}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":"Hello! I'm doing"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" well, thank you for"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" asking! I'm here"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" and ready to help with"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" whatever you need. How"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" are you doing today?"}}
{"type":"content_block_delta","index":0,"delta":{"type":"text_delta","text":" Is there anything I can assist you with?"}}
{"type":"Other"}
{"type":"message_delta","usage":{"input_tokens":null,"output_tokens":42},"delta":{"stop_reason":"end_turn","stop_sequence":null}}
{"type":"Other"}