NUVI-X REST API v1.4 SPECIFICATION • OFFICIAL PYTHON & NODE.JS SDKS ACTIVE
Nuvi-X AI
API VERSION 1.4 • AWS MULTI-REGION

Nuvi-X API & SDK Reference

Integrate autonomous AI agents, sub-40ms voice synthesis, and FinTech invoice extraction into your applications using our official Python and Node.js SDKs or standard HTTP REST protocols.

SDK Quickstart

Install the official Nuvi-X client libraries via pip or npm:

Python (3.9+)
pip install nuvix-ai
Node.js (18+)
npm install @nuvix/sdk

Authentication

Every API request must include your secret API key in the HTTP Authorization header using standard Bearer format.

Authorization: Bearer nvx_live_YOUR_API_KEY
POST /v1/agents/execute

Autonomous Agent Swarm Execution

Dispatches an autonomous multi-step agent swarm to evaluate a goal, invoke external tools, query vector storage on AWS Bedrock, and stream completion telemetry.

Request Example (Python) 200 OK
import nuvix

client = nuvix.Client(api_key="nvx_live_49f821a007b")

task = client.agents.execute(
    agent_id="nvx-agentops-enterprise",
    prompt="Audit quarterly tax invoices and flag anomalies",
    stream=True,
    max_steps=10
)

for event in task.stream():
    print(f"[{event.step_name}]: {event.delta}")
JSON Response Schema (200 OK):
{
  "task_id": "tsk_88192a01",
  "status": "completed",
  "total_steps": 4,
  "execution_time_ms": 284,
  "tokens_consumed": 412,
  "result": "450 invoice records validated. 0 discrepancies found.",
  "audit_trail_url": "https://vault.nuvi-x.com/audits/tsk_88192a01"
}
POST /v1/voice/synthesize

Real-Time VoiceStream Audio

Streams raw PCM or Opus 48kHz audio chunks with sub-40ms latency. Supports custom prosody conditioning, real-time interruptions, and bidirectional WebSocket streams.

cURL Example Stream Chunked
curl -X POST "https://api.nuvi-x.com/v1/voice/synthesize" \
  -H "Authorization: Bearer nvx_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "voice_id": "aura-pro",
    "text": "Your transaction #48201 has been confirmed on the ledger.",
    "output_format": "opus_48k",
    "stream": true
  }' --output stream.opus
POST /v1/documents/extract

FinTech Invoice & Contract OCR

Extracts high-precision key-value pairs, nested invoice line items, tax brackets, and totals from multi-page PDFs or image buffers.

Node.js SDK Example 200 OK
import { NuviX } from '@nuvix/sdk';
import fs from 'fs';

const nuvix = new NuviX({ apiKey: process.env.NUVI_X_KEY });

const result = await nuvix.documents.extract({
  file: fs.createReadStream('./invoice_2026.pdf'),
  schema: 'financial_invoice_v2',
  autoReconcile: true
});

console.log(`Extracted total: $${result.data.total_due}`);

Rate Limits & Status Codes

Requests exceeding plan quotas will return HTTP 429 Too Many Requests with a Retry-After header in seconds.

200 OK
Successful execution
401 Unauthorized
Missing or invalid key
429 Rate Limited
Exceeded concurrency
500 Server Error
Automatic failover AZ