API Reference

API Endpoints

Complete reference for all available VeyraAPI endpoints. Each endpoint includes detailed parameter information, authentication requirements, and usage examples.

🔑 Authentication Required
All API endpoints require authentication via API key. Provide your key using the api_key query parameter or X-API-Key header. Contact the administrator to obtain an API key.

Available Endpoints

GET /api/search

Search for music tracks on YouTube

Parameters
Name Type Required Description
query string Required Search keywords or artist name
limit integer Optional Maximum number of results (1-50, default: 10)
api_key string Required Your API authentication key
GET /api/track

Get metadata and download URL for a YouTube track

Parameters
Name Type Required Description
url string Required YouTube video URL or video ID
video boolean Optional Set to "true" for video format (default: audio only)
api_key string Required Your API authentication key
GET /api/stream/:videoId

Stream or download audio/video files with progressive streaming

Parameters
Name Type Required Description
videoId string Required YouTube video ID (in URL path)
video boolean Optional Set to "true" for video format
api_key string Required Your API authentication key
GET /api/health

Check API service health and status

Coming Soon

These endpoints are planned for future releases. They will provide extended functionality for various media platforms.

Soon
/api/get_url
Resolve direct track URL into metadata
Soon
/api/snap
Fetch downloadable media from various platforms
Soon
/api/links
Retrieve all platform links for a track
Soon
/api/instagram
Fetch Instagram post/reel media and metadata
Soon
/api/tiktok
Fetch TikTok video and audio with metadata
Soon
/api/x-profile
Fetch Twitter/X profile and recent tweets
Soon
/api/x-tweet
Fetch details of a single tweet
Soon
/api/all
Extract media from any supported platform URL

Need more details?

Check out our complete documentation or try the interactive API tester.