Démarrage rapide de l'API SpeakNotes

Créez une clé, effectuez votre premier appel dans le bac à sable (sandbox), puis passez en production. Quatre étapes, tout en curl.

1. Créer une clé

Ouvrez les paramètres, les clés API et créez-en une. Choisissez le mode sandbox pendant que vous développez : les clés sandbox renvoient une sortie fixe, ne consomment aucun crédit et écrivent dans une bibliothèque séparée que vous pouvez supprimer.

2. Résumer quelque chose dans le sandbox

Chaque route fonctionne avec une clé sandbox. La forme de la réponse est identique à celle de la production, vous pouvez donc développer en toute confiance.

curl -X POST https://api.speaknotes.io/v1/summaries \
  -H "Authorization: Bearer sn_test_YOUR_SANDBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "We agreed to ship the billing fix on Friday. Sam owns the migration.",
    "styleId": "meeting-notes"
  }'

# {
#   "title": "Sandbox meeting notes",
#   "summary": "## Decisions\n- Sandbox mode confirmed working ...",
#   "styleId": "meeting-notes",
#   "creditsCharged": 0,
#   "notice": "Sandbox response: fixed output, no credits charged."
# }

3. Passer à une clé de production

Même requête, clé différente. Celle-ci exécute le modèle réel et facture des crédits, et la réponse vous indique combien ont été utilisés et combien il en reste.

curl -X POST https://api.speaknotes.io/v1/summaries \
  -H "Authorization: Bearer sn_live_YOUR_LIVE_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "...", "styleId": "meeting-notes"}'

# Response headers include:
#   X-Credits-Remaining: 1998
# Response body includes:
#   "creditsCharged": 2

4. Téléverser un fichier

Les médias plus longs s'exécutent en arrière-plan. Créez le téléversement, envoyez le fichier via PUT vers l'URL signée, marquez-le comme terminé, puis interrogez la note jusqu'à ce que son statut soit Terminé.

# 1. create the note and get a signed upload URL
curl -X POST https://api.speaknotes.io/v1/uploads \
  -H "Authorization: Bearer $SPEAKNOTES_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName": "standup.m4a", "contentType": "audio/mp4", "styleId": "meeting-notes"}'

# 2. upload the file straight to the signed URL
curl -X PUT "$UPLOAD_URL" -H "Content-Type: audio/mp4" --data-binary @standup.m4a

# 3. tell SpeakNotes the upload finished (this is where credits are charged)
curl -X POST https://api.speaknotes.io/v1/uploads/$NOTE_ID/complete \
  -H "Authorization: Bearer $SPEAKNOTES_API_KEY"

# 4. poll until status is Done, then read the note
curl https://api.speaknotes.io/v1/notes/$NOTE_ID/status \
  -H "Authorization: Bearer $SPEAKNOTES_API_KEY"

curl https://api.speaknotes.io/v1/notes/$NOTE_ID \
  -H "Authorization: Bearer $SPEAKNOTES_API_KEY"

Découvrir l'API

GET /v1 ne nécessite aucune identification et renvoie les ressources, les portées (scopes), les limites de débit, les coûts en crédits et comment s'authentifier. C'est le moyen le plus rapide pour un agent de s'orienter.

curl https://api.speaknotes.io/v1

# Returns the resources, scopes, rate limits, credit costs,
# and how to authenticate. No credential required.

Ensuite : authentification et portées, codes d'erreur et coût de chaque opération.