Scaleflexconnector v1.0 | OneTeg Documentation

/regenerate/remove-background

Trigger background removal for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for background removal.

/regenerate/brand-detection

Trigger brand recognition and logo detection for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for brand and logo recognition.

/regenerate/dominant-color

Trigger dominant color extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for dominant color detection.

/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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for face analysis.

/regenerate/face-count

Trigger face counting by extracting the number of faces for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for face count.

/regenerate/extract-metadata

Trigger metadata extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for metadata extraction.

/regenerate/nsfw

Trigger NSFW (Not Safe For Work) detection for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for NSFW detection.

/regenerate/plate-blurring

Trigger vehicle license plate number blurring for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for plate blurring.

/regenerate/plate-number-recognition

Trigger vehicle license plate number recognition for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for plate number recognition.

/regenerate/ocr

Trigger text extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for text extraction.

/regenerate/product-type-classification

Trigger product type classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for product type classification.

/regenerate/remove-artifacts

Trigger artifacts removal for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for quality improvement.

/regenerate/scene-classification

Trigger scene classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for scene classification.

/regenerate/sport-classification

Trigger sports classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/remove-background

Trigger background removal for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/brand-detection

Trigger brand recognition and logo detection for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/dominant-color

Trigger dominant color extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/face-count

Trigger face counting by extracting the number of faces for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/extract-metadata

Trigger metadata extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/nsfw

Trigger NSFW (Not Safe For Work) detection for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/plate-blurring

Trigger vehicle license plate number blurring for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/plate-number-recognition

Trigger vehicle license plate number recognition for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/ocr

Trigger text extraction for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/product-type-classification

Trigger product type classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/remove-artifacts

Trigger artifacts removal for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/scene-classification

Trigger scene classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/regenerate/sport-classification

Trigger sports classification for UUIDs in JSON body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/images/autotag

Automatically tag an image by sending its raw data in the JSON body of the request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/autotag/upload

Automatically tag an image by uploading it as a multipart form-data file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/autotag/{url}

Automatically tag an image by providing its public URL in the path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to tag.
`Content-type`	The content type of the image URL, used to inform the service of the image format.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/autotag

Automatically generate tags for an image by sending image data as JSON in the request body. Use this action when you have the image data as a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/autotag/upload

Upload an image file to automatically generate tags for it. Use this action when you need to tag an image by uploading the file directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/autotag/{url}

Automatically generate tags for an image by providing its public URL. Use this action when the image is already hosted and accessible via a URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-background

Remove the background from an image by sending its raw data in the JSON body of the request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-background/upload

Remove the background from an image by uploading it as a multipart form-data file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/remove-background/{url}

Remove the background from an image by providing its public URL in the path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Url`	The public URL of the image to process.
`Content-type`	The content type of the image URL, used to inform the service of the image format.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-background

Remove the background from an image by sending image data as JSON in the request body. Use this action when you have the image data as a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-background/upload

Remove the background from an image by uploading it as a multipart form. Use this when you have the image file available locally and need to isolate the subject.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/remove-background/{url}

Remove the background from an image specified by its URL. Use this when the image is already hosted online and you want to process it directly.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for background removal (sfx_rbg, sfx_slz, sfx_cpd, sfx_basic)
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/brand-detection

Detect brands and logos in an image by sending its raw data in the JSON body of the request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/brand-detection/upload

Detect brands and logos in an image by uploading it as a multipart form-data file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/brand-detection/{url}

Detect brands and logos in an image by providing its public URL in the path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type of the image URL, used to inform the service of the image format.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/brand-detection

Detect brands and logos in an image by sending a JSON payload with the image data. Use this to identify known brands within an image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/brand-detection/upload

Detect brands and logos in an image by uploading it as a multipart form. Use this when you have the image file locally and need to recognize brand logos.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/brand-detection/{url}

Detect brands and logos in an image specified by its URL. Use this to identify brands in an online image without downloading it first.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/bulk/upload

Upload multiple images in a single request using multipart form-data, optionally applying post-processing actions.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`Postprocess`	A JSON string defining post-processing operations to apply after upload, such as resizing or format conversion.

/images/bulk

Fetch a list of bulk operation results by providing the appropriate content type header.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/bulk/upload

Perform bulk operations on images by uploading them as a multipart form. Use this to process multiple images in a single request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`Postprocess`	A JSON string defining post-processing operations to apply after upload, such as resizing or format conversion.

/images/bulk

Perform bulk operations on images specified by URLs. Use this to process multiple online images in a single request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/chapters/upload

Upload a video file and generate chapters from its content. Use when you have the video file available to send directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Chapter Mode`	Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either: basic - Only .vtt file. advanced - Both .vtt and updated video.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/chapters/url

