Aller au contenu
TellMeHow Documentation
fr

Documentation de l’API

Chat de l’audit

Chat de l’audit : 5 opérations de l’API, avec leurs paramètres, leur corps, leurs réponses et un exemple curl.

GET /engagements/{engagement}/chat/threads

Lecture chat.threads.index

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/chat/threads" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/chat/threads

Écriture chat.threads.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • deliverable_version_id string | null
  • title string | null

    longueur : au plus 255

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/chat/threads" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"deliverable_version_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","title":"…"}'

DELETE /engagements/{engagement}/chat/threads/{thread}

Écriture chat.threads.destroy

Paramètres

engagement chemin
Identifiant (ULID).
thread chemin
Identifiant (ULID).

Réponses

  • 204 Supprimé, sans contenu.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/chat/threads/{thread}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/chat/threads/{thread}/messages

Lecture chat.threads.messages.index

Paramètres

engagement chemin
Identifiant (ULID).
thread chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/chat/threads/{thread}/messages" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/chat/threads/{thread}/messages

Écriture chat.threads.messages.store

Paramètres

engagement chemin
Identifiant (ULID).
thread chemin
Identifiant (ULID).

Corps application/json

  • content string requis

    longueur : au plus 2000

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/chat/threads/{thread}/messages" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"content":"…"}'