Skip to main content
You can call the Dust API in two ways:
  • With an API key. The key acts on its own, not as a person. What it can do depends on its access scope and on the Spaces and Pods added to it. Admins create keys in Admin > Developers: see API keys.
  • As a signed-in user, for example after dust login in the Dust CLI. The request can do what that person can do in Dust, based on their role and permissions.
Most calls work with any API key. This page lists the ones that don’t.

API key scopes

Older keys can show the Read & write scope, which you can’t choose for new keys.

Calls that need the Admin scope

With another scope, these calls return 403. Unless the details say otherwise, a signed-in user needs the Admin role.

Calls that write to a Space or a Pod

These calls need write access to the Space or the Pod. Add it under Spaces and Pods when you create the key. You can’t write to a connection through the API: Dust syncs its content from the source.

Calls that need a signed-in user

API keys can’t make these calls, whatever their scope. They return 400, 401, or 403.

Conversations

Which conversations a key can open depends on who they’re shared with. See Conversation sharing.