Skip to content
Docs
Log InSign Up
APIs and SDKsCore SDK

Using the Acme Core SDK

The @acme/sdk package is a typed TypeScript SDK that lets you reach the resources and methods of the Acme REST API from your own code.

Install the Acme Core SDK

To download and install the SDK, run this command:

Terminal
pnpm i @acme/sdk

Sign-in

Access tokens are needed to sign in and use the SDK. Once you have created a token, you can pass it to the client as shown below:

run.ts
import { Acme } from '@acme/sdk';const acme = new Acme({  token: '<YOUR_TOKEN>',});

Troubleshooting

Make sure you create the token with the right team and scope. If you see permission (403) errors when you already send a valid token, it may be one of these problems:

  • The token has expired. Check the end date of the token in the account settings dashboard.
  • The token cannot reach the right scope, either because it is not tied to the right team or because it lacks the account level access it needs.
  • The resource you are trying to use is not open to that team. For example, access groups are a Scale only feature and you are using a token for a team that is on another plan with fewer features turned on for it.

Endpoints

Browse every SDK method grouped by area.