Get started

Quickstart

Install the Permute TypeScript SDK, authenticate an API key, connect a workspace, and make your first trusted data request.

Before you start

Create an API key in Permute and copy the workspace ID from the active workspace URL. Keep both values in server-side environment variables.

Keep API keys private. Never expose them in browser code or commit them to source control.

1. Install the SDK

Install the public @permute/sdk package from npm.

bash

bun add @permute/sdk

2. Configure your environment

bash

PERMUTE_API_KEY=pk_live_...
PERMUTE_WORKSPACE_ID=wksp_...

3. Make your first request

Derive a workspace client and list the datasets and connectors available to the key.

typescript

import { PermuteClient } from '@permute/sdk';

const orgClient = new PermuteClient({
  apiKey: process.env.PERMUTE_API_KEY!,
});

const client = orgClient.withWorkspace(
  process.env.PERMUTE_WORKSPACE_ID!,
);

const sources = await client.sources.list();
console.log(sources.items);

Next steps

Ask a business questionRun a durable interpreted analysis.Upload a fileAdd a CSV, workbook, or document dataset.Use a managed databasePublish table schemas, read records, and handle write conflicts.Create a business actionPublish a typed handler with an approved database or connector scope.Build and deploy an appUpload a frontend and connect it to governed queries and actions.Browse the APIInspect every request and response contract.