Generate chapters from a video hosted at the specified URL. Provide the direct URL to the video file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Chapter Mode`	Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either: basic - Only .vtt file. advanced - Both .vtt and updated video.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Url`	The direct URL of the video file to generate chapters from.

/chapters/upload

Generate chapters from a video or audio file uploaded as a multipart form. Use this to automatically create chapter markers for media content.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Chapter Mode`	Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either: basic - Only .vtt file. advanced - Both .vtt and updated video.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/chapters/url

Generate chapters from a video or audio file specified by its URL. Use this to create chapter markers for media hosted online.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Chapter Mode`	Used to determine if only the .vtt file is generated or the chapter info is also embedded into the output file. Can be either: basic - Only .vtt file. advanced - Both .vtt and updated video.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Url`	The direct URL of the file to convert.

/combine/upload

Upload multiple video files to combine them into a single video. Use when you have the video files available to send directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`File 2`	second local file

/combine/url

Combine two videos hosted at the specified URLs into a single video. Provide the direct URLs of both videos.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the first video to combine.
`Url 2`	The direct URL of the second video to combine.

/combine/upload

Combine multiple images into a single composite image by uploading them as a multipart form. Use this to create collages or merged visuals.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`File 2`	second local file

/combine/url

Combine multiple images specified by URLs into a single composite image. Use this to create collages from online images.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Url 2`	The direct URL of the second video to combine.

/compress/upload

Upload a file to compress it, reducing its size. Use when you have the file available to send directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Video-resolutions`	Resolution to compress the output file to
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/compress/url

Compress a file hosted at the specified URL. Optionally specify video resolutions for video compression.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to compress.
`Video Resolutions`	An array of desired video resolutions to apply during compression, for video files only.

/compress/upload

Compress an image by uploading it as a multipart form. Use this to reduce file size while preserving quality.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Video-resolutions`	Resolution to compress the output file to
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/compress/url

Compress an image specified by its URL. Use this to reduce the file size of an online image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Video Resolutions`	An array of desired video resolutions to apply during compression, for video files only.

/convert/upload

Upload a file to convert it to another format. Use when you have the file available to send directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Output Format`	Format of the output file
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/convert/url

Convert a file hosted at the specified URL to another format. Provide the direct URL to the file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Output Format`	Format of the output file
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Url`	The direct URL of the file to convert.

/convert/upload

Convert an image to a different format by uploading it as a multipart form. Use this to change the file type of a local image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Output Format`	Format of the output file
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/convert/url

Convert an image specified by its URL to a different format. Use this to change the file type of an online image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Output Format`	Format of the output file
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Url`	The direct URL of the file to convert.

/images/dominant-color

Extract the dominant colors from an image provided as a JSON payload containing the image data. Use when the image is available as a data URI or similar.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/dominant-color/upload

Upload an image file to extract its dominant colors. Use when you have the image file available to send directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/dominant-color/{url}

Extract the dominant colors from an image hosted at the specified URL. The URL is embedded in the endpoint path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/dominant-color

Extract the dominant colors from an image by sending a JSON payload with the image data. Use this to analyze the primary color palette.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/dominant-color/upload

Extract the dominant colors from an image by uploading it as a multipart form. Use this to analyze the color palette of a local image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/dominant-color/{url}

Extract the dominant colors from an image specified by its URL. Use this to analyze the color palette of an online image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Max Dominant Colors`	Maximum number of dominant colors to show
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-analysis

Analyze faces in an image provided as a JSON payload. Returns face attributes such as age, gender, and emotion.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-analysis/upload

Upload an image file to analyze faces in it. Returns face attributes such as age, gender, and emotion.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/face-analysis/{url}

Analyze faces in an image hosted at the specified URL. The URL is embedded in the endpoint path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-analysis

Analyze faces in an image by sending a JSON payload with the image data. Use this to detect facial features, emotions, or demographics.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-analysis/upload

Analyze faces in an image by uploading it as a multipart form. Use this to detect facial features in a local image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/face-analysis/{url}

Analyze faces in an image specified by its URL. Use this to detect facial features in an online image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-clustering/add

Add face data to a clustering group. Use to populate a face database for later clustering or recognition.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Keep Existing`	Should already added images be kept or discarded
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/images/face-clustering/cluster

Cluster faces from the stored database into groups based on similarity. Returns clusters of face identifiers.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Eps`	Maximum distance between two samples for one to be considered a neighbor of the other
`Min Samples`	Number of samples in a neighborhood for a point to be considered a core point for that cluster
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-clustering/delete

