Authentication

Learn how to create, manage, and use API keys for authenticating with Sola's APIs.

All API calls to Sola are authenticated using API keys. This page explains how to create, manage, and use your keys.


Creating API Keys

Each user can generate up to 5 API keys at a time directly from the dashboard. To create a key:

  1. Go to your Sola Dashboard.
  2. Click on the API Keys tab.
  3. Click on Create API Key and give the key a name. Set scopes if the feature is enabled on your account.
  4. Click Create API Key.
🚨

Important: Once created, the platform will not show the API key value again. You must store it securely immediately after creation.

Using API Keys

Sola uses two authentication methods depending on the API surface:

Execution API (Primary)

The Execution API uses Bearer token authentication. Include your API key in the Authorization header:

curl -X PUT 'https://api.sola-solutions.com/v1/execution/queue-remote/{workflowId}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"variableData": {"key": "value"}}'

Browser Context API (Alpha)

The Browser Context API uses a custom header x-sola-api-key:

curl 'https://public-api.sola.ai/alpha/browser-contexts' \
  -H 'x-sola-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

Authentication Errors

If your API key is missing, invalid, or expired, you'll receive one of these responses:

Status CodeMeaning
401 UnauthorizedMissing or invalid API key
403 ForbiddenValid key but insufficient permissions for this resource

Both return a plain text response body (e.g., Unauthorized or Forbidden).

Key Management

  • Each account can hold a maximum of 5 active API keys
  • Keys are UUID-formatted strings
  • You can delete and create new keys at any time from the API Keys tab
  • Deleting a key immediately revokes access for any systems using it