Skip to main content
POST
/
v1
/
pipeline
/
animated-preview
{
  "input": "https://example.com/video.mp4",
  "duration": 5,
  "format": "webp"
}

{
  "id": "job_abc123",
  "status": "pending"
}

Documentation Index

Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt

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

{
  "input": "https://example.com/video.mp4",
  "duration": 5,
  "format": "webp"
}
ParamTypeDescription
durationnumberDuration of the animated preview in seconds
formatstringOutput format (“gif” or “webp”)

Authorizations

​
X-API-Key
string
header
required

Body

​
input
string
required

Input file URL

​
duration
number

Duration of the animated preview in seconds

​
format
string

Output format ("gif" or "webp")

​
webhook_url
string

URL to receive job completion notification

Response

Job accepted

​
id
string
Example:

"job_abc123"

​
status
enum<string>
Available options:
pending,
processing,
completed,
failed,
cancelled
Example:

"pending"