Authentication

The Birdie API uses Personal access tokens, called API Key, to authenticate requests.

API Keys are tied to the Birdie user account for which they were created, and provides the same level of access that a user would have in its Team workspace. Restricted folders videos and Personal videos will always be excluded from the results.

Get your API key

You can get 2 types of API Keys:

• A Personal API Key linked to your profile (if your profile is removed the token will be deleted). → go to your Profile settings to generate a Personal API Key.

• A Workspace API Key that will authenticate on behalf the whole Workspace, this key won't be linked to a particular user profile. Note: You need to be a Team administrator to issue these keys. → go to your Integrations settings to generate a Workspace API Key.

How to use your API key

Once you have created your API Key, you can use it to make requests to the API. Requests are authenticated using HTTP Bearer Authentication. You must provide the access token in the Authorization header:

Authorization: Bearer {API_KEY}