SpeakNotes API hızlı başlangıç

Bir anahtar oluşturun, sandbox ortamında ilk çağrınızı yapın ve ardından canlı ortama geçin. Hepsi curl ile dört adım.

1. Bir anahtar oluşturun

Ayarlar, API anahtarları bölümünü açın ve bir tane oluşturun. Geliştirme yaparken sandbox'ı seçin: sandbox anahtarları sabit çıktı döndürür, kredi harcamaz ve atabileceğiniz ayrı bir kütüphaneye yazar.

2. Sandbox'ta bir şeyi özetleyin

Her rota bir sandbox anahtarıyla çalışır. Yanıt şekli canlı ortamla aynıdır, bu nedenle güvenle geliştirme yapabilirsiniz.

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. Canlı bir anahtara geçin

Aynı istek, farklı anahtar. Bu anahtar gerçek modeli çalıştırır ve kredi harcar; yanıt size kaç kredi kullanıldığını ve ne kadar kaldığını söyler.

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. Bir dosya yükleyin

Daha uzun medya dosyaları arka planda işlenir. Yüklemeyi oluşturun, dosyayı imzalı URL'ye PUT ile gönderin, tamamlandı olarak işaretleyin ve ardından durumu Done olana kadar notu sorgulayın.

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

API'yi keşfetme

GET /v1 herhangi bir kimlik bilgisi gerektirmez ve kaynakları, kapsamları, hız sınırlarını, kredi maliyetlerini ve nasıl kimlik doğrulaması yapılacağını döndürür. Bir ajanın kendini yönlendirmesi için en hızlı yoldur.

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

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

Sırada: kimlik doğrulama ve kapsamlar, hata kodları ve her işlemin maliyeti.