Aden
SDK

Quickstart

Install the SDK, authenticate, and make your first request.

1. Install

bun add @adenspace/sdk
# or
npm install @adenspace/sdk
# or
pnpm add @adenspace/sdk

2. Create a team API key

API keys are scoped to a single team. Get one from:

  1. Open your team in the Aden web app.
  2. Settings → API Keys.
  3. Click New key, copy the value (shown once, starts with aden_live_).

Treat API keys like passwords. Anyone with the key can read and write to your team. Store them in a secret manager, never commit them to git.

3. Create a client

lib/aden.ts
import { createAdenClient } from '@adenspace/sdk'

export const aden = createAdenClient({
    apiKey: process.env.ADEN_API_KEY,
})

4. Make a request

Every path in the API is mirrored on the client. Autocomplete guides you.

const { data: tracks, error } = await aden.api.v1.tracks.get({
    query: { limit: 10 },
})

if (error) {
    console.error(error.status, error.value)
    process.exit(1)
}

for (const track of tracks) {
    console.log(`${track.title} — ${track.status}`)
}

Path parameters are function calls:

const { data: track } = await aden.api.v1.tracks({ id: 42 }).get()

POST bodies go as the first argument:

const { data: created } = await aden.api.v1.tracks.post({
    title: 'New demo',
    teamId: 123,
})

5. Check the API is up

if (!(await aden.ping())) {
    throw new Error('Aden API is unreachable')
}

Custom base URL

Point the client at local dev, a staging environment, or self-hosted Aden:

const aden = createAdenClient({
    baseUrl: 'http://localhost:3000',
    apiKey: process.env.ADEN_API_KEY,
})

Next

On this page