Nuvoca REST API

Use the REST API to connect your applications to your Nuvoca workspace. You can configure voice Agents, Agentic Flows, tools, knowledge bases and processing profiles, assign existing phone numbers and read stored call summaries.

To give these tasks to an AI assistant in natural language, start with Connect Nuvoca through MCP.

Start in three steps

1. Under Settings → API access, configure an API key or OAuth application with suitable scopes.
2. Verify the workspace using GET /api/external/v1/connection if connection:verify is granted.
3. Read the relevant catalog and current configuration before sending changes. The examples show this workflow.

Base URL and authentication

The REST API uses this fixed base URL:

https://app.nuvoca.ai/api/external/v1

Each request sends Authorization: Bearer <CREDENTIAL> using an API key or an OAuth access token issued for the REST API. The credential determines the workspace. Do not pass a Tenant ID to select another workspace.

Find a capability

Task	Reference
Create keys, configure OAuth and choose permissions	Authentication and scopes
Look up endpoints, inputs, responses and errors	API reference
Understand revisions, routing, secrets and summary selection	Configuration rules
Create an Agent, update a prompt, upload a document or read a day's data	API examples
Perform the same tasks through an AI assistant	MCP tool reference

Handle changes reliably

Read a resource before updating it and send its complete ETag, including quotes, as If-Match. After 409, read again and reconcile your change. A timeout following creation does not prove nothing was saved: check existing resources before creating again.

API calls save Agents, tools and profiles directly. Phone-number assignments affect routing. The configuration API does not start calls or perform message, lookup or webhook tests.

Keep credentials in protected storage and process prompts, summaries and phone numbers only in intended systems. The customer data rules also apply to your integration.