Skip to main content
POST
/
v1
/
pipeline
/
sprite-sheet
{
  "input": "https://example.com/video.mp4",
  "columns": 10,
  "width": 160,
  "interval": 5
}

{
  "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",
  "columns": 10,
  "width": 160,
  "interval": 5
}
ParamTypeDescription
columnsintegerNumber of columns in the sprite grid
widthintegerWidth of each thumbnail in pixels
intervalnumberInterval in seconds between captured frames

Authorizations

​
X-API-Key
string
header
required

Body

​
input
string
required

Input file URL

​
columns
integer

Number of columns in the sprite grid

​
width
integer

Width of each thumbnail in pixels

​
interval
number

Interval in seconds between captured frames

​
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"