/api/v1

Vomyra Data API

Build custom integrations with assistants, call history, phone-number assignments, tool configuration, and provider catalogs. Every response is scoped to the API key owner and shaped by explicit DTO allow-lists.

Authentication

Send an API key with x-api-key,api-key, or a bearer token.

Shared Data

Reads and safe writes target the same user-scoped data model as the Vomyra app. Raw database documents never leave the process.

Rate Limits

Defaults are 60 requests per minute per IP and 600 requests per minute per API key.

Field Control

Sensitive fields such as share keys, provider tokens, ownership internals, and tool credentials are omitted or redacted.

Authentication

API keys are created in the Vomyra dashboard and must belong to an active user. Domain restrictions on the key are enforced using the request Origin or Referer header.

Authentication

curl "https://docs.vomyra.com/api/v1/assistants" \
  -H "x-api-key: <api-key>"

Response Envelope

Success

{
  "success": true,
  "data": {},
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42
  }
}

Error

{
  "success": false,
  "error": {
    "code": "validation_error",
    "message": "name is required"
  }
}

CORS and Pagination

CORS

OPTIONS preflight is supported. Allowed headers are Content-Type, Authorization, x-api-key, and api-key. Origins come from API_CORS_ORIGINS and default to all origins in development.

Pagination

List endpoints accept page and limit. The default limit is 20 and the maximum is 100. Phone numbers are not paginated because account-level number counts are small.

Endpoints

Every endpoint is scoped to the API key owner and returns an explicit DTO allow-list.

Catalog

Discover enum values used when configuring assistants.

GET

Get Catalog/api/v1/catalog

List providers, models, voices, and language modes from the live database.

Assistants

Create, list, read, update, and configure tools on voice assistants.

GET

List Assistants/api/v1/assistants

List the authenticated user's assistants.

POST

Create Assistant/api/v1/assistants

Create a new assistant, optionally configuring model, voice, transcription, and advanced settings.

GET

Get Assistant/api/v1/assistants/{id}

Fetch one assistant by id.

PUT

Update Assistant/api/v1/assistants/{id}

Update one or more assistant fields.

POST

Assign Tool/api/v1/assistants/{id}/tools

Add a tool to an assistant's active tool list.

DELETE

Unassign Tool/api/v1/assistants/{id}/tools/{toolId}

Remove a tool from an assistant's active tool list.

Calls

Read call summaries and detailed call transcripts.

GET

List Calls/api/v1/calls

List the authenticated user's calls.

GET

Get Call/api/v1/calls/{id}

Fetch one call with transcript.

Phone Numbers

Read owned numbers and manage assistant assignment.

GET

List Numbers/api/v1/numbers

List the authenticated user's phone numbers.

PUT

Assign Number/api/v1/numbers/assignment

Attach a phone number to an assistant.

DELETE

Unassign Number/api/v1/numbers/assignment

Detach a phone number from its assistant.

Tools

Read tool instances, discover creatable types, and create API request tools.

GET

List Tool Types/api/v1/tool-types

List creatable catalog tool types.

GET

List Tools/api/v1/tools

List configured tools for the authenticated user.

POST

Create Tool/api/v1/tools

Create a configured tool instance.

GET/api/v1/catalog

Try this endpoint

API key

Sent as the x-api-key header. It is not stored.

Base URL

request

curl -X GET "https://docs.vomyra.com/api/v1/catalog" \
  -H "x-api-key: <api-key>"

Response

Run the request to see the response body.