Início rápido da API do SpeakNotes

Crie uma chave, faça sua primeira chamada na sandbox e depois mude para o ambiente real. Quatro passos, tudo em curl.

1. Crie uma chave

Abra Configurações, Chaves de API e crie uma. Escolha sandbox enquanto estiver desenvolvendo: chaves de sandbox retornam saída fixa, não gastam créditos e gravam em uma biblioteca separada que você pode descartar.

2. Resuma algo na sandbox

Todas as rotas funcionam com uma chave de sandbox. O formato da resposta é idêntico ao real, para que você possa desenvolver com confiança.

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. Mude para uma chave real

Mesma solicitação, chave diferente. Esta executa o modelo real e cobra créditos, e a resposta informa quantos foram usados e quantos restam.

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. Fazer upload de um arquivo

Mídias longas são processadas em segundo plano. Crie o upload, envie o arquivo para a URL assinada via PUT, marque-o como concluído e, em seguida, verifique a nota até que seu status seja Concluído.

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

Descobrindo a API

O GET /v1 não precisa de credenciais e retorna os recursos, escopos, limites de taxa, custos de crédito e como autenticar. É a maneira mais rápida para um agente se orientar.

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

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

Próximo: autenticação e escopos, os códigos de erro e quanto custa cada operação.