Skip to main content

​
Welcome to the Elytron Video API

The Elytron Video API provides powerful video generation capabilities through a simple REST interface. Generate high-quality videos from text prompts, manage your video library, and integrate video creation into your applications.

​
Base URL

All API requests are made to:
  • Production: https://api.elytron.com/v1
  • Sandbox: https://sandbox-api.elytron.com/v1

​
Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

Get Your API Key

Generate your API key from the dashboard

​
Rate Limits

API requests are subject to rate limits based on your subscription plan:
  • Free: 10 requests per minute
  • Pro: 100 requests per minute
  • Enterprise: 1000 requests per minute
Rate limit headers are included in all responses:
  • X-RateLimit-Limit: Maximum requests per minute
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
Response Format

All API responses are returned in JSON format with the following structure:

​
Success Response

{
  "data": { ... },
  "meta": {
    "timestamp": "2024-01-01T00:00:00Z",
    "request_id": "req_123456789"
  }
}

​
Error Response

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request parameters are invalid",
    "details": {
      "field": "prompt",
      "reason": "Required field is missing"
    }
  },
  "meta": {
    "timestamp": "2024-01-01T00:00:00Z",
    "request_id": "req_123456789"
  }
}

​
Common HTTP Status Codes

CodeDescription
200Success
201Created (video generation started)
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error

​
Webhooks

Set up webhooks to receive real-time notifications when video generation completes:

Webhook Documentation

Learn how to configure webhooks for your application

​
SDKs and Libraries

Official SDKs are available for popular programming languages:

JavaScript/Node.js

npm install @elytron/video-api

Python

pip install elytron-video-api

PHP

composer require elytron/video-api

Go

go get github.com/elytron/video-api-go

​
Getting Started

1

Get your API key

Sign up at dashboard.elytron.com and generate your API key
2

Make your first request

Use the video generation endpoint to create your first video
3

Check status

Monitor progress with the status endpoint
4

Download video

Fetch your completed video using the download endpoint