Skip to main content
POST
/
v1
/
videos
curl --request POST \
  --url 'https://api.elkapi.com/v1/videos' \
  --header 'Authorization: Bearer <token>' \
  --form 'model=sora-2' \
  --form 'prompt=A small kitten running through a sunny garden, cinematic, highly detailed' \
  --form 'image=https://example.com/image.png' \
  --form 'duration=5' \
  --form 'width=1280' \
  --form 'height=720' \
  --form 'fps=30' \
  --form 'seed=12345' \
  --form 'n=1' \
  --form 'response_format=json' \
  --form 'user=user-1234' \
  --form 'metadata=[object Object]'

{
  "id": "id",
  "object": "object",
  "model": "sora-2",
  "status": "status",
  "progress": 1,
  "created_at": 1,
  "seconds": "seconds",
  "completed_at": 1,
  "expires_at": 1,
  "size": "1024x1024",
  "error": {
    "message": "message",
    "code": "code"
  },
  "metadata": {}
}

Documentation Index

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

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

curl --request POST \
  --url 'https://api.elkapi.com/v1/videos' \
  --header 'Authorization: Bearer <token>' \
  --form 'model=sora-2' \
  --form 'prompt=A small kitten running through a sunny garden, cinematic, highly detailed' \
  --form 'image=https://example.com/image.png' \
  --form 'duration=5' \
  --form 'width=1280' \
  --form 'height=720' \
  --form 'fps=30' \
  --form 'seed=12345' \
  --form 'n=1' \
  --form 'response_format=json' \
  --form 'user=user-1234' \
  --form 'metadata=[object Object]'

{
  "id": "id",
  "object": "object",
  "model": "sora-2",
  "status": "status",
  "progress": 1,
  "created_at": 1,
  "seconds": "seconds",
  "completed_at": 1,
  "expires_at": 1,
  "size": "1024x1024",
  "error": {
    "message": "message",
    "code": "code"
  },
  "metadata": {}
}

​
Authorizations

​
Authorization
string
required
All endpoints require Bearer Token authentication.Add it to the request headers:
Authorization: Bearer YOUR_API_KEY

​
Body

​
model
string
default:"sora-2"
Model/style IDExample: sora-2
​
prompt
string
Text promptExample: The astronaut stands up and walks away
​
image
string
Image input (URL or Base64)Example: https://example.com/image.jpg
​
duration
number
Video duration (seconds)Example: 5
​
width
integer
Video widthExample: 1280
​
height
integer
Video heightExample: 720
​
fps
integer
Video frame rateExample: 30
​
seed
integer
Random seedExample: 20231234
​
n
integer
Number of videos to generateExample: 1
​
response_format
string
Response formatExample: url
​
user
string
User identifierExample: user-1234
​
metadata
object
Additional parameters (such as negative_prompt, style, quality_level)

​
Response

​
id
string
Video ID
​
object
string
Object type
​
model
string
default:"sora-2"
Model usedExample: sora-2
​
status
string
Task status
​
progress
integer
Progress percentage
​
created_at
integer
Creation timestamp
​
seconds
string
Video duration
​
completed_at
integer
Completion timestamp
​
expires_at
integer
Expiration timestamp
​
size
string
Video size
​
error
object
OpenAI video error information
​
error.message
string
Error message
​
error.code
string
Error code
​
metadata
object
Additional metadata