Seam API Docs
Search…
Authentication
The Seam API uses API keys to authenticate and authorize requests. You can create a new API key in the Seam dashboard, as well as review and delete the existing one. Note you cannot see the actual key except at the time of creation.
get
https://api.getseam.com/v1
/whoami
Authorization

Create a New Key

You can access the Seam dashboard to create a new key. You must save this key as it will not be shown to you again. Furthermore, Seam has no ability to recover this key if you lose it.

Using Your Key

Authentication to the API is performed via HTTP Bearer Auth.
If you do not include your key when making an API request, or use an incorrect or outdated key, Seam will return an error.

Keeping Your Key Safe

Your secret API key can be used to make any API call on behalf of your account, such as performing actions or retrieving data. Treat your secret API key as you would any other password.
Grant access only to those who need it. Ensure it is kept out of any version control system you may be using. Control access to your key using a password manager or secrets management service. We also plan to eventually introduce restricted API keys for granular permissions.
Make sure to replace YOUR_API_KEY with your actual API key.
If you are running the shell examples in this documentation, you can simply export your API key in your current terminal session as such: export YOUR_API_KEY="<your actual API key>"
Last modified 1mo ago
Copy link