Skip to content
Documentation

Save Temporary Image

POST
/api/v1/workspaces/{workspace_id}/save_temporary_images
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/save_temporary_images \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "key": "0e6f1b60-7f1a-4c60-9e4a-5a6b7c8d9e10/optimized", "name": "My Image" }'

Persists a temporary (optimized or original) image staged by the image optimization endpoint into the image library.

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 typeapplication/json
object
key
required
string
Example
0e6f1b60-7f1a-4c60-9e4a-5a6b7c8d9e10/optimized
name
required
string
Example
My Image

Responses

Section titled “Responses”

201

Section titled “201”

Successful

Media typeapplication/json
object
id
required
string
name
required
string
filename
required
string
width
required
integer
height
required
integer
file_size
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
organization_id
required
integer
public_url
required
string
description
required
string
nullable
extension
required
string
archived
required
boolean
Example
{
  "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
  "name": "My Image",
  "filename": "image.png",
  "width": 100,
  "height": 100,
  "file_size": 1000,
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "organization_id": 12345,
  "public_url": "https://www.example.com/image.png",
  "description": "A beautiful image of a cat",
  "extension": "png",
  "archived": false
}

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

404

Section titled “404”

Not Found

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."
    ]
  }
}