Hướng dẫn nhanh API SpeakNotes

Tạo khóa, thực hiện cuộc gọi đầu tiên trong sandbox, sau đó chuyển sang môi trường thực. Bốn bước, tất cả đều dùng curl.

1. Tạo khóa

Mở Cài đặt, khóa API và tạo một khóa. Chọn sandbox khi bạn đang xây dựng: khóa sandbox trả về kết quả cố định, không tốn tín dụng và ghi vào một thư viện riêng biệt mà bạn có thể xóa bỏ.

2. Tóm tắt nội dung trong sandbox

Mọi lộ trình đều hoạt động với khóa sandbox. Hình dạng phản hồi giống hệt với môi trường thực, vì vậy bạn có thể tự tin xây dựng dựa trên nó.

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. Chuyển sang khóa thực

Cùng một yêu cầu, khóa khác. Khóa này chạy mô hình thực và trừ tín dụng, phản hồi sẽ cho bạn biết đã sử dụng bao nhiêu và còn lại bao nhiêu.

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ải tệp lên

Phương tiện dài hơn chạy trong nền. Tạo yêu cầu tải lên, PUT tệp vào URL đã ký, đánh dấu hoàn tất, sau đó thăm dò ghi chú cho đến khi trạng thái là Done.

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

Khám phá API

GET /v1 không cần thông tin xác thực và trả về các tài nguyên, phạm vi, giới hạn tốc độ, chi phí tín dụng và cách xác thực. Đây là cách nhanh nhất để một tác nhân tự định hướng.

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

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

Tiếp theo: xác thực và phạm vi, mã lỗi và chi phí của từng thao tác.