Editframe logoEditframe

Create Image File

POST /api/v1/image_files
Request payload data
{
byte_size: number
The byte size of the image file.
filename: string
The filename of the image file.
height?: number
The height of the image file in pixels.
md5?: string
The md5 hash of the image file.
mime_type?: "image/jpeg" | "image/png" | "image/jpg" | "image/webp"
The mime type of the image file. Optional if the filename has a known file extension.
width?: number
The width of the image file in pixels.
}
Response payload data
{
byte_size: number
The byte size of the image file.
complete: null | boolean
Whether the image file has been fully uploaded.
id: string
The id of the image file.
md5: null | string
The md5 hash of the image file.
}

Upload Image File

POST /api/v1/image_files/:id/upload

No doc item found for UploadImageFileResult

Get Image File (metadata)

GET /api/v1/image_files/:id.json
Response payload data
{
byte_size: number
The byte size of the image file.
complete: null | boolean
Whether the image file has been fully uploaded.
height: null | number
The height of the image file in pixels.
id: string
The id of the image file.
md5: null | string
md5 hash of the image file.
width: null | number
The width of the image file in pixels.
}

Lookup Image by MD5

GET /api/v1/image_files/md5/:md5
Response payload data
{
byte_size: number
The byte size of the image file.
complete: null | boolean
Whether the image file has been fully uploaded.
height: null | number
The height of the image file in pixels.
id: string
The id of the image file.
md5: null | string
md5 hash of the image file.
width: null | number
The width of the image file in pixels.
}