Version 1
Connector Overview: This page documents all 260 actions for the Scaleflexconnector v1.
ASK Filerobot regenerate (28)
POST Background removal
/regenerate/remove-background
Trigger background removal for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Brand & logo recognition
/regenerate/brand-detection
Trigger brand recognition and logo detection for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Dominant color
/regenerate/dominant-color
Trigger dominant color extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Face analysis
/regenerate/face-analysis
Trigger face analysis for UUIDs in JSON body.
The following information is included for each detected face:
-
bounding box
-
facial landmarks
-
expression classification
-
ethnicity classification
-
age estimation
-
gender classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Face count
/regenerate/face-count
Trigger face counting by extracting the number of faces for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Metadata extraction
/regenerate/extract-metadata
Trigger metadata extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Not Safe For Work
/regenerate/nsfw
Trigger NSFW (Not Safe For Work) detection for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Number plate blurring
/regenerate/plate-blurring
Trigger vehicle license plate number blurring for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Number plate recognition
/regenerate/plate-number-recognition
Trigger vehicle license plate number recognition for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST OCR (text extraction)
/regenerate/ocr
Trigger text extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Product type
/regenerate/product-type-classification
Trigger product type classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Quality improvement
/regenerate/remove-artifacts
Trigger artifacts removal for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Scene classification
/regenerate/scene-classification
Trigger scene classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Sports classification
/regenerate/sport-classification
Trigger sports classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Background removal
/regenerate/remove-background
Trigger background removal for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Brand & logo recognition
/regenerate/brand-detection
Trigger brand recognition and logo detection for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Dominant color
/regenerate/dominant-color
Trigger dominant color extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Face analysis
/regenerate/face-analysis
Trigger face analysis for UUIDs in JSON body.
The following information is included for each detected face:
-
bounding box
-
facial landmarks
-
expression classification
-
ethnicity classification
-
age estimation
-
gender classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Face count
/regenerate/face-count
Trigger face counting by extracting the number of faces for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Metadata extraction
/regenerate/extract-metadata
Trigger metadata extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Not Safe For Work
/regenerate/nsfw
Trigger NSFW (Not Safe For Work) detection for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Number plate blurring
/regenerate/plate-blurring
Trigger vehicle license plate number blurring for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Number plate recognition
/regenerate/plate-number-recognition
Trigger vehicle license plate number recognition for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST OCR (text extraction)
/regenerate/ocr
Trigger text extraction for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Product type
/regenerate/product-type-classification
Trigger product type classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Quality improvement
/regenerate/remove-artifacts
Trigger artifacts removal for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Scene classification
/regenerate/scene-classification
Trigger scene classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Sports classification
/regenerate/sport-classification
Trigger sports classification for UUIDs in JSON body.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Auto-tagging (6)
POST Autotag JSON
/images/autotag
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Autotag Multipart
/images/autotag/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Autotag URL
/images/autotag/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Autotag JSON
/images/autotag
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Autotag Multipart
/images/autotag/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Autotag URL
/images/autotag/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Background removal (6)
POST Background removal JSON
/images/remove-background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Background removal Multipart
/images/remove-background/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Background removal URL
/images/remove-background/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Background removal JSON
/images/remove-background
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Background removal Multipart
/images/remove-background/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Background removal URL
/images/remove-background/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic) |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Brand (logo) recognition (6)
POST Brand detection JSON
/images/brand-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Brand detection Multipart
/images/brand-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Brand detection URL
/images/brand-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Brand detection JSON
/images/brand-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Brand detection Multipart
/images/brand-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Brand detection URL
/images/brand-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Bulk operations (4)
POST Bulk operations Multipart
/images/bulk/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
N/A |
GET Bulk operations URL
/images/bulk
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Bulk operations Multipart
/images/bulk/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
N/A |
GET Bulk operations URL
/images/bulk
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Chapters (4)
POST Chapters - Multipart
/chapters/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file.
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Chapters - URL
/chapters/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Chapters - Multipart
/chapters/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file.
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Chapters - URL
/chapters/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Combine (4)
POST Combine - Multipart
/combine/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
second local file |
POST Combine - URL
/combine/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Combine - Multipart
/combine/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
second local file |
POST Combine - URL
/combine/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Compress (4)
POST Compress - Multipart
/compress/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
Resolution to compress the output file to |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Compress - URL
/compress/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Compress - Multipart
/compress/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
Resolution to compress the output file to |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Compress - URL
/compress/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Convert (4)
POST Convert - Multipart
/convert/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format of the output file |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Convert - URL
/convert/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format of the output file |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Convert - Multipart
/convert/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format of the output file |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Convert - URL
/convert/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format of the output file |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Dominant color extraction (6)
POST Dominant color JSON
/images/dominant-color
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Dominant color Multipart
/images/dominant-color/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Dominant color URL
/images/dominant-color/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Dominant color JSON
/images/dominant-color
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Dominant color Multipart
/images/dominant-color/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Dominant color URL
/images/dominant-color/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of dominant colors to show |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Face analysis (6)
POST Face analysis JSON
/images/face-analysis
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face analysis Multipart
/images/face-analysis/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Face analysis URL
/images/face-analysis/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face analysis JSON
/images/face-analysis
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face analysis Multipart
/images/face-analysis/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Face analysis URL
/images/face-analysis/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Face clustering (8)
POST Add
/images/face-clustering/add
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Should already added images be kept or discarded |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Cluster
/images/face-clustering/cluster
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum distance between two samples for one to be considered a neighbor of the other |
|
|
Number of samples in a neighborhood for a point to be considered a core point for that cluster |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Delete
/images/face-clustering/delete
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Predict
/images/face-clustering/predict
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Id of image to use |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Add
/images/face-clustering/add
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Should already added images be kept or discarded |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Cluster
/images/face-clustering/cluster
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum distance between two samples for one to be considered a neighbor of the other |
|
|
Number of samples in a neighborhood for a point to be considered a core point for that cluster |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Delete
/images/face-clustering/delete
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Predict
/images/face-clustering/predict
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Id of image to use |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Face count (6)
POST Face count JSON
/images/face-count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face count Multipart
/images/face-count/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Face count URL
/images/face-count/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face count JSON
/images/face-count
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Face count Multipart
/images/face-count/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Face count URL
/images/face-count/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Face detection (6)
POST Video face detection JSON
/videos/face-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Video face detection Multipart
/videos/face-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Video face detection URL
/videos/face-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Video face detection JSON
/videos/face-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Video face detection Multipart
/videos/face-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Video face detection URL
/videos/face-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Second to start the search from |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Files (18)
DELETE Delete file
/{token}/v4/files/{file_uuid}
This API request is used to delete single file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to delete |
|
|
N/A |
|
|
N/A |
DELETE Delete multiple files
/{token}/v4/files
This API request is used to delete multiple files using UUIDs of the files.
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
files_uuids |
Yes |
UUID of the files to be deleted |
Array |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
|
|
N/A |
GET Get file details
/{token}/v4/files/{file_uuid}
This API is used to get file details.
Format parameters(?format=):
Below format parameters are used to format the API response.
|
Key |
Value |
Default |
Description |
Example |
|---|---|---|---|---|
|
|
\- |
|
Sets the response format to either csv or json |
|
|
|
|
|
Used to format metadata.Formats the select and multi-select field values in the response. Useful for returning values as human-readable labels instead of internal keys. |
|
|
|
|
|
Tag display format. json_full will return tag values and internal keys while json_compact will only return the internal key. |
?format=tags:json_compact |
|
|
|
|
Labels display format.son_full will return label values and internal keys while json_compact will only return the internal key. |
|
Format Examples:
?format=json,select:internal;
?format=csv,select:label,tags:json_compact
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format response.see format response section. |
|
|
Language variant to be returned.Please use correct language abbreviation. |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to get details of. |
|
|
N/A |
|
|
N/A |
GET IIIF
/{token}/v4/get/{file_uuid}/iiif
This API is used to get details of an file in IIIF format.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot Project identifier |
|
|
UUID of the file you want to get details of in IIIF format |
|
|
N/A |
GET List & search files
/{token}/v4/files
This API is used to search and list files in Filerobot.
Search parameter (&q=)
The (q=) parameter is used as a search and filter parameter for custom metadata fields,tags,filename and also fuzzy search. The returned resullts can be also formated according to your need (please see format parameters in GET file details )
The metadata has a pair of meta key and meta value.Please refer to the below table for all the options available and syntax:
|
Name |
Description |
Syntax |
Value/Example |
|---|---|---|---|
|
Fuzzy Search |
This does a fuzzy search on all fields. |
Start and end with double quotes |
\- |
|
Tag filter |
This format is considered as filtering by tags. |
Start and end with double quotes and include sharp (#) before begining of the tag |
\- |
|
Single/Multi-Select Metadata Filters |
This format is considered as filtering by select/multi-select metadata fields. And meta value can be in form of single/multi-select or anything else. |
Colon operator is included between meta key and meta value.
|
\- |
|
Boolean Metadata filter |
Filtering boolean metadata fields. |
Meta value can be a boolean with true or false |
\- |
|
Numeric/Date Metadata filter |
This format is used to search/filter metadata with date or numeric data type. |
Operators included between meta key and meta value are :(equality), >, <, >=, <=, !=(comparison)
|
\- |
|
Text/Text Area Metadata filter |
This format is used to search/filter custom metadata with text or text-area data type. Here we are searching for specfic keywords (string) in the user specified meta-key. Please note that here we are searching for the exact specific keyword. |
Operators included between meta key and meta value are \~, \~\~ |
\- |
|
Filename search |
This format is used to search exact filename including extensiomn. |
filename keyword is used as meta-key and meta-value is the filename inside quotes |
\- |
Internal metadata search
Filerbot has a lot of internal metadata for assets. Some of them are able to be used in query string for filtering. We call them reserved keywords such as 'type', 'orientation', 'mimetype', 'color', 'resolution', 'faces', 'approval_status', 'enable_favorited'
These should not be used as meta-key for custom metadata fields. when creating metadata. The following can be used for searching and filtering results:
1. type: Used to filter asset type. Types are seperated by comma. If more than 1 is provided by then the operator between types is `OR`. Its accepted values are:application,image,text,video.
Example: &type=pdf,video
2. mimetype: Similar to type it is used to filter results by mimetype. If more than 1 is provided by then the operator between mimetype is OR. Its accepted values are:application/pdf, image/jpeg, image/png, image/tiff, image/webp,image/x-icon, text/html, image/x-photoshop ,image/vnd.adobe.photoshop, image/gif, video/mp4, image/tiff, image/webp etc.
Example: &mimetype=image/png,video/mp4
3. resolution:Filter by the image width. Resolutions are seperated by comma. If more than 1 resolution is provided by resolution, the operator between resolutions is OR.The possible value of resolution are:
-
&resolution=small(image width < 600) -
&resolution=medium(image width between 600 and 1800) -
&resolution=large(image width > 1800)
4. orientation: Filter by the image orientation . Orientations are seperated by comma. If more than 1 orientation is provided by orientation, the operator between orientations is OR.The possible value of resolution are:
1.&orientation=PA (panaroma image)
2.&orientation=PO (portrait image)
3\. &orientation=SQ (square image)
4\. &orientation=LD (landscape image)
5. size: Filter image by image size in mb.It is a range of number.The lower and upper limit is separated by ".." .
Example: &size=1..100
Labels search/filter:
You can filter results by multiple labels SID (SID is the internal value of an label which can be obtained by the /labels endpoint).
|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
&labels_operator |
String |
If there are multiple labels you are searching by you can define the operator between them. The accepted values are |
\- |
|
|
String |
SID of the labels you want to search for. If multiple sepeerate by comma |
|
Order search results(&sort)
The search results can be sorted using the query parameter &sort. Sort results by name (default), uploaded_at, created_at, modified_at, size. Sort resuts with order asc or desc. Example: &sort=name:desc ; &sort=oploaded_at:asc
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to list/search recursively. 1 =yes; 0 =No |
|
|
Result limit (for pagination). |
|
|
Start offset (for pagination). |
|
|
See order search results for more info |
|
|
Format response. please see "format response" in GET file details |
|
|
Labels operator when using multiple labels. Acccepted values:OR,AND |
|
|
SID of the label. If you want to filter by labels. |
|
|
In which language variant to return results. Please check your token configuration for language abbreviation. Alternatively you can do a GET files request and see language abbreviation. |
|
|
Filter by mimetype |
|
|
Filter by resolution |
|
|
Filter by orientation |
|
|
Filter by image,video,audio |
|
|
Search parameter.See search parameter section. |
|
|
Filter by size of the file (in mb).First value is lower limit and second value is upper limit |
|
|
Filter by tags.SID of the tag you want to filter by. |
|
|
Search inspecific folder |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
POST Move multiple files
/{token}/v4/files/move
This API request is used to move multiple files (using UUID of those files ) to a new folder.
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
new_folder_name |
Yes |
Folder path |
String |
|
file_uuids |
Yes |
UUID of the files. If multiple then seperate each UUID by comma (,) |
Array |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Move single file
/{token}/v4/files/{file_uuid}/folders/{folder_uuid}
This API request is used to move a specific file to another folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to move |
|
|
UUID of the folder you want to move the file to. |
|
|
N/A |
|
|
N/A |
PATCH Rename file
/{token}/v4/files/{file_uuid}
This API is used to rename a file using file UUiD
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
name |
Yes |
New name of the file |
String |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file to be renamed |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Upload File Base64
/{token}/v4/files
Upload File Base64
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete file
/{token}/v4/files/{file_uuid}
This API request is used to delete single file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to delete |
|
|
N/A |
|
|
N/A |
DELETE Delete multiple files
/{token}/v4/files
This API request is used to delete multiple files using UUIDs of the files.
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
files_uuids |
Yes |
UUID of the files to be deleted |
Array |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
|
|
N/A |
GET Get file details
/{token}/v4/files/{file_uuid}
This API is used to get file details.
Format parameters(?format=):
Below format parameters are used to format the API response.
|
Key |
Value |
Default |
Description |
Example |
|---|---|---|---|---|
|
|
\- |
|
Sets the response format to either csv or json |
|
|
|
|
|
Used to format metadata.Formats the select and multi-select field values in the response. Useful for returning values as human-readable labels instead of internal keys. |
|
|
|
|
|
Tag display format. json_full will return tag values and internal keys while json_compact will only return the internal key. |
?format=tags:json_compact |
|
|
|
|
Labels display format.son_full will return label values and internal keys while json_compact will only return the internal key. |
|
Format Examples:
?format=json,select:internal;
?format=csv,select:label,tags:json_compact
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Format response.see format response section. |
|
|
Language variant to be returned.Please use correct language abbreviation. |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to get details of. |
|
|
N/A |
|
|
N/A |
GET IIIF
/{token}/v4/get/{file_uuid}/iiif
This API is used to get details of an file in IIIF format.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot Project identifier |
|
|
UUID of the file you want to get details of in IIIF format |
|
|
N/A |
GET List & search files
/{token}/v4/files
This API is used to search and list files in Filerobot.
Search parameter (&q=)
The (q=) parameter is used as a search and filter parameter for custom metadata fields,tags,filename and also fuzzy search. The returned resullts can be also formated according to your need (please see format parameters in GET file details )
The metadata has a pair of meta key and meta value.Please refer to the below table for all the options available and syntax:
|
Name |
Description |
Syntax |
Value/Example |
|---|---|---|---|
|
Fuzzy Search |
This does a fuzzy search on all fields. |
Start and end with double quotes |
\- |
|
Tag filter |
This format is considered as filtering by tags. |
Start and end with double quotes and include sharp (#) before begining of the tag |
\- |
|
Single/Multi-Select Metadata Filters |
This format is considered as filtering by select/multi-select metadata fields. And meta value can be in form of single/multi-select or anything else. |
Colon operator is included between meta key and meta value.
|
\- |
|
Boolean Metadata filter |
Filtering boolean metadata fields. |
Meta value can be a boolean with true or false |
\- |
|
Numeric/Date Metadata filter |
This format is used to search/filter metadata with date or numeric data type. |
Operators included between meta key and meta value are :(equality), >, <, >=, <=, !=(comparison)
|
\- |
|
Text/Text Area Metadata filter |
This format is used to search/filter custom metadata with text or text-area data type. Here we are searching for specfic keywords (string) in the user specified meta-key. Please note that here we are searching for the exact specific keyword. |
Operators included between meta key and meta value are \~, \~\~ |
\- |
|
Filename search |
This format is used to search exact filename including extensiomn. |
filename keyword is used as meta-key and meta-value is the filename inside quotes |
\- |
Internal metadata search
Filerbot has a lot of internal metadata for assets. Some of them are able to be used in query string for filtering. We call them reserved keywords such as 'type', 'orientation', 'mimetype', 'color', 'resolution', 'faces', 'approval_status', 'enable_favorited'
These should not be used as meta-key for custom metadata fields. when creating metadata. The following can be used for searching and filtering results:
1. type: Used to filter asset type. Types are seperated by comma. If more than 1 is provided by then the operator between types is `OR`. Its accepted values are:application,image,text,video.
Example: &type=pdf,video
2. mimetype: Similar to type it is used to filter results by mimetype. If more than 1 is provided by then the operator between mimetype is OR. Its accepted values are:application/pdf, image/jpeg, image/png, image/tiff, image/webp,image/x-icon, text/html, image/x-photoshop ,image/vnd.adobe.photoshop, image/gif, video/mp4, image/tiff, image/webp etc.
Example: &mimetype=image/png,video/mp4
3. resolution:Filter by the image width. Resolutions are seperated by comma. If more than 1 resolution is provided by resolution, the operator between resolutions is OR.The possible value of resolution are:
-
&resolution=small(image width < 600) -
&resolution=medium(image width between 600 and 1800) -
&resolution=large(image width > 1800)
4. orientation: Filter by the image orientation . Orientations are seperated by comma. If more than 1 orientation is provided by orientation, the operator between orientations is OR.The possible value of resolution are:
1.&orientation=PA (panaroma image)
2.&orientation=PO (portrait image)
3\. &orientation=SQ (square image)
4\. &orientation=LD (landscape image)
5. size: Filter image by image size in mb.It is a range of number.The lower and upper limit is separated by ".." .
Example: &size=1..100
Labels search/filter:
You can filter results by multiple labels SID (SID is the internal value of an label which can be obtained by the /labels endpoint).
|
Parameter |
Type |
Description |
Example |
|---|---|---|---|
|
&labels_operator |
String |
If there are multiple labels you are searching by you can define the operator between them. The accepted values are |
\- |
|
|
String |
SID of the labels you want to search for. If multiple sepeerate by comma |
|
Order search results(&sort)
The search results can be sorted using the query parameter &sort. Sort results by name (default), uploaded_at, created_at, modified_at, size. Sort resuts with order asc or desc. Example: &sort=name:desc ; &sort=oploaded_at:asc
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to list/search recursively. 1 =yes; 0 =No |
|
|
Result limit (for pagination). |
|
|
Start offset (for pagination). |
|
|
See order search results for more info |
|
|
Format response. please see "format response" in GET file details |
|
|
Labels operator when using multiple labels. Acccepted values:OR,AND |
|
|
SID of the label. If you want to filter by labels. |
|
|
In which language variant to return results. Please check your token configuration for language abbreviation. Alternatively you can do a GET files request and see language abbreviation. |
|
|
Filter by mimetype |
|
|
Filter by resolution |
|
|
Filter by orientation |
|
|
Filter by image,video,audio |
|
|
Search parameter.See search parameter section. |
|
|
Filter by size of the file (in mb).First value is lower limit and second value is upper limit |
|
|
Filter by tags.SID of the tag you want to filter by. |
|
|
Search inspecific folder |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
POST Move multiple files
/{token}/v4/files/move
This API request is used to move multiple files (using UUID of those files ) to a new folder.
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
new_folder_name |
Yes |
Folder path |
String |
|
file_uuids |
Yes |
UUID of the files. If multiple then seperate each UUID by comma (,) |
Array |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Move single file
/{token}/v4/files/{file_uuid}/folders/{folder_uuid}
This API request is used to move a specific file to another folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to move |
|
|
UUID of the folder you want to move the file to. |
|
|
N/A |
|
|
N/A |
PATCH Rename file
/{token}/v4/files/{file_uuid}
This API is used to rename a file using file UUiD
Body attributes
|
Attribute name |
Required |
Description |
Type |
|---|---|---|---|
|
name |
Yes |
New name of the file |
String |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file to be renamed |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Upload File Base64
/{token}/v4/files
Upload File Base64
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
Folders (16)
POST Create folder
/{token}/v4/folders
This API is used to create new folder.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
name |
Directory path ending with the new folder name |
string |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete multiple folders
/{token}/v4/folders
This API is used to delete multiple folders.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
folders_uuids |
UUIDs of the folders to be deleted seperated by comma |
array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
DELETE Delete single folder
/{token}/v4/folders/{folder_uuid}
This API is used to delete single folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
UUID of the folder which needs to be deleted |
|
|
N/A |
|
|
N/A |
GET Get folder details
/{token}/v4/folders/{folder_uuid}
This API is used to get folder details using UUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the folder you want to get details of |
|
|
N/A |
|
|
N/A |
GET List & search folders
/{token}/v4/folders
This API is used to list and search folders.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Search string. If missing, endpoint behaves as a list endpoint |
|
|
Base list/search folder,ie. where to search |
|
|
Whether to list/search recursively. |
|
|
Result limit (for pagination). |
|
|
Start offset (for pagination). |
|
|
See "order search results" In "List and search files" for more info. |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
POST Move multiple folders
/{token}/v4/folders/move
This API is uded to move multiple folders.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
new_folder_name |
Directory of the folder where the folders should be moved |
String |
Yes |
|
folders_uuid |
UUID of the folders to be moved separated by comma |
array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Move single folder
/{token}/v4/folders/{folder_uuid}/folders/{folder2_uuid}
This API is used to move folders using UUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier |
|
|
Folder UUID which needs to be moved |
|
|
Folder UUID where it needs to be moved |
|
|
N/A |
|
|
N/A |
PATCH Rename folder
/{token}/v4/folders/{folder_uuid}
This API is used to rename folder using UUID of the folder.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
name |
New name of the folder |
string |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the folder you want to rename. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create folder
/{token}/v4/folders
This API is used to create new folder.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
name |
Directory path ending with the new folder name |
string |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete multiple folders
/{token}/v4/folders
This API is used to delete multiple folders.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
folders_uuids |
UUIDs of the folders to be deleted seperated by comma |
array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
DELETE Delete single folder
/{token}/v4/folders/{folder_uuid}
This API is used to delete single folder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
UUID of the folder which needs to be deleted |
|
|
N/A |
|
|
N/A |
GET Get folder details
/{token}/v4/folders/{folder_uuid}
This API is used to get folder details using UUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the folder you want to get details of |
|
|
N/A |
|
|
N/A |
GET List & search folders
/{token}/v4/folders
This API is used to list and search folders.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Search string. If missing, endpoint behaves as a list endpoint |
|
|
Base list/search folder,ie. where to search |
|
|
Whether to list/search recursively. |
|
|
Result limit (for pagination). |
|
|
Start offset (for pagination). |
|
|
See "order search results" In "List and search files" for more info. |
|
|
Filerobot project identifier, aka Token |
|
|
N/A |
|
|
N/A |
POST Move multiple folders
/{token}/v4/folders/move
This API is uded to move multiple folders.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
new_folder_name |
Directory of the folder where the folders should be moved |
String |
Yes |
|
folders_uuid |
UUID of the folders to be moved separated by comma |
array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Move single folder
/{token}/v4/folders/{folder_uuid}/folders/{folder2_uuid}
This API is used to move folders using UUID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier |
|
|
Folder UUID which needs to be moved |
|
|
Folder UUID where it needs to be moved |
|
|
N/A |
|
|
N/A |
PATCH Rename folder
/{token}/v4/folders/{folder_uuid}
This API is used to rename folder using UUID of the folder.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
name |
New name of the folder |
string |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the folder you want to rename. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Image quality (6)
POST Image quality JSON
/images/image-quality
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Image quality Multipart
/images/image-quality/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Image quality URL
/images/image-quality/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Image quality JSON
/images/image-quality
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Image quality Multipart
/images/image-quality/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Image quality URL
/images/image-quality/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Image-to-text (6)
POST Image-to-text JSON
/images/image-to-text
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Image-to-text Multipart
/images/image-to-text/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A textual prompt that guides the generation process |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Image-to-text URL
/images/image-to-text/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A textual prompt that guides the generation process |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Image-to-text JSON
/images/image-to-text
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Image-to-text Multipart
/images/image-to-text/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A textual prompt that guides the generation process |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Image-to-text URL
/images/image-to-text/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
A textual prompt that guides the generation process |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Invalidation (flush) (6)
POST Invalidate
/invalidate
scope
-
original: invalidates original image and all transformations.
-
all: invalidate the entire cache. Only use this scope if you know what you are doing ⚠️⚠️⚠️.
This endpoint will return an invalidation.uuid that can be used for checking the status or restarting the invalidation task.
Statuses:
-
RECEIVED: the request is received.
-
PREPARING: the system prepares to start the invalidation process
-
FLUSHING_CLOUDIMAGE_SERVER: the cache stored in the Cloudimage infra is flushing
-
FLUSHING_CDN_SERVERS: the cache of the CDN servers around the world is flushing
-
DONE: the invalidation is completed
-
ERROR: an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, [contact our Support team]() for help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
GET Invalidation status
/invalidate/{invalidation_uuid}
Statuses:
-
RECEIVED -> the request is received.
-
PREPARING -> the system prepares to start the invalidation process
-
FLUSHING_CLOUDIMAGE_SERVER -> the cache stored in the Cloudimage infra is flushing
-
FLUSHING_CDN_SERVERS -> the cache of the CDN servers around the world is flushing
-
DONE -> the invalidation is completed
-
ERROR -> an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, contact the Support team for help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
After performing invalidation request, the API response will contain the invalidation_uuid of your task |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Restart invalidation job
/invalidate/{invalidation_uuid}/restart
This endpoint can be used to RETRY (Restart) the invalidation task in case of need.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
After performing invalidation request, the API response will contain the invalidation_uuid of your task |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Invalidate
/invalidate
scope
-
original: invalidates original image and all transformations.
-
all: invalidate the entire cache. Only use this scope if you know what you are doing ⚠️⚠️⚠️.
This endpoint will return an invalidation.uuid that can be used for checking the status or restarting the invalidation task.
Statuses:
-
RECEIVED: the request is received.
-
PREPARING: the system prepares to start the invalidation process
-
FLUSHING_CLOUDIMAGE_SERVER: the cache stored in the Cloudimage infra is flushing
-
FLUSHING_CDN_SERVERS: the cache of the CDN servers around the world is flushing
-
DONE: the invalidation is completed
-
ERROR: an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, [contact our Support team]() for help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
GET Invalidation status
/invalidate/{invalidation_uuid}
Statuses:
-
RECEIVED -> the request is received.
-
PREPARING -> the system prepares to start the invalidation process
-
FLUSHING_CLOUDIMAGE_SERVER -> the cache stored in the Cloudimage infra is flushing
-
FLUSHING_CDN_SERVERS -> the cache of the CDN servers around the world is flushing
-
DONE -> the invalidation is completed
-
ERROR -> an error is thrown during the execution of the request. Please wait few minutes and try again or if the issue persists, contact the Support team for help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
After performing invalidation request, the API response will contain the invalidation_uuid of your task |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Restart invalidation job
/invalidate/{invalidation_uuid}/restart
This endpoint can be used to RETRY (Restart) the invalidation task in case of need.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
After performing invalidation request, the API response will contain the invalidation_uuid of your task |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Keys (2)
GET Get SASS Key
/{security_template_identifier}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot Security Template |
|
|
N/A |
|
|
N/A |
GET Get SASS Key
/{security_template_identifier}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot Security Template |
|
|
N/A |
|
|
N/A |
Labels (2)
GET Get all labels
/{token}/v4/labels
This API is used of list all labels.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka token |
|
|
N/A |
|
|
N/A |
GET Get all labels
/{token}/v4/labels
This API is used of list all labels.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka token |
|
|
N/A |
|
|
N/A |
Metadata structure (12)
POST Add list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This API is used to add a new list field's option.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
options |
An array containing api_slug and label for each of the new options |
Array |
Yes |
|
api_slug |
API slug value for the new options. It should be unique. Also - please do not use space (" ") but only underscores ("_") |
String |
Yes |
|
label |
Label name of the new option. This is the value that the Filerobot users will see. |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
DELETE Delete list option
/{token}/v4/meta/model/fields/{select_field_uuid}/options/{api_slug}
Delete an option of a field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
api_slug of the chosen field's value which needs to be deleted |
|
|
N/A |
|
|
N/A |
PATCH Edit single list option
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This API allows to edit an existing list option.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
current_api_slug |
Current api slug value which needs to be edited. Can be taken from "Get List options" result. |
String |
Yes |
|
options |
Array containing old API slug,new API slug and new label. |
Array |
Yes |
|
new_api_slug |
API slug value for the new options |
String |
Yes |
|
new_label |
label name of the new option |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
GET Get list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
Returns the list of all OPTIONS of one specified (by uuid) custom field.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
|
|
N/A |
GET Get metadata taxonomy
/{token}/v4/meta/model/fields
Returns the list of all custom fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
N/A |
|
|
N/A |
PUT Replace all list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This endpoint _replaces_ the existing list options.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
options |
Array containing api_slug and label for each of the new option |
Array |
Yes |
|
api_slug |
API slug value for the new options |
String |
Yes |
|
label |
label name of the new option |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
POST Add list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This API is used to add a new list field's option.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
options |
An array containing api_slug and label for each of the new options |
Array |
Yes |
|
api_slug |
API slug value for the new options. It should be unique. Also - please do not use space (" ") but only underscores ("_") |
String |
Yes |
|
label |
Label name of the new option. This is the value that the Filerobot users will see. |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
DELETE Delete list option
/{token}/v4/meta/model/fields/{select_field_uuid}/options/{api_slug}
Delete an option of a field
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
api_slug of the chosen field's value which needs to be deleted |
|
|
N/A |
|
|
N/A |
PATCH Edit single list option
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This API allows to edit an existing list option.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
current_api_slug |
Current api slug value which needs to be edited. Can be taken from "Get List options" result. |
String |
Yes |
|
options |
Array containing old API slug,new API slug and new label. |
Array |
Yes |
|
new_api_slug |
API slug value for the new options |
String |
Yes |
|
new_label |
label name of the new option |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
GET Get list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
Returns the list of all OPTIONS of one specified (by uuid) custom field.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
|
|
N/A |
GET Get metadata taxonomy
/{token}/v4/meta/model/fields
Returns the list of all custom fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
N/A |
|
|
N/A |
PUT Replace all list options
/{token}/v4/meta/model/fields/{select_field_uuid}/options
This endpoint _replaces_ the existing list options.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
options |
Array containing api_slug and label for each of the new option |
Array |
Yes |
|
api_slug |
API slug value for the new options |
String |
Yes |
|
label |
label name of the new option |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the chosen SELECT_ONE field |
|
|
N/A |
Metadata (2)
PUT Update file metadata
/{token}/v4/file/{file_uuid}/meta
This API is used to update a file's metadata.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
meta |
An array of key-value pairs.The key is metadata api-key and value is the the value you want to assign. |
Array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the file which needs to be updated with metadata. |
|
|
N/A |
PUT Update file metadata
/{token}/v4/file/{file_uuid}/meta
This API is used to update a file's metadata.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
meta |
An array of key-value pairs.The key is metadata api-key and value is the the value you want to assign. |
Array |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier,aka Token |
|
|
UUID of the file which needs to be updated with metadata. |
|
|
N/A |
Not Safe For Work (6)
POST NSFW JSON
/images/nsfw
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST NSFW Multipart
/images/nsfw/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET NSFW URL
/images/nsfw/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST NSFW JSON
/images/nsfw
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST NSFW Multipart
/images/nsfw/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET NSFW URL
/images/nsfw/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Number plate blurring (6)
POST Number plate blurring JSON
/images/plate-blurring
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate blurring Multipart
/images/plate-blurring/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Number plate blurring URL
/images/plate-blurring/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate blurring JSON
/images/plate-blurring
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate blurring Multipart
/images/plate-blurring/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Number plate blurring URL
/images/plate-blurring/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Number plate recognition (6)
POST Number plate recognition JSON
/images/plate-number-recognition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate recognition Multipart
/images/plate-number-recognition/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Number plate recognition URL
/images/plate-number-recognition/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate recognition JSON
/images/plate-number-recognition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Number plate recognition Multipart
/images/plate-number-recognition/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Number plate recognition URL
/images/plate-number-recognition/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
OCR (text extraction) (6)
POST OCR JSON
/images/ocr
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST OCR Multipart
/images/ocr/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET OCR URL
/images/ocr/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST OCR JSON
/images/ocr
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST OCR Multipart
/images/ocr/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET OCR URL
/images/ocr/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Language of the provided text |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Product type (6)
POST Product type classification JSON
/images/product-type-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Product type classification Multipart
/images/product-type-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Product type classification URL
/images/product-type-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Product type classification JSON
/images/product-type-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Product type classification Multipart
/images/product-type-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Product type classification URL
/images/product-type-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Products (12)
PUT Add files to product
/{token}/v4/file/{file_uuid}/product
This API is used to add files to a product.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
producr.position |
Position of an asset's product reference. |
Numeric |
No |
|
product.ref |
Product referenreference |
String |
Yes |
|
product
|
Contains the 'ref' and 'position' |
object |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to add to the product. |
|
|
N/A |
GET List product assets
/{token}/v4/product/{product_ref}/files
This API is used to list a product's assets using reference(ref).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to search for. You can get the ref from the "List products" API. |
|
|
N/A |
|
|
N/A |
GET List product images
/{token}/v4/product/{product_ref}/images
This API lists all assets assigned to a given product reference.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to search for.You can get the ref from the "List products" API. |
|
|
N/A |
|
|
N/A |
GET List products
/{token}/v4/products
This API is used to list the product references along with the count of the assigned assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
PATCH Modify product position
/{token}/v4/file/{file_uuid}/product/position
This API is used to change the position of an asset's product reference.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
position |
New position of the file in the product. |
Numeric |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
File UUID whose position need to be changed. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PATCH Modify product reference
/{token}/v4/product/{product_ref}
The API Renames an existing product reference.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
ref |
New reference name. |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to change. You can get the ref from the "List products" API. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Add files to product
/{token}/v4/file/{file_uuid}/product
This API is used to add files to a product.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
producr.position |
Position of an asset's product reference. |
Numeric |
No |
|
product.ref |
Product referenreference |
String |
Yes |
|
product
|
Contains the 'ref' and 'position' |
object |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
UUID of the file you want to add to the product. |
|
|
N/A |
GET List product assets
/{token}/v4/product/{product_ref}/files
This API is used to list a product's assets using reference(ref).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to search for. You can get the ref from the "List products" API. |
|
|
N/A |
|
|
N/A |
GET List product images
/{token}/v4/product/{product_ref}/images
This API lists all assets assigned to a given product reference.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to search for.You can get the ref from the "List products" API. |
|
|
N/A |
|
|
N/A |
GET List products
/{token}/v4/products
This API is used to list the product references along with the count of the assigned assets.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
N/A |
PATCH Modify product position
/{token}/v4/file/{file_uuid}/product/position
This API is used to change the position of an asset's product reference.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
position |
New position of the file in the product. |
Numeric |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
File UUID whose position need to be changed. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PATCH Modify product reference
/{token}/v4/product/{product_ref}
The API Renames an existing product reference.
Body attributes
|
Attribute |
Description |
Type |
Required |
|---|---|---|---|
|
ref |
New reference name. |
String |
Yes |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
ref of the product you want to change. You can get the ref from the "List products" API. |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Property classification (6)
POST Property classification JSON
/images/property-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Property classification Multipart
/images/property-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Property classification URL
/images/property-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Property classification JSON
/images/property-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Property classification Multipart
/images/property-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Property classification URL
/images/property-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Quality improvement (6)
POST Quality improvement JSON
/images/remove-artifacts
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
Scaling factor |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Quality improvement Multipart
/images/remove-artifacts/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
Scaling factor |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Quality improvement URL
/images/remove-artifacts/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Quality improvement JSON
/images/remove-artifacts
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
Scaling factor |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Quality improvement Multipart
/images/remove-artifacts/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
Scaling factor |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Quality improvement URL
/images/remove-artifacts/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Method for artifacts removal (sfx_basic, sfx_cpd) |
|
|
Trade-off between artifacts removal and details preservation |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Real estate authenticity (6)
POST Real estate authenticity JSON
/images/authenticity-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Real estate authenticity Multipart
/images/authenticity-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Real estate authenticity URL
/images/authenticity-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Real estate authenticity JSON
/images/authenticity-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Real estate authenticity Multipart
/images/authenticity-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Real estate authenticity URL
/images/authenticity-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Scene classification (6)
POST Scene classification JSON
/images/scene-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Scene classification Multipart
/images/scene-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Scene classification URL
/images/scene-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Scene classification JSON
/images/scene-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Scene classification Multipart
/images/scene-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Scene classification URL
/images/scene-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Sports classification (6)
POST Sports classification JSON
/images/sport-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Sports classification Multipart
/images/sport-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Sports classification URL
/images/sport-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Sports classification JSON
/images/sport-classification
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Sports classification Multipart
/images/sport-classification/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Sports classification URL
/images/sport-classification/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Text-to-image (2)
POST Text-to-image JSON
/images/text-to-image
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Text-to-image JSON
/images/text-to-image
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Transcode (4)
POST Transcode - Multipart
/transcode/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
Protocols to transcode to |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Transcode - URL
/transcode/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Transcode - Multipart
/transcode/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
Protocols to transcode to |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
POST Transcode - URL
/transcode/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Trim (4)
POST Trim - Multipart
/trim/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
List of time segments to extract from the video file |
POST Trim - URL
/trim/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Trim - Multipart
/trim/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
local file |
|
|
List of time segments to extract from the video file |
POST Trim - URL
/trim/url
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
width,height,x,y
|
|
|
width,height
|
|
|
Degrees to rotate to:
|
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
Warm-up (4)
POST Initiate warm-up
/urls
Warms up assets in the Cloudimage CDN with transformations.
Up to 5 Million URLs can be warmed up per day as JSON body or CSV file with the format below.
We recommend to run up to 1M URLs per batch and to run them every other hour.
Contact us if you need to warm up higher volumes.
<a class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' href="https://www.cloudimage.io/en/contact-us" target="_blank" url="https://www.cloudimage.io/en/contact-us">Contact us</a>http://sample.li/logo-cloudimg-black.png?w=200
/logo-cloudimg-white.png?w=200
/logo-cloudimg-yellow.png?w=200
/hotel.jpg?pixellate=5
/house.jpg?pixellate=5
/eye.jpg?w=500&h=280
```
⚠️ **Note**: Protocol and domain must be removed (e.g. https:sample.li/car.jpg?w=800)
⚠️ **Note**: you need to provide a transformation (with query parameters) to warm up images.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Warm-up status
/stats
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Initiate warm-up
/urls
Warms up assets in the Cloudimage CDN with transformations.
Up to 5 Million URLs can be warmed up per day as JSON body or CSV file with the format below.
We recommend to run up to 1M URLs per batch and to run them every other hour.
Contact us if you need to warm up higher volumes.
<a class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml' href="https://www.cloudimage.io/en/contact-us" target="_blank" url="https://www.cloudimage.io/en/contact-us">Contact us</a>http://sample.li/logo-cloudimg-black.png?w=200
/logo-cloudimg-white.png?w=200
/logo-cloudimg-yellow.png?w=200
/hotel.jpg?pixellate=5
/house.jpg?pixellate=5
/eye.jpg?w=500&h=280
```
⚠️ **Note**: Protocol and domain must be removed (e.g. https:sample.li/car.jpg?w=800)
⚠️ **Note**: you need to provide a transformation (with query parameters) to warm up images.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Warm-up status
/stats
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Watermark detection (6)
POST Watermark detection JSON
/images/watermark-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Watermark detection Multipart
/images/watermark-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Watermark detection URL
/images/watermark-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Watermark detection JSON
/images/watermark-detection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
POST Watermark detection Multipart
/images/watermark-detection/upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
local file |
GET Watermark detection URL
/images/watermark-detection/{url}
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Filerobot project identifier, aka token |
|
|
Filerobot API key |
|
|
N/A |