Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt

Use this file to discover all available pages before exploring further.

Every request made to the Sift API through REST or gRPC requires an API key for authentication and a base URL that identifies the specific Sift API server your project is connected to.

​
How API keys work

API keys in Sift are user-associated credentials used to authenticate requests to the Sift API. Each key inherits the permissions of the user it is associated with and remains valid indefinitely unless explicitly deleted. All API keys are listed under the API Keys interface, where they can also be removed. When interacting with the Sift API:
  • For REST requests using the Bearer authentication scheme, the API key must be included in the HTTP request authorization header.
  • For gRPC requests, the API key must be passed as a metadata field, also using the authorization header with the Bearer scheme.
API keys can be created and managed either through the Sift UI or programmatically via the Sift API.

​
Create an API key

  1. Click your profile icon.
  2. Select Manage.
  3. In the Manage navigation menu, click API Keys.
  4. Click Create API Key.
  5. In the Name box, enter a name for the API key.
  6. In the User list, select the user email to link to the API key.
  7. Click Create.
    Key value: Upon creation, the key value is displayed once and cannot be retrieved later. Store it securely using a secret management tool of your choice.

​
Obtain the base URL

The REST or gRPC base URL can be obtained through the Sift UI. The base URL tells your application exactly where to send API requests and ensures that your requests reach the correct environment.
  1. Click your profile icon.
  2. Select Manage.
  3. In the Manage navigation menu, click API Keys.