Developer API

API Documentation

Integrate allstrm into your applications and workflows with our RESTful API.

Quick Start

1Get your API key from Dashboard → Settings → API
2Base URL: https://allstrm.com/api
3Include Authorization: Bearer YOUR_API_KEY in all requests

curl -X POST https://allstrm.com/api/rooms \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Product Update",
    "mode": "studio",
    "engine": "livekit"
  }'

API Keys

Secure authentication with API keys. Create multiple keys with different permissions.

Webhooks

Real-time notifications for broadcast events, recording completion, and clip generation.

Rate Limiting

Generous rate limits with clear headers. 1000 requests/minute on Pro plans.

Async Operations

Long-running operations return immediately with job IDs. Poll or use webhooks for status.

API Endpoints

Rooms

POST/api/roomsCreate a meeting or studio room

GET/api/roomsList rooms for the signed-in workspace

GET/api/rooms/{roomId}Get room details

PATCH/api/rooms/{roomId}Update room settings

POST/api/rooms/{roomId}/tokenCreate a LiveKit join token

POST/api/rooms/{roomId}/inviteCreate or manage guest invites

GET/api/rooms/{roomId}/chatLoad room chat messages

Recordings

POST/api/recording/startStart cloud recording for a room

POST/api/recording/stopStop an active recording

POST/api/egress/startStart LiveKit egress

POST/api/egress/stopStop LiveKit egress

AI Clips

GET/api/clipsList generated clips

POST/api/clipsCreate a clip record

GET/api/clips/{id}Get clip details

PATCH/api/clips/{id}Update clip metadata

DELETE/api/clips/{id}Delete a clip

POST/api/clips/ai-generateGenerate clips from a recording

Destinations

GET/api/destinationsList connected platforms

POST/api/destinationsAdd RTMP or OAuth destination

POST/api/destinations/{id}/stopStop streaming to a destination

GET/api/oauth/providersList OAuth providers and configuration status

Billing and Limits

GET/api/tier-limitsList pricing tiers and feature limits

GET/api/users/me/tierGet the signed-in user tier

POST/api/stripe/checkoutCreate a Stripe checkout session

GET/api/stripe/pricingLoad active Stripe pricing data

JavaScript/TypeScript SDK

import { AllstrmClient } from '@allstrm/sdk';

const client = new AllstrmClient({
  apiKey: process.env.ALLSTRM_API_KEY
});

// Create a new room
const room = await client.rooms.create({
  name: 'Weekly Product Update',
  mode: 'studio',
  engine: 'livekit'
});

// Create a token when a participant joins
const token = await client.rooms.createToken(room.id);

// Listen for events via webhooks
client.webhooks.on('broadcast.ended', async (event) => {
  console.log('Broadcast ended:', event.data.id);
  
  // Auto-generate AI clips
  await client.clips.generate({
    recordingId: event.data.recordingId,
    count: 5
  });
});

Example Response

{
  "id": "room_2xaK9mNop",
  "name": "Weekly Product Update",
  "mode": "studio",
  "engine": "livekit",
  "status": "idle",
  "created_at": "2025-01-15T10:30:00Z",
  "studio_url": "https://allstrm.com/studio/room_2xaK9mNop"
}

Webhook Events

Subscribe to these events to receive real-time notifications about your broadcasts.

Broadcast Events

broadcast.created
broadcast.started
broadcast.ended
broadcast.failed

Recording Events

recording.ready
recording.deleted

Clip Events

clip.generated
clip.failed

Guest Events

guest.joined
guest.left

Need Help?

Our developer support team is here to help you integrate allstrm into your application.

Contact Developer Support View on GitHub