Skip to content
Documentation

Create Image Optimization

POST
/api/v1/workspaces/{workspace_id}/image_optimizations

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 ”
object
file
required
string format: binary

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

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

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

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