API Threads¶

Utilisez cette API pour créer des threads utilisés pour interagir avec les Agents Cortex.

Créer un thread¶

POST /api/v2/cortex/threads

Crée un nouveau thread et renvoie l’UUID du thread.

Requête¶

En-têtes de requête¶

En-tête	Description
`Authorization`	(Obligatoire) Jeton d’autorisation. Pour plus d’informations, voir Authentification.
`Content-Type`	(Obligatoire) application/json

Corps de requête¶

Le corps de requête peut inclure le champ suivant :

Champ	Type	Description
`origin_application`	string	(Facultatif) Nom de l’application qui a créé le thread. Permet de regrouper les threads par application. Limité à 16 octets.

Exemple :

{
  "origin_application": "my_app"
}

Copy

Réponse¶

Renvoie l’UUID du thread en tant que chaîne.

"1234567890"

Copy

Décrire un thread¶

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

Décrit un thread et renvoie un lot de messages dans ce thread, en fonction de page_size et last_message_id, par ordre décroissant de création. Cette requête ne fonctionne que si l’ID du thread appartient à l‘utilisateur.

Requête¶

Paramètres de chemin¶

Paramètre	Type	Description
`id`	entier	(Obligatoire) UUID pour le thread.

Paramètres de requête¶

Paramètre	Type	Description
`page_size`	entier	(Facultatif) Nombre de messages à renvoyer (par défaut : 20, maximum : 100).
`last_message_id`	entier	(Facultatif) ID du dernier message reçu. Utilisé pour définir le décalage pour le lot suivant. Peut être vide pour le premier lot de messages.

En-têtes de requête¶

En-tête	Description
`Authorization`	(Obligatoire) Jeton d’autorisation.
`Content-Type`	(Obligatoire) application/json

Réponse¶

Renvoie un objet de métadonnées du thread et un tableau de messages.

Champ	Type	Description
metadata	objet	Métadonnées du thread, y compris le nom, l’application qui a créé le thread, et l’heure à laquelle il a été créé.
`messages`	tableau	Tableau d’objets de message.

metadata¶

Champ	Type	Description
`thread_id`	entier	UUID pour le thread.
`thread_name`	string	Nom du thread.
`origin_application`	string	Nom de l’application qui a créé le thread.
`created_on`	entier	Heure à laquelle le thread a été créé (millisecondes depuis l’époque UNIX).
`updated_on`	entier	Heure de la dernière mise à jour du thread (millisecondes depuis l’époque UNIX). Une mise à jour comprend l’ajout de tout nouveau message au thread.

Messages¶

Champ	Type	Description
`message_id`	entier	UUID pour le message.
`parent_id`	entier	UUID pour le message parent.
`created_on`	entier	Heure à laquelle le message a été créé (millisecondes depuis l’époque UNIX).
`role`	string	Rôle qui a généré ce message.
`message_payload`	string	Charge utile du message.
`request_id`	string	ID de requête pour le message d’origine.

Exemple :

{
  "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

Mettre à jour un thread¶

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

Met à jour un thread.

Requête¶

Paramètres de chemin¶

Paramètre	Type	Description
`id`	entier	(Obligatoire) UUID pour le thread.

En-têtes de requête¶

En-tête	Description
`Authorization`	(Obligatoire) Jeton d’autorisation.
`Content-Type`	(Obligatoire) application/json

Corps de requête¶

Champ	Type	Description
`thread_name`	string	(Facultatif) Nom du thread.

Exemple :

{
  "thread_name": "New Thread Name"
}

Copy

Réponse¶

Renvoie l’état de la mise à jour du thread.

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

Copy

Répertorier des threads¶

GET /api/v2/cortex/threads

Répertorie tous les threads appartenant à l’utilisateur.

Requête¶

Paramètres de requête¶

Paramètre	Type	Description
`origin_application`	string	(Facultatif) Filtre la liste des threads de cette application d’origine. Si ce champ n’est pas spécifié, tous les threads sont renvoyés.

En-têtes de requête¶

En-tête	Description
`Authorization`	(Obligatoire) Jeton d’autorisation.
`Content-Type`	(Obligatoire) application/json

Réponse¶

Renvoie un tableau d’objets de métadonnées de thread.

Métadonnées de thread¶

Champ	Type	Description
`thread_id`	entier	UUID pour le thread.
`thread_name`	string	Nom du thread.
`origin_application`	string	Nom de l’application qui a créé le thread.
`created_on`	entier	Heure à laquelle le thread a été créé (millisecondes depuis l’époque UNIX).
`updated_on`	entier	Heure de la dernière mise à jour du thread (millisecondes depuis l’époque UNIX). Une mise à jour comprend l’ajout de tout nouveau message au thread.

Exemple :

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

Copy

Supprimer un thread¶

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

Supprime un thread et tous les messages de ce thread.

Requête¶

Paramètres de chemin¶

Paramètre	Type	Description
`id`	entier	(Obligatoire) UUID pour le thread.

En-têtes de requête¶

En-tête	Description
`Authorization`	(Obligatoire) Jeton d’autorisation.
`Content-Type`	(Obligatoire) application/json

Réponse¶

Renvoie une réponse de réussite si le thread est supprimé.

{
  "success": true
}

Copy