Getting started

Obtaining API keys

In order to make requests against the API, you’ll need an API key which you can generate in your Polytomic 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: 2024-02-08'\
>     --header 'Authorization: Bearer 8e5dcfdd-d23d-4e6f-a136-119e1254847b'
API keys are organization-specific

Partner keys

Partner keys are unique tokens that allow you to manage your customers’ organizations.

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

  1. Create a customer organization.
  2. Create a root 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).

To obtain a partner key, contact the Polytomic team at support@polytomic.com.