Delete face data from the clustering database. Use to remove specific face entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/images/face-clustering/predict

Predict which cluster a new face belongs to based on the existing clustering model. Returns the predicted cluster identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`File Uuid`	Id of image to use
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-clustering/add

Add a face to a face clustering group by uploading image data. Use this to register faces for later clustering or identification.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Keep Existing`	Should already added images be kept or discarded
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/images/face-clustering/cluster

Cluster faces that have been added into groups based on similarity. Use this to organize faces of the same person together.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Eps`	Maximum distance between two samples for one to be considered a neighbor of the other
`Min Samples`	Number of samples in a neighborhood for a point to be considered a core point for that cluster
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-clustering/delete

Delete a face from a face clustering group by sending the face identifier. Use this to remove incorrectly added or outdated face entries.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Uuids`	One or more asset UUIDs to reprocess for sports classification.

/images/face-clustering/predict

Predict which cluster a given face belongs to by sending the face data. Use this to match a face against existing clusters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`File Uuid`	Id of image to use
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-count

Count the number of faces in an image provided as a JSON payload. Use when the image is available as a data URI.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-count/upload

Upload an image file to count the number of faces in it. Use when you have the image file available.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/face-count/{url}

Count the number of faces in an image hosted at the specified URL. The URL is embedded in the endpoint path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-count

Counts the number of faces in an image provided as JSON in the request body. Use this action when you have the image data already available in JSON format.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/face-count/upload

Counts the number of faces in an image uploaded as a multipart file. Use this action when you need to upload an image file directly for face counting.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/face-count/{url}

Counts the number of faces in an image accessible via a given URL. Use this action when the image is hosted at a public URL and you want to analyze it remotely.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/videos/face-detection

Detect faces in a video provided as a JSON payload containing the video data. Use when the video is available as a data URI.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/videos/face-detection/upload

Upload a video file to detect faces in it. Returns timestamps and bounding boxes for each detected face.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/videos/face-detection/{url}

Detect faces in a video hosted at the specified URL. The URL is embedded in the endpoint path.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/videos/face-detection

Detects faces in a video provided as JSON in the request body. Use this action when the video data is already in JSON format.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/videos/face-detection/upload

Detects faces in a video uploaded as a multipart file. Use this action when you need to upload a video file directly for face detection.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/videos/face-detection/{url}

Detects faces in a video accessible via a given URL. Use this action when the video is hosted at a public URL and you want to analyze it remotely.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Frame Time`	Second to start the search from
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/files/{file_uuid}

This API request is used to delete single file.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to delete
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`csv,json`	\-	`json`	Sets the response format to either csv or json	`?format=json`
`select`	`api`,`label`,`human`,`internal`	`internal`	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.	`?format=select:human`
`tags`	`json_full`,`json_compact`	`json_full`	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`	`json_full`,`json_compact`	`json_compact`	Labels display format.son_full will return label values and internal keys while json_compact will only return the internal key.	`?format=labels:human`

Format Examples:
?format=json,select:internal;

JavaScript

?format=csv,select:label,tags:json_compact

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Format`	Format response.see format response section.
`Lang`	Language variant to be returned.Please use correct language abbreviation.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to get details of.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/get/{file_uuid}/iiif

This API is used to get details of an file in IIIF format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot Project identifier
`File Uuid`	UUID of the file you want to get details of in IIIF format
`Response Type`	The response format expected from the API (e.g. application/json).

