Szybki start API SpeakNotes

Utwórz klucz, wykonaj pierwsze wywołanie w sandboxie, a następnie przełącz się na tryb produkcyjny. Cztery kroki, wszystko w curl.

1. Utwórz klucz

Otwórz Ustawienia, Klucze API i utwórz jeden. Wybierz sandbox na czas tworzenia: klucze sandbox zwracają stałe dane wyjściowe, nie zużywają kredytów i zapisują do oddzielnej biblioteki, którą możesz usunąć.

2. Podsumuj coś w sandboxie

Każda ścieżka działa z kluczem sandbox. Struktura odpowiedzi jest identyczna jak w trybie produkcyjnym, więc możesz na niej bezpiecznie budować.

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. Przełącz się na klucz produkcyjny

To samo żądanie, inny klucz. Ten uruchamia prawdziwy model i pobiera kredyty, a odpowiedź informuje, ile ich zużyto i ile pozostało.

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. Prześlij plik

Dłuższe media są przetwarzane w tle. Utwórz przesyłanie, wyślij plik metodą PUT pod podpisany adres URL, oznacz jako zakończone, a następnie sprawdzaj status notatki, aż będzie gotowa.

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

Odkrywanie API

GET /v1 nie wymaga poświadczeń i zwraca zasoby, zakresy, limity zapytań, koszty kredytów oraz sposób uwierzytelniania. To najszybszy sposób, aby agent mógł się zorientować.

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

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

Dalej: uwierzytelnianie i zakresy, kody błędów oraz koszty poszczególnych operacji.