Xcribe Docs: Conversation Intelligence & Agents

Ship AI notetakers, sales coaching tools, meeting bots, and agent workflows on one API — with unified data and real-time events.

Quickstart Paths

  • Get a Transcript (3 minutes)
  • Stream Real-Time Events (5 minutes)
  • Webhook Handler (5 minutes)
  • Build a Simple Meeting Agent (beta-ready)

Get Started

Create a free account and generate an API key. Use it with the TypeScript SDK or plain HTTP.

Install SDK
npm install @xcribe/sdk
# or
yarn add @xcribe/sdk
# or
pnpm add @xcribe/sdk

Schedule a meeting

Send a meeting URL and desired options. We handle joining, recording, and transcription.

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const created = await client.createMeeting({
  meetingUrl: 'https://meet.google.com/your-meeting',
  platform: 'meet',
  transcriptionMode: 'post'
});
console.log('Meeting ID:', created.data?.meetingId);

Check meeting status

Poll for current state and metadata (queued, running, completed).

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const status = await client.getMeetingStatus('MEETING_ID');
console.log(status.data);

Get transcript URL

Fetch a pre-signed URL to download the transcript file.

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const res = await client.getMeetingTranscript('MEETING_ID');
console.log(res.data?.screenshotUrl || res.data);

Get audio URL

Download the meeting audio recording via pre-signed URL.

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const audio = await client.getMeetingAudio('MEETING_ID');
console.log(audio.data?.audioUrl);

Get video URL

Download the meeting video recording via pre-signed URL.

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const video = await client.getMeetingVideo('MEETING_ID');
console.log(video.data?.videoUrl);

List meetings

Retrieve recent meetings for your account.

import { Configuration, XcribeApi } from '@xcribe/sdk';

const client = new XcribeApi(
  new Configuration({
    apiKey: process.env.XCRIBE_API_KEY!,
  })
);

const list = await client.listMeetings(1, 20);
console.log(list.data);

Notes & Next Steps

  • Use webhooks to receive real-time notifications when meetings complete.
  • Respect rate limits; contact support for higher throughput.
  • Authenticate with Authorization: ApiKey YOUR_API_KEY on every request.

Ready to build?

Create your free account to generate an API key and access the full reference.

Get Started