/{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	\- `q="greater himalayas"`
Tag filter	This format is considered as filtering by tags.	Start and end with double quotes and include sharp (#) before begining of the tag	\- `q="#headgear"`
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. Double quote can be used here when space inside. Comma can be also between multiple meta values. It is an OR operator between meta values Addition (+) is used as a AND operator between multiple metadata fields.	\- `&q=kategorie:"Tiger"` \- `&q="new brand":"Saint Thomas"` \- `&q=brand:Adidas,Nike` \- `&q=kategorie:"Tiger"+brand:"Adidas"`
Boolean Metadata filter	Filtering boolean metadata fields.	Meta value can be a boolean with true or false	\- `q=approved:true` \- `&q=kategorie:"Tiger"+brand "Adidas"+approved:true`
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) Double quote can be used here when space inside. Meta values must be the numeric number or date	\- `&q="expiration date"!=2022-12-02` \- `&q="price material"!=100` \- `&q="price material">100`
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 \~, \~\~	\- `&q=Description~"product is hand made"`
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	\- `&q=filename:"girl.jpg"`

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`OR`, `AND`	\- `&labels_operator=AND` \- `&labels_oerator=OR`
`&labels`	String	SID of the labels you want to search for. If multiple sepeerate by comma	`&labels=lbxmw9j4s`

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Recursive`	Whether to list/search recursively. 1 =yes; 0 =No
`Limit`	Result limit (for pagination).
`Offset`	Start offset (for pagination).
`Order`	See order search results for more info
`Format`	Format response. please see "format response" in GET file details
`Labels Operator`	Labels operator when using multiple labels. Acccepted values:OR,AND
`Labels`	SID of the label. If you want to filter by labels.
`Variant`	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.
`Mimetype`	Filter by mimetype
`Resolution`	Filter by resolution
`Orientation`	Filter by orientation
`Type`	Filter by image,video,audio
`Q`	Search parameter.See search parameter section.
`Size`	Filter by size of the file (in mb).First value is lower limit and second value is upper limit
`Tags`	Filter by tags.SID of the tag you want to filter by.
`Folder`	Search inspecific folder
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Files Uuids`	The UUIDs of the files to move, provided as an array of strings.
`New Folder Name`	The name of the destination folder where the files should be moved.

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to move
`Folder Uuid`	UUID of the folder you want to move the file to.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file to be renamed
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new name to assign to the file, including its extension.

/{token}/v4/files

Upload File Base64

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Postactions`	A comma-separated list of post-upload actions to perform, such as resizing or converting.
`Data`	The Base64-encoded content of the file to upload.
`Name`	The name to give the uploaded file, including its extension.

/{token}/v4/files/{file_uuid}

This API request is used to delete single file.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to delete
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`csv,json`	\-	`json`	Sets the response format to either csv or json	`?format=json`
`select`	`api`,`label`,`human`,`internal`	`internal`	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.	`?format=select:human`
`tags`	`json_full`,`json_compact`	`json_full`	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`	`json_full`,`json_compact`	`json_compact`	Labels display format.son_full will return label values and internal keys while json_compact will only return the internal key.	`?format=labels:human`

Format Examples:
?format=json,select:internal;

JavaScript

?format=csv,select:label,tags:json_compact

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Format`	Format response.see format response section.
`Lang`	Language variant to be returned.Please use correct language abbreviation.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to get details of.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/get/{file_uuid}/iiif

This API is used to get details of an file in IIIF format.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot Project identifier
`File Uuid`	UUID of the file you want to get details of in IIIF format
`Response Type`	The response format expected from the API (e.g. application/json).

/{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	\- `q="greater himalayas"`
Tag filter	This format is considered as filtering by tags.	Start and end with double quotes and include sharp (#) before begining of the tag	\- `q="#headgear"`
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. Double quote can be used here when space inside. Comma can be also between multiple meta values. It is an OR operator between meta values Addition (+) is used as a AND operator between multiple metadata fields.	\- `&q=kategorie:"Tiger"` \- `&q="new brand":"Saint Thomas"` \- `&q=brand:Adidas,Nike` \- `&q=kategorie:"Tiger"+brand:"Adidas"`
Boolean Metadata filter	Filtering boolean metadata fields.	Meta value can be a boolean with true or false	\- `q=approved:true` \- `&q=kategorie:"Tiger"+brand "Adidas"+approved:true`
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) Double quote can be used here when space inside. Meta values must be the numeric number or date	\- `&q="expiration date"!=2022-12-02` \- `&q="price material"!=100` \- `&q="price material">100`
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 \~, \~\~	\- `&q=Description~"product is hand made"`
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	\- `&q=filename:"girl.jpg"`

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`OR`, `AND`	\- `&labels_operator=AND` \- `&labels_oerator=OR`
`&labels`	String	SID of the labels you want to search for. If multiple sepeerate by comma	`&labels=lbxmw9j4s`

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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Recursive`	Whether to list/search recursively. 1 =yes; 0 =No
`Limit`	Result limit (for pagination).
`Offset`	Start offset (for pagination).
`Order`	See order search results for more info
`Format`	Format response. please see "format response" in GET file details
`Labels Operator`	Labels operator when using multiple labels. Acccepted values:OR,AND
`Labels`	SID of the label. If you want to filter by labels.
`Variant`	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.
`Mimetype`	Filter by mimetype
`Resolution`	Filter by resolution
`Orientation`	Filter by orientation
`Type`	Filter by image,video,audio
`Q`	Search parameter.See search parameter section.
`Size`	Filter by size of the file (in mb).First value is lower limit and second value is upper limit
`Tags`	Filter by tags.SID of the tag you want to filter by.
`Folder`	Search inspecific folder
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Files Uuids`	The UUIDs of the files to move, provided as an array of strings.
`New Folder Name`	The name of the destination parent folder where the folders should be moved.

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to move
`Folder Uuid`	UUID of the folder you want to move the file to.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file to be renamed
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new name to assign to the folder.

/{token}/v4/files

Upload File Base64

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Postactions`	A comma-separated list of post-upload actions to perform, such as resizing or converting.
`Data`	The Base64-encoded content of the file to upload.
`Name`	The new name to assign to the 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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The name of the folder to create.

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders/{folder_uuid}

This API is used to delete single folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Folder Uuid`	UUID of the folder which needs to be deleted
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders/{folder_uuid}

This API is used to get folder details using UUID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Folder Uuid`	UUID of the folder you want to get details of
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders

This API is used to list and search folders.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Q`	Search string. If missing, endpoint behaves as a list endpoint
`Folder`	Base list/search folder,ie. where to search
`Recursive`	Whether to list/search recursively.
`Limit`	Result limit (for pagination).
`Offset`	Start offset (for pagination).
`Order`	See "order search results" In "List and search files" for more info.
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Folders Uuids`	The UUIDs of the folders to move, provided as an array of strings.
`New Folder Name`	The name of the destination parent folder where the folders should be moved.

/{token}/v4/folders/{folder_uuid}/folders/{folder2_uuid}

This API is used to move folders using UUID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier
`Folder Uuid`	Folder UUID which needs to be moved
`Folder2 Uuid`	Folder UUID where it needs to be moved
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Folder Uuid`	UUID of the folder you want to rename.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new name to assign to the 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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new name to assign to the folder.

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders/{folder_uuid}

This API is used to delete single folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Folder Uuid`	UUID of the folder which needs to be deleted
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders/{folder_uuid}

This API is used to get folder details using UUID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Folder Uuid`	UUID of the folder you want to get details of
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/folders

This API is used to list and search folders.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Q`	Search string. If missing, endpoint behaves as a list endpoint
`Folder`	Base list/search folder,ie. where to search
`Recursive`	Whether to list/search recursively.
`Limit`	Result limit (for pagination).
`Offset`	Start offset (for pagination).
`Order`	See "order search results" In "List and search files" for more info.
`Token`	Filerobot project identifier, aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Folders Uuids`	The UUIDs of the folders to move, provided as an array of strings.
`New Folder Name`	The name of the destination parent folder where the folders should be moved.

/{token}/v4/folders/{folder_uuid}/folders/{folder2_uuid}

This API is used to move folders using UUID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier
`Folder Uuid`	Folder UUID which needs to be moved
`Folder2 Uuid`	Folder UUID where it needs to be moved
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Folder Uuid`	UUID of the folder you want to rename.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Name`	The new name to assign to the folder.

/images/image-quality

Analyze the quality of an image provided as JSON data in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-quality/upload

Analyze the quality of an image uploaded as multipart form data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/image-quality/{url}

Analyze the quality of an image accessible via a public URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-quality

Assesses the quality of an image provided as JSON in the request body. Use this action when you have the image data in JSON format and need to evaluate its quality.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-quality/upload

Upload a multipart image file to assess its quality and receive a quality score. Use this when you have an image file to upload directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/image-quality/{url}

Assess the quality of an image hosted at the provided URL and receive a quality score. Use this when you have a publicly accessible image URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-to-text

Extract text from an image provided as JSON data in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-to-text/upload

Extract text from an image uploaded as multipart form data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Prompt`	A textual prompt that guides the generation process
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/image-to-text/{url}

Extract text from an image accessible via a public URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Prompt`	A textual prompt that guides the generation process
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-to-text

Send image data as JSON to extract text from the image using optical character recognition. Use this when you have image data in a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/image-to-text/upload

Upload a multipart image file to extract text from the image using optical character recognition. Use this when you have an image file to upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Prompt`	A textual prompt that guides the generation process
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/image-to-text/{url}

Extract text from an image hosted at the provided URL using optical character recognition. Use this when you have a publicly accessible image URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Prompt`	A textual prompt that guides the generation process
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/invalidate

C

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the invalidation request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Scope`	The scope of the invalidation, such as 'everything' or 'urls' to target specific items.
`Urls`	An array of specific URLs to invalidate when the scope is set to 'urls'.

/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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Invalidation Uuid`	After performing invalidation request, the API response will contain the invalidation_uuid of your task
`X-client-key`	The client key required to authenticate the status request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/invalidate/{invalidation_uuid}/restart

This endpoint can be used to RETRY (Restart) the invalidation task in case of need.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Invalidation Uuid`	After performing invalidation request, the API response will contain the invalidation_uuid of your task
`X-client-key`	The client key required to authenticate the restart request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/invalidate

C

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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the restart request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Scope`	The scope of the invalidation, such as 'everything' or 'urls' to target specific items.
`Urls`	An array of specific URLs to invalidate when the scope is set to 'urls'.

/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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Invalidation Uuid`	After performing invalidation request, the API response will contain the invalidation_uuid of your task
`X-client-key`	The client key required to authenticate the restart request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/invalidate/{invalidation_uuid}/restart

This endpoint can be used to RETRY (Restart) the invalidation task in case of need.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Invalidation Uuid`	After performing invalidation request, the API response will contain the invalidation_uuid of your task
`X-client-key`	The client key required to authenticate the restart request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{security_template_identifier}

Retrieve the SASS (Scaleflex Asset Security System) key associated with a given security template identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Security Template Identifier`	Filerobot Security Template
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{security_template_identifier}

Retrieve the SASS key associated with the given security template identifier. Use this to obtain an API key for authentication.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Security Template Identifier`	Filerobot Security Template
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/labels

This API is used of list all labels.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/labels

This API is used of list all labels.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/meta/model/fields/{select_field_uuid}/options/{api_slug}

Delete an option of a field

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Api Slug`	api_slug of the chosen field's value which needs to be deleted
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The authentication token required to authorize the metadata update.
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/meta/model/fields

Returns the list of all custom fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/meta/model/fields/{select_field_uuid}/options/{api_slug}

Delete an option of a field

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Api Slug`	api_slug of the chosen field's value which needs to be deleted
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	The authentication token required to authorize the metadata update.
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/meta/model/fields

Returns the list of all custom fields.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`Select Field Uuid`	UUID of the chosen SELECT_ONE field
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`File Uuid`	UUID of the file which needs to be updated with metadata.
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier,aka Token
`File Uuid`	UUID of the file which needs to be updated with metadata.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/nsfw

Analyze an image provided as JSON payload to determine if it contains not-safe-for-work content.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/nsfw/upload

Analyze an image uploaded via multipart form data to detect not-safe-for-work content.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/nsfw/{url}

Analyze an image accessible at a given URL to determine if it contains not-safe-for-work content.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/nsfw

Send image data as JSON to check if the image contains not safe for work content. Use this when you have image data in a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/nsfw/upload

Upload a multipart image file to check if the image contains not safe for work content. Use this when you have an image file to upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/nsfw/{url}

Check if an image hosted at the provided URL contains not safe for work content. Use this when you have a publicly accessible image URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-blurring

Blur number plates in an image provided as JSON payload to anonymize vehicle license plates.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-blurring/upload

Blur number plates in an image uploaded via multipart form data to anonymize vehicle license plates.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/plate-blurring/{url}

Blur number plates in an image accessible at a given URL to anonymize vehicle license plates.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-blurring

Send image data as JSON to blur number plates detected in the image. Use this when you have image data in a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-blurring/upload

Upload a multipart image file to blur number plates detected in the image. Use this when you have an image file to upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/plate-blurring/{url}

Blur number plates in an image hosted at the provided URL. Use this when you have a publicly accessible image URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-number-recognition

Recognize and extract number plate text from an image provided as JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-number-recognition/upload

Recognize and extract number plate text from an image uploaded via multipart form data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/plate-number-recognition/{url}

Recognize and extract number plate text from an image accessible at a given URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-number-recognition

Send image data as JSON to recognize and read number plates in the image. Use this when you have image data in a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/plate-number-recognition/upload

Upload a multipart image file to recognize and read number plates in the image. Use this when you have an image file to upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/plate-number-recognition/{url}

Recognize and read number plates in an image hosted at the provided URL. Use this when you have a publicly accessible image URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/ocr

Extract text from an image using optical character recognition, with the image provided as JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/ocr/upload

Extract text from an image using optical character recognition, with the image uploaded via multipart form data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/ocr/{url}

Extract text from an image accessible at a given URL using optical character recognition.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/ocr

Extracts text from an image provided as a JSON payload. Use when you want to send image data inline in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/ocr/upload

Extracts text from an image uploaded as multipart form data. Use when you need to upload an image file directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/ocr/{url}

Extracts text from an image accessible at a given URL. Use when the image is already hosted online.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Language`	Language of the provided text
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/product-type-classification

Classify an image into a product type category, with the image provided as JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/product-type-classification/upload

Classify an image into a product type category, with the image uploaded via multipart form data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/product-type-classification/{url}

Classify the product type of an image located at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/product-type-classification

Classifies an image into a product category using a JSON payload. Use to identify the type of product shown in an image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/product-type-classification/upload

Classifies an image into a product category using a multipart upload. Use to identify the type of product shown in an image file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/product-type-classification/{url}

Classifies an image into a product category from a URL. Use to identify the type of product shown in an image hosted online.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to add to the product.
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/product/{product_ref}/files

This API is used to list a product's assets using reference(ref).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to search for. You can get the ref from the "List products" API.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/product/{product_ref}/images

This API lists all assets assigned to a given product reference.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to search for.You can get the ref from the "List products" API.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/products

This API is used to list the product references along with the count of the assigned assets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	File UUID whose position need to be changed.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Position`	The new integer position value to assign to the product.

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to change. You can get the ref from the "List products" API.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ref`	The new string reference to assign to the 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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	UUID of the file you want to add to the product.
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/product/{product_ref}/files

This API is used to list a product's assets using reference(ref).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to search for. You can get the ref from the "List products" API.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/product/{product_ref}/images

This API lists all assets assigned to a given product reference.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to search for.You can get the ref from the "List products" API.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/{token}/v4/products

This API is used to list the product references along with the count of the assigned assets.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Response Type`	The response format expected from the API (e.g. application/json).

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`File Uuid`	File UUID whose position need to be changed.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Position`	The new integer position value to assign to the product.

/{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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Token`	Filerobot project identifier, aka token
`Product Ref`	ref of the product you want to change. You can get the ref from the "List products" API.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ref`	The new string reference to assign to the product.

/images/property-classification

Classify properties of an image by submitting a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/property-classification/upload

Classify properties of an image by uploading a multipart file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/property-classification/{url}

Classify properties of an image located at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/property-classification

Classifies properties of an image (e.g., indoor/outdoor, lighting) using a JSON payload. Use to analyze image attributes.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/property-classification/upload

Classifies properties of an image using a multipart upload. Use to analyze image attributes from a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/property-classification/{url}

Classifies properties of an image from a URL. Use to analyze image attributes of a hosted image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Your Filerobot API token for authentication.
`Filerobot-key`	Your Filerobot API key for authentication.
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-artifacts

Improve image quality by removing artifacts using a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Upscale`	Scaling factor
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-artifacts/upload

Improve image quality by removing artifacts via multipart file upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Upscale`	Scaling factor
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/remove-artifacts/{url}

Improve image quality by removing artifacts from an image at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-artifacts

Enhances image quality by removing artifacts using a JSON payload. Use to improve image clarity and reduce noise.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Upscale`	Scaling factor
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/remove-artifacts/upload

Enhances image quality by removing artifacts using a multipart upload. Use to improve clarity of an uploaded image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Upscale`	Scaling factor
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/remove-artifacts/{url}

Enhances image quality by removing artifacts from an image at a URL. Use to improve clarity of a hosted image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Method`	Method for artifacts removal (sfx_basic, sfx_cpd)
`Smoothing`	Trade-off between artifacts removal and details preservation
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/authenticity-detection

Detect whether a real estate image is authentic using a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/authenticity-detection/upload

Detect whether a real estate image is authentic via multipart file upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/authenticity-detection/{url}

Detect whether a real estate image at the specified URL is authentic.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/authenticity-detection

Detects whether a real estate image is authentic or manipulated using a JSON payload. Use to verify image integrity.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/authenticity-detection/upload

Detects authenticity of a real estate image using a multipart upload. Use to verify image integrity from a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/authenticity-detection/{url}

Detects authenticity of a real estate image from a URL. Use to verify image integrity of a hosted image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/scene-classification

Classify the scene of an image using a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/scene-classification/upload

Classify the scene of an image via multipart file upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/scene-classification/{url}

Classify the scene of an image located at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/scene-classification

Classifies the scene depicted in an image (e.g., beach, city) using a JSON payload. Use to categorize image content.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/scene-classification/upload

Classifies the scene of an image using a multipart upload. Use to categorize content from a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/scene-classification/{url}

Classifies the scene of an image from a URL. Use to categorize content of a hosted image.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/sport-classification

Classify the sport depicted in an image using a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/sport-classification/upload

Classify the sport depicted in an image via multipart file upload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/sport-classification/{url}

Classify the sport depicted in an image at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/sport-classification

Classifies the sport shown in an image using a JSON payload. Use to identify the type of sport in an image.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/sport-classification/upload

Upload an image file via multipart form data to classify the sport depicted in it.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/sport-classification/{url}

Retrieve sports classification results for an image located at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/text-to-image

Generate an image from a text description using a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Prompt`	The text prompt describing the desired image.

/images/text-to-image

Generate an image from a textual description provided in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Prompt`	The text prompt describing the desired image.

/transcode/upload

Transcode a media file by uploading it as multipart data.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Video-protocols`	Protocols to transcode to
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/transcode/url

Transcode a media file from the specified URL.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Video Protocols`	A comma-separated list of video protocols to use for transcoding.

/transcode/upload

Upload a media file via multipart form data to transcode it into a different format.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Video-protocols`	Protocols to transcode to
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/transcode/url

Transcode a media file located at the specified URL into a different format.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Video Protocols`	A comma-separated list of video protocols to use for transcoding.

/trim/upload

Upload a file to be trimmed, specifying the trim parameters in the multipart request body. Use this action when you need to trim a video or audio file by uploading it directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`Time Data`	List of time segments to extract from the video file

/trim/url

Trim a media file by providing its URL and optional time data to specify the trim start and end points. Use this action when the media file is already accessible via a URL.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Time Data`	JSON object specifying the start and end times (in seconds) for the trim operation, for example {"start": 10, "end": 20}.

/trim/upload

Upload a media file via multipart form data to trim it to a desired segment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Sides in pixels of the cropped window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`File`	local file
`Time Data`	List of time segments to extract from the video file

/trim/url

Trim a media file located at the specified URL to a desired segment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Crop`	width,height,x,y width, height: Size of the crop window x, y: Top-left coordinates to align the crop window's top-left corner (optional, default = 0, 0)
`Resize`	width,height Target size of the converted video. If only one value is specified, it is interpreted as height and the aspect ratio is kept.
`Rotate`	Degrees to rotate to: Positive values rotate clockwise Negative - counterclockwise
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The direct URL of the file to convert.
`Time Data`	JSON object specifying the start and end times (in seconds) for the trim operation, for example {"start": 10, "end": 20}.

/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.

Go

<a class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;  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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the restart request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	The Base64-encoded content of the file to upload.

/stats

Retrieve the current warm-up status and statistics for the CDN. Use this action to monitor the progress of warm-up operations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the restart request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/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.

Go

<a class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;  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
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the restart request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Data`	The Base64-encoded content of the file to upload.

/stats

Retrieve the current warm-up status of the CDN or cache infrastructure.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`X-client-key`	The client key required to authenticate the restart request.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Response Type`	The response format expected from the API (e.g. application/json).

/images/watermark-detection

Detect watermarks in an image by sending image data as JSON in the request body. Use this action when you have the image data available as a JSON payload.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/watermark-detection/upload

Upload an image file to detect watermarks in it. Use this action when you need to analyze an image for watermarks by uploading the file directly.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/watermark-detection/{url}

Detect watermarks in an image by providing its public URL. Use this action when the image is already hosted and accessible via a URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/watermark-detection

Detect watermarks in an image provided directly in the request body.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

/images/watermark-detection/upload

Upload an image via multipart form data to detect watermarks present in it.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	local file

/images/watermark-detection/{url}

Detect watermarks in an image located at the specified URL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Url`	The public URL of the image to analyze.
`Content-type`	The content type header to specify the format of the response (e.g., application/json).
`Filerobot-token`	Filerobot project identifier, aka token
`Filerobot-key`	Filerobot API key
`Response Type`	The response format expected from the API (e.g. application/json).

ASK Filerobot regenerate (28)

Auto-tagging (6)

Background removal (6)

Brand (logo) recognition (6)

Bulk operations (4)

Chapters (4)

Combine (4)

Compress (4)

Convert (4)

Dominant color extraction (6)

Face analysis (6)

Face clustering (8)

Face count (6)

Face detection (6)

Files (18)

Body attributes

Format parameters(?format=):

Search parameter (&q=)

Internal metadata search

Labels search/filter:

Order search results(&sort)

Body attributes

Body attributes

Body attributes

Format parameters(?format=):

Search parameter (&q=)

Internal metadata search

Labels search/filter:

Order search results(&sort)

Body attributes

Body attributes

Folders (16)

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Image quality (6)

Image-to-text (6)

Invalidation (flush) (6)

Keys (2)

Labels (2)

Metadata structure (12)

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Metadata (2)

Body attributes

Body attributes

Not Safe For Work (6)

Number plate blurring (6)

Number plate recognition (6)

OCR (text extraction) (6)

Product type (6)

Products (12)

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Body attributes

Property classification (6)

Quality improvement (6)

Real estate authenticity (6)

Scene classification (6)

Sports classification (6)

Text-to-image (2)

Transcode (4)

Trim (4)

Warm-up (4)

Watermark detection (6)