Docs

Membership OAuth and compliance SDK

For membership-authorized APIs; separate from model PAYG credentials.

When to use this guide

This guide uses membership OAuth and the compliance client in @acosmi/sdk-ts. It is separate from personal PAYG model API keys and balances. For model requests, start with the model API quickstart.

Read available actions

After the user signs in, inspect action, executable, state returned by the service. A scope does not prove an action is available; sensitive operations require the corresponding authorization, identity checks and funding.

ts
import { Client, ScopeComplianceEvidenceRead } from "@acosmi/sdk-ts";

const client = await Client.create({ serverURL: "https://acosmi.com" });
await client.login("Read-only integration", [ScopeComplianceEvidenceRead]);
const capabilities = await client.compliance.getCapabilities();
console.log(capabilities.map(({ action, executable, state }) => ({ action, executable, state })));
import { Client, ScopeComplianceEvidenceRead } from "@acosmi/sdk-ts";

const client = await Client.create({ serverURL: "https://acosmi.com" });
await client.login("Read-only integration", [ScopeComplianceEvidenceRead]);
const capabilities = await client.compliance.getCapabilities();
console.log(capabilities.map(({ action, executable, state }) => ({ action, executable, state })));

Continue with the TypeScript SDK, authentication, and compliance APIs.