Skip to main content
POST
/
v1
/
jobs
{
  "input": "https://example.com/photo.jpg",
  "operations": [
    { "type": "image_composite", "params": { "overlay_url": "https://example.com/overlay.png", "x": 10, "y": 10 } }
  ]
}

{
  "id": "<string>",
  "status": "pending"
}
{
  "input": "https://example.com/photo.jpg",
  "operations": [
    { "type": "image_composite", "params": { "overlay_url": "https://example.com/overlay.png", "x": 10, "y": 10 } }
  ]
}
ParamTypeDescription
overlay_urlstringURL of the overlay image
xintegerHorizontal offset in pixels
yintegerVertical offset in pixels

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
input
required

Single input URL

Example:

"https://example.com/video.mp4"

​
operations
object[]
required
Example:
[
  {
    "type": "transcode",
    "params": { "format": "mp4", "codec": "h264" }
  }
]
​
webhook_url
string

URL to receive job completion notification

​
file_size
integer

File size hint in bytes (for plan limit validation)

Response

Job accepted

​
id
string
​
status
string
Example:

"pending"