Developer Documentation

Build With Vomenta APIs

Comprehensive REST API, WebSocket events, webhooks, and SDKs. Everything you need to integrate voice, messaging, and AI into your applications.

API ReferenceQuick Start Guide

Quick Install

npm install @vomenta/shared-types

Get Started

Choose your starting point based on what you want to build.

5 min read

Quick Start

Get up and running in under 5 minutes. Create your first workspace, add agents, and make your first call.

OpenAPI 3.0

REST API Reference

Full API documentation with request/response examples. Authentication, pagination, error handling, and rate limits.

Event-driven

Webhooks

Real-time event notifications for calls, messages, agent status changes, and system events.

Real-time

WebSocket API

Real-time bidirectional communication for agent presence, live dashboards, and call control.

SDKs

Official SDKs

Type-safe SDKs for popular languages with full API coverage.

TS

Node.js / TypeScript

npm install @vomenta/shared-types
View Docs
PY

Python

pip install requests # REST API
View Docs
GO

Go

go get net/http # REST API
View Docs
RB

Ruby

gem install faraday # REST API
View Docs
API Reference

API Endpoints

Voice & Telephony

  • POST /v1/calls
  • GET /v1/calls/:id
  • POST /v1/calls/:id/transfer
  • GET /v1/recordings
View all

Messaging & Chat

  • POST /v1/messages
  • GET /v1/conversations
  • POST /v1/conversations/:id/reply
  • GET /v1/channels
View all

AI & Automation

  • POST /v1/ai/agents
  • GET /v1/ai/models
  • POST /v1/ai/transcribe
  • POST /v1/ai/sentiment
View all

Analytics & Reports

  • GET /v1/analytics/calls
  • GET /v1/analytics/agents
  • GET /v1/reports
  • POST /v1/exports
View all

Integrations

  • GET /v1/integrations
  • POST /v1/integrations/connect
  • POST /v1/webhooks
  • GET /v1/webhooks
View all

Admin & Security

  • GET /v1/users
  • POST /v1/users
  • GET /v1/audit-logs
  • PUT /v1/settings
View all