Skip to content
Documentation

Create Image

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

Creates a new image.

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
name
string
Example
My Image

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

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

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