Aller au contenu
TellMeHow Documentation
fr

Documentation de l’API

Consommation IA

Consommation IA : 11 opérations de l’API, avec leurs paramètres, leur corps, leurs réponses et un exemple curl.

GET /engagements/{engagement}/costs

Lecture engagements.costs

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}/costs" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/alerts

Lecture usage.alerts

Paramètres

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/workspace/usage/alerts" \
  -H "Authorization: Bearer pat_…"

POST /workspace/usage/alerts/{alert}/acknowledge

Écriture usage.alerts.acknowledge

Paramètres

alert chemin
Identifiant (ULID).

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/workspace/usage/alerts/{alert}/acknowledge" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/budget

Lecture usage.budget

Paramètres

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/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…"

PUT /workspace/usage/budget

Écriture usage.budget.save

Corps application/json

  • monthly_amount number requis

    au moins 1 au plus 1000000

  • warning_ratio number

    au moins 0 au plus 0

  • include_tests boolean

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 -X PUT "https://{votre-espace}.tellmehow.io/api/v1/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"monthly_amount":1}'

DELETE /workspace/usage/budget

Écriture usage.budget.delete

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/workspace/usage/budget" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/dashboard

Lecture usage.dashboard

Paramètres

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/workspace/usage/dashboard" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/entries

Lecture usage.entries

Paramètres

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/workspace/usage/entries" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/export

Lecture usage.export

Paramètres

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/workspace/usage/export" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/options

Lecture usage.options

Paramètres

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/workspace/usage/options" \
  -H "Authorization: Bearer pat_…"

GET /workspace/usage/summary

Lecture usage.summary

Paramètres

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/workspace/usage/summary" \
  -H "Authorization: Bearer pat_…"