Set up your account and make your first request in under ten minutes.
In a hurry? Install with
npm install @your-org/sdk, setYOUR_PRODUCT_API_KEYin your environment, then callclient.resource.create({ name: "Hello" }). That's it.
If you haven't already, create an account. Once you've verified your email, you'll land on your dashboard.
From the dashboard, navigate to Settings → API and copy your API key. You'll need it in the next step.
Warning: Keep your API key private. Do not commit it to source control or expose it in client-side code. Use environment variables instead.
The platform ships with an official SDK for [Language A] and [Language B]. You can also use the REST API directly if you prefer.
# npm
npm install @your-org/sdk
# yarn
yarn add @your-org/sdk
# pnpm
pnpm add @your-org/sdkIf you're working without a package manager, you can load the SDK via CDN:
<script src="https://cdn.yourdomain.com/sdk/v1/sdk.min.js"></script>Set your API key as an environment variable so it's available to your application:
# .env.local
YOUR_PRODUCT_API_KEY=your_api_key_hereThen initialize the SDK:
import { Client } from "@your-org/sdk"
const client = new Client({
apiKey: process.env.YOUR_PRODUCT_API_KEY,
})The client will throw a MissingApiKeyError at initialization time if the key is absent, so you'll catch misconfigurations early.
With the client initialized, you're ready to make your first request:
const result = await client.resource.create({
name: "My first resource",
description: "Created via the getting started guide.",
})
console.log(result.id) // res_xxxxxxxxxxxxA successful response returns a resource object with a unique id. Hold onto this — you'll use it to fetch, update, and delete the resource later.
Head back to your dashboard. You should see the resource you just created listed under [Section name]. From here you can inspect it, edit it, or delete it without touching code.
Now that everything is working: