Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.viddyscribe.com/llms.txt

Use this file to discover all available pages before exploring further.

​
API Key Authentication

All ViddyScribe Enterprise API endpoints require authentication using an API key passed in the X-API-Key header.
API keys are sensitive credentials. Keep them secure and never commit them to version control.

​
Getting Your API Key

Get in touch at hello@viddyscribe.com to obtain a plan and your API key. Your API key will look like this: 
vsk_abc123def456ghi789jkl012mno345pqr678stu901vwx234yz (THIS IS A SAMPLE)

​
Making Authenticated Requests

Include your API key in the X-API-Key header with every request. The example below polls /get_results for a job — the same X-API-Key header works on every other endpoint (/upload_media, /generate_ad_text, /generate_ad_audio, /generate_ad_video, etc.): 
curl -X GET https://api.viddyscribe.com/enterprise/api/get_results?job_id=task_123 \
  -H "X-API-Key: vsk_your_api_key_here"

​
Authentication Errors

A missing or invalid API key returns 401 Unauthorized with error: "unauthorized". For the full list of error codes (auth, plan limits, rate limits, upload state, job failures), see API Reference > Error Codes.

​
Best Practices

  • Use environment variables
  • Never hardcode keys in your source code
  • Don’t commit keys to version control
  • Use secret management services (AWS Secrets Manager, HashiCorp Vault, etc.)
Periodically rotate your API keys to minimize security risks. Contact your admin to generate new keys.
Use separate API keys for development, staging, and production environments.
Keep track of your API usage to avoid hitting rate limits unexpectedly.