Obtaining API keys

API Keys

In order to make requests against the API, you'll need an API key which you can generate in your user settings panel. The API key should be passed as an Authorization header.

Example
With an API key of 8e5dcfdd-d23d-4e6f-a136-119e1254847b, the header would look like:

Authorization: Bearer 8e5dcfdd-d23d-4e6f-a136-119e1254847b

To validate the token, you can make a request to the identity endpoint. For example,

curl --request GET \
     --url https://app.polytomic.com/api/me \
     --header 'accept: application/json' \
     --header 'X-Polytomic-Version: 2022-12-12'\
     --header 'Authorization: Bearer 8e5dcfdd-d23d-4e6f-a136-119e1254847b'

Partner Keys

Partner keys are special tokens that allow you to manage organization and users. They are most frequently used as part of Polytomic Connect, Polytomic's embed API.

These keys operate the same way API keys work. However, they are limited to only the Organization and User endpoints. A typical workflow for partners often looks like:

  1. Create an organization.
  2. Create a user in that organization.
  3. Use the "Create API key" endpoint to mint an API key for the newly created user.
  4. Use that API key to create organization-level resources (e.g. connections, models, syncs).

📘

Obtaining a partner key

Please contact [email protected] to obtain your partner key.

Example
With an partner key of d1ca95d3-2869-4c92-b88f-b7315ebde290, the header would look like:

Authorization: Bearer d1ca95d3-2869-4c92-b88f-b7315ebde290

To validate the token, you can make a request to the identity endpoint. For example,

curl --request GET \
     --url https://app.polytomic.com/api/me \
     --header 'accept: application/json' \
     --header 'X-Polytomic-Version: 2022-12-12'\
     --header 'Authorization: Bearer d1ca95d3-2869-4c92-b88f-b7315ebde290'

🚧

Allowed endpoints

Partner keys are limited to only the Organization and User endpoints