Skip to main content
SDK access uses an SDK key from the Poelis app. The key is how PoelisClient authenticates.

​
Create a key

  1. Open Settings → SDK Keys
  2. Select Create SDK Key
  3. Copy the key immediately
The key is shown only once, at creation time. Save it before you leave the page.

​
What the key can access

SDK keys are user-bound. The key can access the workspaces, products, items, properties, and files that the user who created it can see in Poelis. A REST API key works differently. It can access every resource in the organization, and only an organization admin can create one. Create a separate key for each person. A shared key ties every script to one user’s permissions, and you cannot revoke it for a single person. Write operations, such as editing draft properties, also require the Editor role on the workspace or product.

​
Store it safely

Save it once

Put the key in a password manager or an environment variable as soon as you create it

Keep it out of Git

Pass the key into PoelisClient at runtime. Leave it out of notebooks you commit and out of source control

One key per user

Each person creates their own key, so access matches that person’s role in Poelis

Revoke when you are done

If a key is compromised or no longer needed, revoke it on the same SDK Keys page

​
Use the key

Continue with the Quick Start if this is your first call.