Developer documentatie

Bouw voice agents
in TypeScript

Een TypeScript-SDK, ondertekende webhooks en een gedocumenteerde REST API. Gemaakt door developers, voor developers.

terminal
npm install hmsovereign
# or
pnpm add hmsovereign
# or
bun add hmsovereign
Quickstart

Vijf minuten van install tot eerste gesprek

01

Installeer de SDK

Voeg het hmsovereign-package toe aan je project.

terminal
npm install hmsovereign
# or
pnpm add hmsovereign
# or
bun add hmsovereign
02

Initialiseer de client

Gebruik je organisatie API-key uit het dashboard.

index.ts
import { HMSSovereign } from "hmsovereign"

const client = new HMSSovereign({
  apiKey: process.env.VOICEDOCK_API_KEY!,
})

// List existing assistants
const assistants = await client.assistants.list()
console.log(`You have ${assistants.length} assistants`)
03

Maak je eerste assistant

Configureer provider, stem en system prompt.

assistant.ts
const assistant = await client.assistants.create({
  name: "Customer Support",
  first_message: "Hi, how can I help you today?",
  llm_config: {
    provider: "openai",
    model: "gpt-5.4-mini",
    messages: [
      {
        role: "system",
        content: `You are a helpful support agent
for an e-commerce store. Be concise.`,
      },
    ],
  },
  stt_config: {
    provider: "deepgram",
    model: "nova-3-general",
    language: "nl",
  },
  tts_config: {
    provider: "elevenlabs",
    voice_id: "ukiwGs47sHyibruHJ1vg",
  },
})
04

Start een gesprek

Trigger een uitgaand gesprek of accepteer een inkomende.

call.ts
// Outbound call
const call = await client.calls.create({
  destination: "+31612345678",
  assistant_id: assistant.id,
})

// Status updates arrive on your webhook
console.log(call.call_id)
API surface

Endpoints die je echt zult gebruiken

Een kleine, gefocuste API. Geen abstracties om tegen te vechten.

GET/api/v1/assistants
POST/api/v1/assistants
POST/api/v1/calls/outbound
GET/api/v1/calls/{id}
GET/api/v1/numbers
Realtime events

Subscribe op wat ertoe doet

Beantwoord tool calls, volg de gespreksstatus en ontvang na afloop het volledige transcript, allemaal via één ondertekend webhook-kanaal.

assistant-request

Incoming call — return the assistant config to handle it

status-update

Call lifecycle updates (in-progress, ended, ended-with-error)

tool-calls

Assistant invoked a tool — your handler runs here

end-of-call-report

Final transcript, recording URL, analysis on hangup

Klaar om te beginnen?

Lees de volledige docs of grab de SDK van npm.

Fully typed
OpenAPI spec
Zero config