Skip to main content

​
Overview

Authenticate all Poolside API requests using Bearer tokens. Poolside automatically audits all requests to comply with customer security posture.
API keys are secrets. Store them securely and never commit them to source control.
Poolside supports two types of API keys, developer API keys and organization API keys.

​
Developer API keys

  • Linked to individual user accounts
  • Inherit the permissions of the user who created them
  • Managed at the user level
  • Tied to the lifecycle of the user account
  • Intended for individual development and testing workflows

​
Organization API keys

  • Linked to service accounts
  • Inherit the permissions of their team, independent of individual users
  • Managed at the organization level
  • Remain active even if you remove the creator
  • Designed for organizational key management

​
Create a developer API key for yourself

Prerequisites
  • You can access your Poolside deployment.
Steps
  1. Sign in to your Poolside deployment, for example: https://<api-domain>
  2. Click your username in the bottom left, then select Developer API Keys.
  3. Click New API Key.
  4. Enter a name for the API key.
  5. Click Create.
  6. Copy the generated key and store it securely.
The full API key value is shown only once. Store it securely.
API keys typically have a ps-xxxxx format.

​
Create an API key for a team in your organization

Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Settings > https://mintcdn.com/poolside/fyUKzbRkxqIwtXwu/images/icons/key-icon.svg?fit=max&auto=format&n=fyUKzbRkxqIwtXwu&q=85&s=b4dba51791f4df5d4e8732dbfe2459c9 API Keys.
  2. Click New API Key.
  3. Select the team that the service account for this key belongs to.
  4. Enter a name for the API key.
  5. Click Create.
  6. Copy the generated key and store it securely.
The full API key value is shown only once. Store it securely.
API keys typically have a ps-xxxxx format.

​
Use an API key

Use your API key with HTTP Bearer authentication. The following example uses curl to list all available models: 
curl --request GET \
  --url https://<api.domain.com>/openai/v1/models \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Authorization: Bearer <api-key>'
Replace <api-key> with your API key.