mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-16 13:20:39 -07:00
Jamie Pine
64dd29d35a
- Created new directory structure for documentation under `/docs2`. - Added `.gitignore` to exclude build artifacts and dependencies. - Introduced `package.json`, `next.config.mjs`, and `postcss.config.mjs` for project configuration. - Implemented MDX components in `mdx-components.tsx` for rendering documentation. - Migrated existing documentation content and created new files for auto-updater and other features. - Established compatibility layer for Mintlify components in `mintlify-compat.tsx`. - Set up OpenAPI documentation in `openapi.json`. - Updated README and migration guide to reflect new structure and usage instructions. - Ensured all components and pages are ready for development and deployment with Fumadocs.
150 lines
2.0 KiB
Plaintext
150 lines
2.0 KiB
Plaintext
---
|
|
title: "Voice Profiles API"
|
|
description: "Manage voice profiles programmatically"
|
|
---
|
|
|
|
## Endpoints
|
|
|
|
### List Profiles
|
|
|
|
```http
|
|
GET /profiles
|
|
```
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"profiles": [
|
|
{
|
|
"id": "abc123",
|
|
"name": "John Smith",
|
|
"language": "en",
|
|
"description": "Professional narrator",
|
|
"created_at": "2024-01-29T12:00:00Z",
|
|
"sample_count": 2
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Get Profile
|
|
|
|
```http
|
|
GET /profiles/{id}
|
|
```
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"id": "abc123",
|
|
"name": "John Smith",
|
|
"language": "en",
|
|
"description": "Professional narrator",
|
|
"created_at": "2024-01-29T12:00:00Z",
|
|
"samples": [
|
|
{
|
|
"id": "sample123",
|
|
"duration": 15.5,
|
|
"created_at": "2024-01-29T12:00:00Z"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### Create Profile
|
|
|
|
```http
|
|
POST /profiles
|
|
```
|
|
|
|
**Request:**
|
|
```json
|
|
{
|
|
"name": "John Smith",
|
|
"language": "en",
|
|
"description": "Professional narrator"
|
|
}
|
|
```
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"id": "abc123",
|
|
"name": "John Smith",
|
|
"language": "en",
|
|
"description": "Professional narrator",
|
|
"created_at": "2024-01-29T12:00:00Z"
|
|
}
|
|
```
|
|
|
|
### Update Profile
|
|
|
|
```http
|
|
PUT /profiles/{id}
|
|
```
|
|
|
|
**Request:**
|
|
```json
|
|
{
|
|
"name": "Updated Name",
|
|
"description": "Updated description"
|
|
}
|
|
```
|
|
|
|
### Delete Profile
|
|
|
|
```http
|
|
DELETE /profiles/{id}
|
|
```
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"success": true
|
|
}
|
|
```
|
|
|
|
### Add Voice Sample
|
|
|
|
```http
|
|
POST /profiles/{id}/samples
|
|
```
|
|
|
|
**Request:** (multipart/form-data)
|
|
```
|
|
audio: <file>
|
|
```
|
|
|
|
**Response:**
|
|
```json
|
|
{
|
|
"sample_id": "sample123",
|
|
"duration": 15.5
|
|
}
|
|
```
|
|
|
|
## TypeScript Example
|
|
|
|
```typescript
|
|
import { VoiceboxClient } from '@/lib/api'
|
|
|
|
const client = new VoiceboxClient({
|
|
baseUrl: 'http://localhost:17493'
|
|
})
|
|
|
|
// Create profile
|
|
const profile = await client.createProfile({
|
|
name: 'John Smith',
|
|
language: 'en',
|
|
description: 'Professional narrator'
|
|
})
|
|
|
|
// Add sample
|
|
await client.addSample(profile.id, audioFile)
|
|
|
|
// List all profiles
|
|
const profiles = await client.listProfiles()
|
|
```
|
|
|
|
For full API documentation, visit `http://localhost:17493/docs` when the server is running.
|