Skip to main content
POST
/
v1
/
image
/
resize
{
  "input": "https://example.com/photo.jpg",
  "width": 800,
  "height": 600,
  "fit": "cover"
}

{
  "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/photo.jpg",
  "width": 800,
  "height": 600,
  "fit": "cover"
}
ParamTypeDescription
widthintegerTarget width in pixels
heightintegerTarget height in pixels
fitstringResize mode: cover, contain, fill, inside, outside

Authorizations

​
X-API-Key
string
header
required

Body

​
input
string
required

Input file URL

​
width
integer

Target width in pixels

​
height
integer

Target height in pixels

​
fit
string

Resize mode: cover, contain, fill, inside, outside

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