Authentication

Sylvester issues your team an API key ID and a secret access key. Every v2 request must send both, in two HTTP headers:

tably-api-key-id: YOUR_API_KEY_ID
tably-secret-access-key: YOUR_SECRET_ACCESS_KEY
  • The header names are exactly tably-api-key-id and tably-secret-access-key. They are not Authorization, not a Bearer token, and not a single api-key header.
  • Both headers are required. If either is missing or wrong, or the key has been disabled, the API returns HTTP 401 unauthorized (v2 errors).
  • Always call the API over HTTPS.

The v1 API uses a different header. See API v1.

Keep your secret access key secret

  • Sylvester can't show your secret access key again. Only a one-way hash is stored. If you lose it, ask Sylvester for a new key.
  • Call the API from your servers, not from mobile or browser apps. Anything shipped inside an app can be extracted. If your mobile or web app needs predictions, send the image to your own backend and call Sylvester from there.
  • Don't commit keys to source control. Load them from environment variables or a secrets manager.
  • If a key may have leaked, contact Sylvester to disable it and issue a new one.