Skip to main content
GET
/
videos
List videos
curl --request GET \
  --url https://api.elytron.com/v1/videos \
  --header 'Authorization: Bearer <token>'
{
  "videos": [
    {
      "video_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "prompt": "<string>",
      "status": "pending",
      "duration": 123,
      "quality": "<string>",
      "aspect_ratio": "<string>",
      "style": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "download_url": "<string>",
      "file_size": 123,
      "error": "<string>"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
Retrieve a list of all videos for the authenticated user with optional filtering and pagination.

​
Query Parameters

ParameterTypeRequiredDescription
limitintegerNoMaximum number of videos to return (1-100, default: 20)
offsetintegerNoNumber of videos to skip (default: 0)
statusstringNoFilter by video status: pending, processing, completed, or failed

​
Example Request

curl -X GET "https://api.elytron.com/v1/videos?limit=10&status=completed" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

Returns a 200 OK status with the list of videos: 
{
  "data": {
    "videos": [
      {
        "video_id": "550e8400-e29b-41d4-a716-446655440000",
        "prompt": "A majestic eagle soaring over snow-capped mountains",
        "status": "completed",
        "duration": 15,
        "quality": "hd",
        "aspect_ratio": "16:9",
        "style": "cinematic",
        "created_at": "2024-01-01T12:00:00Z",
        "completed_at": "2024-01-01T12:02:30Z",
        "download_url": "https://api.elytron.com/v1/videos/550e8400-e29b-41d4-a716-446655440000/download",
        "file_size": 15728640
      }
    ],
    "total": 1,
    "limit": 10,
    "offset": 0
  },
  "meta": {
    "timestamp": "2024-01-01T12:05:00Z",
    "request_id": "req_123456789"
  }
}

​
Get Single Video

To get details for a specific video, use the video ID endpoint: 
curl -X GET "https://api.elytron.com/v1/videos/{video_id}" \
  -H "Authorization: Bearer YOUR_API_KEY"
This returns the same video object structure as shown above, but for a single video.

​
Error Responses

​
401 Unauthorized

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

​
404 Not Found (for single video)

{
  "error": {
    "code": "VIDEO_NOT_FOUND",
    "message": "Video not found"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
default:20

Maximum number of videos to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of videos to skip

Required range: x >= 0
​
status
enum<string>

Filter by video status

Available options:
pending,
processing,
completed,
failed

Response

200 - application/json

List of videos retrieved successfully

​
videos
object[]
​
total
integer

Total number of videos

​
limit
integer

Number of videos returned

​
offset
integer

Number of videos skipped