डेवलपर्स

SpeakNotes API क्विकस्टार्ट

एक कुंजी बनाएं, सैंडबॉक्स में अपना पहला कॉल करें, फिर लाइव पर स्विच करें। चार चरण, सभी curl में।

1. एक कुंजी बनाएं

सेटिंग्स, API कुंजियाँ खोलें और एक बनाएं। निर्माण करते समय सैंडबॉक्स चुनें: सैंडबॉक्स कुंजियाँ निश्चित आउटपुट लौटाती हैं, कोई क्रेडिट खर्च नहीं करती हैं, और एक अलग लाइब्रेरी में लिखती हैं जिसे आप हटा सकते हैं।

2. सैंडबॉक्स में कुछ सारांशित करें

हर रूट सैंडबॉक्स कुंजी के साथ काम करता है। रिस्पॉन्स का आकार लाइव के समान है, इसलिए आप आत्मविश्वास के साथ इसके आधार पर निर्माण कर सकते हैं।

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": 2

4. फ़ाइल अपलोड करें

लंबा मीडिया बैकग्राउंड में चलता है। अपलोड बनाएं, फ़ाइल को हस्ताक्षरित URL पर 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.

आगे: प्रमाणीकरण और स्कोप, त्रुटि कोड, और प्रत्येक ऑपरेशन की लागत।