Panduan cepat API SpeakNotes

Buat kunci, lakukan panggilan pertama Anda di sandbox, lalu beralih ke live. Empat langkah, semuanya menggunakan curl.

1. Buat kunci

Buka Pengaturan, kunci API, dan buat satu kunci. Pilih sandbox saat Anda sedang membangun: kunci sandbox mengembalikan output tetap, tidak menghabiskan kredit, dan menulis ke pustaka terpisah yang bisa Anda hapus.

2. Ringkas sesuatu di sandbox

Setiap rute berfungsi dengan kunci sandbox. Bentuk responsnya identik dengan live, sehingga Anda dapat membangun aplikasi di atasnya dengan percaya diri.

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. Beralih ke kunci live

Permintaan yang sama, kunci berbeda. Kunci ini menjalankan model asli dan memotong kredit, serta responsnya memberi tahu Anda berapa banyak yang telah digunakan dan berapa sisanya.

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. Unggah file

Media yang lebih panjang berjalan di latar belakang. Buat unggahan, lakukan PUT file ke URL yang ditandatangani, tandai sebagai selesai, lalu periksa catatan tersebut hingga statusnya menjadi Selesai.

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

Menjelajahi API

GET /v1 tidak memerlukan kredensial dan mengembalikan sumber daya, cakupan (scopes), batas kecepatan, biaya kredit, dan cara melakukan otentikasi. Ini adalah cara tercepat bagi agen untuk menyesuaikan diri.

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

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

Selanjutnya: otentikasi dan cakupan, kode kesalahan, dan biaya setiap operasi.