Convert
Convert Images
- Documentation
- API Reference
- Community
- Headless
- GETAbout Shade Server
- GETConfig
- GETServer Status
- GETSearch Assets
- GETServer Usage Analytics
- GETAssets Searched
- GETServer Heartbeat
- GETKill Server
- GETExport File Path
- POSTAdd Asset to Source
- PUTAdd Tags to Asset
- DELDelete Assets
- GETAsset Roots
- GETAssets Linked to Other Assets
- GETAsset Collections
- GETIndividual Assets
- GETVisually Similar Assets
- GETAmount of Assets For Each Type
- POSTLink to Assets
- POSTLink to Asset Types
- GETAll Assets
- POSTMove Assets
- DELRemove Assets from Source
- PUTAsset Name
- GETDownload Assets
- GETAsset Type
- GETObjects Detected in an Asset
- DELUnlink Assets
- PUTUpdate Assets
- POSTAdd Asset to Collection
- GETAssets in a Collection
- POSTCreate a Collection
- DELDelete a Collection
- GETGet a Collection
- GETGet Filters
- PUTUpdate Collections
- GETAll Collections
- DELDelete Asset from Collection
- POSTSave Assets
- PUTUpdate Collections
- POSTGenerate New Assets
- POSTAdd Asset to Root
- GETIndexing Status
- POSTSync Asset Roots
- GETGet Asset Root
- GETDownload Progress
- GETGet Indexing Limit
- GETIndexing Queue
- GETFile Types Seen
- POSTPause Indexing
- DELDelete All Indexing Roots
- DELDelete Specific Indexing Root
- GETAsset from Index
- POSTReset Indexing
- POSTSet Indexing Limit
- PUTUpdate Player Numbers
- POSTRemove Background
- GETSearch Assets
API Documentation
Endpoint Examples
Assets
Collections
Generate
Indexing
Players
Remove Background
Search
Convert
Convert Images
POST
/
convert
/
image
Body_convert_to_convert_image_post · object
*
file
The filename or filenames · string
*
file
Required
string
The filename or filenames
export_type
The type to convert to · string
*
export_type
Required
string
The export type
optimize
Optimize output · boolean
optimize
boolean
The filename of the asset
quality
The filename · integer
quality
integer
The filename of the asset
{
"file": "string",
"export_type": "string",
"optimize": true,
"quality": 100
}
"<string>"
Body
application/json
file
string
requiredThe filename or filenames
export_type
string
requiredThe export type
optimize
boolean
default: trueThe filename of the asset
quality
integer
default: 100The filename of the asset
Response
200 - application/json
The response is of type string
.
{
"file": "string",
"export_type": "string",
"optimize": true,
"quality": 100
}
"<string>"