Quickstart

1. Create credentials

In the app, open Settings -> Integrations -> API and create a tenant API key with the smallest scope set your integration needs.

Store the full secret immediately. It is shown once and should live only in your server-side secret manager or deployment environment.

---

2. Call the API

curl https://api.instaclaim.app/v1 \
  -H "X-API-Key: $INSTACLAIM_API_KEY"

Use GET /v1/auth/context to confirm which scopes, plan gates, and rate-limit tier the credential has.

---

3. Use the SDK

Install the official TypeScript SDK:

npm install @instaclaim/sdk

import { InstaClaimClient } from '@instaclaim/sdk';

const instaClaim = new InstaClaimClient({
  apiKey: process.env.INSTACLAIM_API_KEY,
});

const capabilities = await instaClaim.getCapabilities();
const { data: organization } = await instaClaim.getOrganization();

---

4. Add webhooks or MCP

Use webhooks for outbound events and MCP for AI-agent workflows that need a curated, scoped tool surface.