Authentication - Paradime

Before you can use the GraphQL API, you need to generate API credentials. Paradime supports two authentication methods:

Account API Keys (recommended) — a single Bearer token that can access multiple workspaces. Pass the Authorization: Bearer <token> header together with the X-Paradime-Workspace header to select the target workspace.
Workspace API Keys [legacy] — workspace-scoped API Key and API Secret credentials, passed in the X-API-KEY and X-API-SECRET headers.

Both methods use the same API Endpoint.

Example request

Send every request as a POST to your API endpoint with the Content-Type: application/json header and your credentials. Using an Account API Key (recommended):

curl -X POST "<YOUR_API_ENDPOINT>" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "X-Paradime-Workspace: <YOUR_WORKSPACE_UID>" \
  -d '{"query": "query { apiKeyIdentity { isValid capabilities } }"}'

import requests

response = requests.post(
    "<YOUR_API_ENDPOINT>",
    headers={
        "Content-Type": "application/json",
        "Authorization": "Bearer <YOUR_API_KEY>",
        "X-Paradime-Workspace": "<YOUR_WORKSPACE_UID>",
    },
    json={"query": "query { apiKeyIdentity { isValid capabilities } }"},
)
print(response.json())

With legacy Workspace API Keys, pass the key and secret in place of the Bearer token:

curl -X POST "<YOUR_API_ENDPOINT>" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: <YOUR_API_KEY>" \
  -H "X-API-SECRET: <YOUR_API_SECRET>" \
  -d '{"query": "query { apiKeyIdentity { isValid capabilities } }"}'

import requests

response = requests.post(
    "<YOUR_API_ENDPOINT>",
    headers={
        "Content-Type": "application/json",
        "X-API-KEY": "<YOUR_API_KEY>",
        "X-API-SECRET": "<YOUR_API_SECRET>",
    },
    json={"query": "query { apiKeyIdentity { isValid capabilities } }"},
)
print(response.json())

A successful response confirms the key is valid and lists its capabilities:

{ "data": { "apiKeyIdentity": { "isValid": true, "capabilities": ["..."] } } }

Examples:

Audit Logs API

Bolt API

User Management API

Workspace Management API

Related topics

Key-pair authentication Starburst/Trino Microsoft Fabric Airbyte CLI Ingest Google Sheets into Snowflake with dltHub

⌘I