Authorization header.
Get your key from your API settings page.
Include the key in the Authorization header of every request:
Accepted header formats
The bare key is the canonical form. If your HTTP client or a generated SDK insists on an auth scheme, these all authenticate too, and the scheme is case-insensitive:Keys and workspaces
Your API key is personal: requests act as your user, and you can access any workspace you’re a member of. Most endpoints take aworkspace_id parameter
to select which one — list yours with GET /workspaces.
When authentication fails
Every failure returns401 Unauthorized with an error whose
code tells you which kind it is:
A request with no valid key has no pin: send the
Happyscribe-Version header to get this
body.
A request that names no workspace when the endpoint needs one is a 400, not a 401 —
see Errors.
Versioning
Your key is pinned to the API version that was current the first time it was used, and every response says which version served it. See Versioning for theHappyscribe-Version header and how upgrades work.