API

English

API : bien démarrer

Posez des questions sur vos données Odoo, PostgreSQL ou MySQL depuis votre code, vos scripts et vos automatisations, et recevez la réponse en texte, en tableaux et en chiffres. En lecture seule : l'API ne modifie jamais vos données.

Ce que fait l'API

  • Posez une question en langage courant sur l'une de vos connexions, et recevez la réponse en texte, en json structuré (tableaux et chiffres) ou sous forme de courriel prêt à envoyer.
  • Lisez une réponse plus tard quand elle prend plus de temps que vous ne voulez attendre.
  • Listez vos connexions. Chaque nouvel espace de travail a aussi des connexions d'exemple aux données fictives, pour essayer l'API avant de connecter les vôtres.

Seule une question coûte un prompt : 1 prompt par réponse. Tous les autres appels sont gratuits.

Créer une clé API

Obtenir une clé API

Seuls les propriétaires et les admins de l'espace de travail peuvent créer des clés. La clé n'est affichée qu'une fois : copiez-la à ce moment-là.

Envoyez la clé à chaque requête, en x-api-key: <clé> ou Authorization: Bearer <clé>. Une clé appartient à un seul espace de travail. Gardez-la secrète : toute personne qui l'a peut poser des questions sur votre espace.

Votre premier appel

1. Vérifiez la clé. La réponse indique votre espace de travail et les prompts qu'il lui reste (gratuit).

curl https://speaktoyourdatabase.com/api/v1/context \
  -H "x-api-key: $STYD_API_KEY"

2. Posez une question. connectionId est un id de GET /connections (dans un nouvel espace, essayez une connexion d'exemple). Cela utilise 1 prompt.

curl "https://speaktoyourdatabase.com/api/v1/chat?format=json" \
  -H "x-api-key: $STYD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "connectionId": 3, "prompt": "Combien y a-t-il de clients ?" }'

La réponse arrive en moins de 90 secondes (200). Si elle prend plus de temps, vous recevez 202 avec un runId : appelez GET /runs/{runId}?wait=30 jusqu'à ce que son status soit complete.

Aller plus loin

Chaque point d'accès, champ, code d'erreur et limite est décrit dans la référence de l'API (en anglais), où vous pouvez aussi essayer chaque requête avec votre clé. Pas de code ? Utilisez l'app Make.