دليل البدء السريع لـ SpeakNotes API
أنشئ مفتاحاً، وقم بأول استدعاء في بيئة الاختبار، ثم انتقل إلى البيئة الحية. أربع خطوات، كلها باستخدام curl.
1. إنشاء مفتاح
افتح الإعدادات، ثم مفاتيح API وأنشئ واحداً. اختر sandbox أثناء مرحلة البناء: مفاتيح sandbox تعيد مخرجات ثابتة، ولا تستهلك أرصدة، وتكتب في مكتبة منفصلة يمكنك التخلص منها.
2. تلخيص شيء ما في بيئة الاختبار
كل مسار يعمل مع مفتاح sandbox. شكل الاستجابة مطابق للبيئة الحية، لذا يمكنك البناء بناءً عليه بثقة.
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. التبديل إلى مفتاح حي
نفس الطلب، مفتاح مختلف. هذا المفتاح يشغل النموذج الحقيقي ويخصم أرصدة، وتخبرك الاستجابة بعدد الأرصدة المستخدمة والمتبقية.
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": 24. رفع ملف
تعمل الوسائط الأطول في الخلفية. أنشئ عملية الرفع، ثم استخدم PUT للملف إلى الرابط الموقع، وقم بتمييزه كمكتمل، ثم استعلم عن الملاحظة حتى تصبح حالتها 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"اكتشاف الـ API
GET /v1 لا يحتاج إلى اعتماد ويعيد الموارد، والنطاقات، وحدود المعدل، وتكاليف الرصيد، وكيفية المصادقة. إنها أسرع طريقة للوكيل ليتعرف على نفسه.
curl https://api.speaknotes.io/v1 # Returns the resources, scopes, rate limits, credit costs, # and how to authenticate. No credential required.
التالي: المصادقة والنطاقات، رموز الخطأ، وتكلفة كل عملية.