Back to introduction

Authentication

One header, one key. Send it with every request and you're in. Authorization header on each call.

The Authorization header

Prefix your key with Bearer and pass it as the Authorization header:

curl https://api.scarleta.ai/v1/batch/$BATCH_ID \
  -H "Authorization: Bearer $SCARLETA_API_KEY"
Treat your key like a password. Keep it on the server, never ship it in client-side code or commit it to source control, and rotate it if it's ever exposed.

Key prefixes

The first characters of a key tell you what it is. Every key you'll use falls into one of these three tiers:

PrefixTierNotes
scar_live_*Paid, productionYour live key for real, billed traffic.
scar_test_*Paid, stagingA staging key for testing your integration.
sk_free_*Free userIssued with a one-time free token grant to get you started.

Don't have a key yet? Create one for free . The free tier includes a one-time token grant so you can start calling the API right away.

Next steps

Authentication · Scarleta API | Scarleta