VocaFuse API Reference

Complete REST API reference for the VocaFuse VFaaS API. Covers all endpoints for managing recordings, webhooks, authentication, and transcriptions. Includes request/response examples in Python, JavaScript, and cURL.

Base URLs

Environment	Base URL
Production	https://api.vocafuse.com/v1

Authentication

VocaFuse uses API Key authentication for all operations.

API Key Authentication

Used by backend servers for full API access.

Headers:

X-VocaFuse-API-Key: sk_live_your_api_key
X-VocaFuse-API-Secret: your_api_secret

Example:

cURL

curl https://api.vocafuse.com/v1/recordings \
  -H "X-VocaFuse-API-Key: sk_live_..." \
  -H "X-VocaFuse-API-Secret: ..."

JavaScript

const response = await fetch('https://api.vocafuse.com/v1/recordings', {
  headers: {
    'X-VocaFuse-API-Key': 'sk_live_...',
    'X-VocaFuse-API-Secret': '...'
  }
});

Python

from vocafuse import Client

client = Client(
    api_key='sk_live_...',
    api_secret='...'
)

recordings = client.recordings.list()

Responses & Status Codes

All API responses follow consistent formats for success and error cases. See the complete API Responses Reference for:

• Response formats and structure
• HTTP status codes
• Pagination
• Filtering
• Rate limits and handling

Quick reference:

• Success responses return data directly (not wrapped)
• List endpoints include pagination metadata
• Error responses include structured error objects with codes
• See Error Codes Reference for complete error documentation

---

Supported Audio Formats

VocaFuse accepts the following audio formats:

Format	MIME Type	Typical Use
WebM	audio/webm	Chrome, Edge
Ogg	audio/ogg	Firefox
MP4	audio/mp4	Safari, iOS
MP3	audio/mpeg	Universal fallback
WAV	audio/wav	High quality

Constraints:

• Maximum file size: 25 MB
• Maximum duration: 10 minutes (60 seconds for MVP)
• Sample rate: 8kHz - 48kHz

---

Versioning

The API uses URL-based versioning: /v1/

Current version: v1

Breaking changes result in a new version. Non-breaking changes:

• Adding new endpoints
• Adding optional parameters
• Adding response fields
• Adding webhook events

---

SDKs

Official SDKs available:

• Python: pip install vocafuse - Documentation
• JavaScript/TypeScript: npm install vocafuse - Documentation

---

Support

• Documentation: docs.vocafuse.com
• API Status: status.vocafuse.com
• Support Email: [email protected]
• GitHub: github.com/vocafuse

---

Estimated Reading Time: 8 minutes
Last Updated: December 19, 2024