PermuteDocs
Dashboard

Get started

Authentication

Create a Permute API key, authenticate with a bearer token, select a workspace, and apply least-privilege access grants.

Create an API key

In app.permute.ai, open Organization Settings, select API Keys, and choose Create API Key. Copy the key when it is created; it is shown once.

Authenticate a request

Send the key in the standard bearer authorization header.

http
Authorization: Bearer $PERMUTE_API_KEY

Choose a workspace

Workspace-scoped keys infer their workspace. Organization-scoped keys must include the workspace ID on data operations. Workspace IDs begin with wksp_.

http
Authorization: Bearer $PERMUTE_API_KEY
X-Workspace-Id: $PERMUTE_WORKSPACE_ID
Content-Type: application/json

Permissions

A valid key does not bypass permissions. Each request is limited to the resources and read, write, or admin grants assigned to that key. A list endpoint only returns resources the key can read.

Use least privilege. Give production integrations only the workspaces and actions they require.