API Keys

Roastify never stores your API Key (including storage in our database). Instead, we store a sha256 hash of the API Key. When you attempt to verify the API Key, we hash the API Key you provide and compare it to the stored hash.

Obtain a Key

You can obtain an API Key by activating the Roastify API. Check out the Activate the Roastify API guide to learn how to activate the Roastify API.

Using a Key

You will need to authenticate your requests to access the endpoints in the Roastify API. When making requests, you will need to provide your API Key alongside your request.

curl https://api.roastify.app/v1/... \
    -H "x-api-key: YOUR_API_KEY"

Warning

Do not share your API Key with anyone. If you believe your API Key has been compromised, you can regenerate one at any time. Regenerating your key will invalidate your old key.