Spot AI's API leverages key-based authentication for access. An organization admin can generate an API key through the API settings page.

Simply click "Create New Key", name your API key, adjust the expiration date if necessary (defaults to 1 year from creation), and click "Generate Key".

Once generated, you can access your API key. This is only accessible one time, so make sure you copy the key and store it prior to closing this modal.

Once saved, you can make changes to the API key or delete the key by clicking on the API key in the table and making the necessary changes.

To use the API, it's important to add authorization by clicking "Add new" above the authorizations table. In the "Role" field, select the role that grants access to the necessary resources. If you're unsure which role to choose, we recommend selecting the Owner role, which provides full access. Optionally, you can specify a scope to limit access to specific resources.

If you would like to limit the scope of the API or have any security questions, please reach out to your Customer Success Manager (CSM) representative.

We provide a CURL request you can paste into a terminal window to test your API key, or you can paste your API key into the header bearer token anywhere on our API documentation to run a test call.