Threads-API¶

Verwenden Sie diese API, um Threads zu erstellen, die für die Interaktion mit Cortex Agents verwendet werden.

Thread erstellen¶

POST /api/v2/cortex/threads

Erstellt einen neuen Thread und gibt die Thread-UUID zurück.

Anfrage¶

Header der Anforderung¶

Header	Beschreibung
`Authorization`	(Erforderliche) Autorisierungstoken. Weitere Informationen dazu finden Sie unter Authentifizierung.
`Content-Type`	(Erforderlich) Anwendung/json

Anforderungstext¶

Der Anforderungstext kann das folgende Feld enthalten:

Feld	Typ	Beschreibung
`origin_application`	string	(Optional) Name der Anwendung, die den Thread erstellt hat. Ermöglicht das Gruppieren von Threads nach Anwendung. Ist auf 16 Byte begrenzt.

Beispiel:

{
  "origin_application": "my_app"
}

Copy

Antwort¶

Gibt die Thread-UUID als Zeichenfolge zurück.

"1234567890"

Copy

Thread beschreiben¶

GET /api/v2/cortex/threads/{id}

Beschreibt einen Thread und gibt einen Batch von Nachrichten in diesem Thread zurück, und zwar basierend auf „page_size“ und „last_message_id“ in absteigender Reihenfolge der Erstellung. Diese Anforderung ist nur erfolgreich, wenn die Thread-ID dem Benutzer gehört.

Anfrage¶

Pfadparameter¶

Parameter	Typ	Beschreibung
`id`	Ganzzahl	(Erforderlich) UUID für den Thread.

Abfrageparameter¶

Parameter	Typ	Beschreibung
`page_size`	Ganzzahl	(Optional) Anzahl der Nachrichten, die zurückgegeben werden sollen (Standardwert: 20, max.: 100).
`last_message_id`	Ganzzahl	(Optional) Die ID der letzten empfangenen Nachricht. Wird verwendet, um den Offset für den nächsten Batch festzulegen. Kann für den ersten Batch von Nachrichten leer sein.

Header der Anforderung¶

Header	Beschreibung
`Authorization`	(Erforderliche) Autorisierungstoken.
`Content-Type`	(Erforderlich) Anwendung/json

Antwort¶

Gibt ein Thread-Metadatenobjekt und ein Array von Nachrichten zurück.

Feld	Typ	Beschreibung
metadata	Objekt	Metadaten für den Thread, einschließlich des Namens, der Anwendung, die den Thread erstellt hat, und des Zeitpunkts der Erstellung.
`messages`	Array	Array von Nachrichtenobjekten.

metadata¶

Feld	Typ	Beschreibung
`thread_id`	Ganzzahl	UUID für den Thread.
`thread_name`	string	Name des Threads.
`origin_application`	string	Der Name der Anwendung, die den Thread erstellt hat.
`created_on`	Ganzzahl	Zeitpunkt, zu dem der Thread erstellt wurde (Millisekunden seit UNIX-Epoche).
`updated_on`	Ganzzahl	Zeitpunkt, zu dem der Thread zuletzt aktualisiert wurde (Millisekunden seit UNIX-Epoche). Eine Aktualisierung umfasst das Hinzufügen aller neuen Nachrichten zum Thread.

Nachrichten¶

Feld	Typ	Beschreibung
`message_id`	Ganzzahl	UUID für die Meldung.
`parent_id`	Ganzzahl	UUID für die übergeordnete Nachricht.
`created_on`	Ganzzahl	Zeitpunkt, zu dem die Nachricht erstellt wurde (Millisekunden seit UNIX-Epoche).
`role`	string	Die Rolle, die diese Nachricht erzeugt hat.
`message_payload`	string	Meldungsnutzlast.
`request_id`	string	Anforderungs-ID für die ursprüngliche Nachricht.

Beispiel:

{
  "metadata": {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  },
  "messages": [
    {
      "message_id": 1,
      "parent_id": null,
      "created_on": 1717000000000,
      "role": "user",
      "message_payload": "Hello, I need help.",
      "request_id": "req_001"
    },
    {
      "message_id": 2,
      "parent_id": 1,
      "created_on": 1717000001000,
      "role": "assistant",
      "message_payload": "How can I assist you?",
      "request_id": "req_002"
    }
  ]
}

Copy

Thread aktualisieren¶

POST /api/v2/cortex/threads/{id}

Aktualisiert einen Thread.

Anfrage¶

Pfadparameter¶

Parameter	Typ	Beschreibung
`id`	Ganzzahl	(Erforderlich) UUID für den Thread.

Header der Anforderung¶

Header	Beschreibung
`Authorization`	(Erforderliche) Autorisierungstoken.
`Content-Type`	(Erforderlich) Anwendung/json

Anforderungstext¶

Feld	Typ	Beschreibung
`thread_name`	string	(Optional) Name des Threads.

Beispiel:

{
  "thread_name": "New Thread Name"
}

Copy

Antwort¶

Gibt den Status der Thread-Aktualisierung zurück.

{"status": "Thread xxxx successfully updated."}

Copy

Threads auflisten¶

GET /api/v2/cortex/threads

Listet alle Threads auf, die dem Benutzer gehören.

Anfrage¶

Abfrageparameter¶

Parameter	Typ	Beschreibung
`origin_application`	string	(Optional) Filtern Sie die Liste der Threads nach dieser Ursprungsanwendung. Ohne Angabe dieses Feldes werden alle Threads zurückgegeben.

Header der Anforderung¶

Header	Beschreibung
`Authorization`	(Erforderliche) Autorisierungstoken.
`Content-Type`	(Erforderlich) Anwendung/json

Antwort¶

Gibt ein Array von Thread-Metadatenobjekten zurück.

Thread-Metadaten¶

Feld	Typ	Beschreibung
`thread_id`	Ganzzahl	UUID für den Thread.
`thread_name`	string	Name des Threads.
`origin_application`	string	Der Name der Anwendung, die den Thread erstellt hat.
`created_on`	Ganzzahl	Zeitpunkt, zu dem der Thread erstellt wurde (Millisekunden seit UNIX-Epoche).
`updated_on`	Ganzzahl	Zeitpunkt, zu dem der Thread zuletzt aktualisiert wurde (Millisekunden seit UNIX-Epoche). Eine Aktualisierung umfasst das Hinzufügen aller neuen Nachrichten zum Thread.

Beispiel:

[
  {
    "thread_id": 1234567890,
    "thread_name": "Support Chat",
    "origin_application": "my_app",
    "created_on": 1717000000000,
    "updated_on": 1717000100000
  }
]

Copy

Thread löschen¶

DELETE /api/v2/cortex/threads/{id}

Löscht einen Thread und alle darin enthaltenen Nachrichten.

Anfrage¶

Pfadparameter¶

Parameter	Typ	Beschreibung
`id`	Ganzzahl	(Erforderlich) UUID für den Thread.

Header der Anforderung¶

Header	Beschreibung
`Authorization`	(Erforderliche) Autorisierungstoken.
`Content-Type`	(Erforderlich) Anwendung/json

Antwort¶

Gibt eine Erfolgsmeldung zurück, wenn der Thread gelöscht wurde.

{
  "success": true
}

Copy