Skip to main content

​
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 [email protected] to obtain 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: 
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

​
401 Unauthorized
error
The API key is missing or invalid.
{
  "error": "unauthorized",
  "message": "Invalid or missing API key"
}
​
403 Forbidden
error
The API key is valid but you’ve exceeded your usage limits.
{
  "error": "limit_reached",
  "message": "Monthly processing limit reached"
}
​
403 Feature Not Available
error
The requested feature or configuration option is not available on your current plan.
{
  "error": "feature_not_available",
  "message": "This feature is not available on your current plan",
  "feature": "allow_api_ad_video_generation",
  "plan_name": "Starter",
  "upgrade_url": "/billing/upgrade"
}
Common restricted features:
  • allow_api_ad_video_generation - Video generation endpoint access
  • allow_api_ad_audio_generation - Audio generation endpoint access
  • allow_custom_instructions - Custom AI prompts/instructions
  • allow_config_volume - Custom volume control
  • allow_custom_video_categories - Custom video category hints
  • allow_custom_description_workflow - Custom EDL/script content
  • allow_standard_ad - Standard (concise) audio descriptions
  • allow_url_input - Upload from URL
Parameter violations may also trigger this error:
{
  "error": "feature_not_available",
  "message": "Your Starter plan does not support: custom_instructions, volume_option",
  "parameters_requiring_upgrade": ["custom_instructions", "volume_option"],
  "current_plan": "Starter",
  "upgrade_url": "/billing/upgrade"
}

​
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.