Voxscribe API Documentation

Integrate audio/video summarization and text-to-speech into your own apps, products, or workflows.

Authentication

All requests require an API key. Pass your key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Generate and manage your API keys in your dashboard. Keep your API key secret!

Base URL

https://voxscribe.app

Endpoints

1. Summarize Video/Audio

POST /api/summarize

Request:

{
  "video_url": "https://www.youtube.com/watch?v=YOUR_VIDEO_ID",
  "prompt": "Summarize this",
  "save_summary": true // Optional, default: true
}

Set save_summary to false if you do not want the summary saved to your account or history. Only saved summaries deduct a credit and appear in your dashboard.

Headers:

Authorization: Bearer YOUR_API_KEY Content-Type: application/json

Response:

{
  "summary": "In this video, ..."
}

Example: Summarize without saving (no credit charged)

curl -X POST https://voxscribe.app/api/summarize   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{"video_url": "https://www.youtube.com/watch?v=YOUR_VIDEO_ID", "prompt": "Summarize this", "save_summary": false}'

2. Generate Audio (Text-to-Speech)

POST /api/generate-audio

Request:

{
  "summary_text": "Your text to convert to audio"
}

Headers:

Authorization: Bearer YOUR_API_KEY Content-Type: application/json

Response:

{
  "audio": "BASE64_ENCODED_AUDIO",
  "mime_type": "audio/wav"
}

3. Health Check

GET /health

Headers:

Authorization: Bearer YOUR_API_KEY

Response:

{ "status": "ok" }

Error Handling

• 401 Unauthorized: Invalid or missing API key.
• 402 Payment Required: Not enough credits or subscription required.
• 429 Too Many Requests: Rate limit exceeded (if enabled).
• 500 Internal Server Error: Something went wrong on our end.

Example error:

{ "error": "Not enough credits" }

Best Practices

• Keep your API key secret. Never expose it in client-side code.
• Handle errors gracefully in your integration.
• Monitor your usage in your dashboard.

Support

For help, contact: support@voxscribe.app

Changelog

• 2024-07-17: Public API launched with summarization and TTS endpoints.

Example cURL Request

curl -X POST https://voxscribe.app/api/summarize   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{"video_url": "https://www.youtube.com/watch?v=YOUR_VIDEO_ID", "prompt": "Summarize this"}'