Skip to content
Documentation

Create Image Optimization

POST
/api/v1/workspaces/{workspace_id}/image_optimizations
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/image_optimizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Uploads an image and returns presigned URLs for the original and an optimized version.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body”
Media typemultipart/form-data
object
file
required
string format: binary

Responses

Section titled “Responses”

201

Section titled “201”

Successful

Media typeapplication/json
object
original
required
object
key
required
string
presigned_url
required
string
file_size
required
integer
width
required
integer
height
required
integer
format
required
string
optimized
required
object
key
required
string
presigned_url
required
string
file_size
required
integer
width
required
integer
height
required
integer
format
required
string
Example
{
  "original": {
    "key": "temp/0e6f1b60-7f1a-4c60-9e4a-5a6b7c8d9e10/original",
    "presigned_url": "https://example.com/temp/original-abc123.png",
    "file_size": 248192,
    "width": 1600,
    "height": 1200,
    "format": "image/png"
  },
  "optimized": {
    "key": "temp/0e6f1b60-7f1a-4c60-9e4a-5a6b7c8d9e10/optimized",
    "presigned_url": "https://example.com/temp/optimized-abc123.webp",
    "file_size": 48192,
    "width": 1600,
    "height": 1200,
    "format": "image/webp"
  }
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}