For the complete documentation index, see llms.txt. This page is also available as Markdown.

Images

Redirect to an Image.

get

Images should be downloaded and stored on the client server. Use /Common/ImageTypes to see a list of available image types. Note: The swagger U/I does not support redirects.

Path parameters
FilePathstringRequired

Filepath of Image.

Query parameters
RedirectbooleanOptional

Redirect to the image. Default = true

ExpirationMinutesstringOptional

Image url expiration in minutes. Default = 60. Maximum is 1440.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

ImageRedirectResponse

UrlstringOptional

URL to image request.

Expiresstring · date-timeOptional

Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

get/Images/{FilePath}/Redirect
200

Success

List of Batch Image.

post

Requires a list filepath.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Body
FilePatharrayOptional

List of Filepaths.

Responses
200

Success

application/json
ImageBatchResponse[]Optional
post/Images/Batch
200

Success

List of Screen Capture Responses.

post

Requires a list of filepaths.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Body
FilePatharrayOptional

List of Filepaths.

Responses
200

Success

application/json
ImageBatchResponse[]Optional
post/Images/ScreenCaptures/Batch
200

Success

Redirect to a Screen Capture.

get

Requires a valid filepath of a video asset screen capture. Note: The swagger U/I does not support redirects.

Query parameters
FilePathstringRequired

Filepath of Image.

RedirectbooleanOptional

Redirect to the image. Default = true

ExpirationMinutesstringOptional

Image url expiration in minutes. Default = 60. Maximum is 1440.

Header parameters
Acceptstring · enumRequired

Accept Header

Possible values:
Responses
200

Success

application/json

ScreenCaptureRedirectResponse

UrlstringOptional

URL to image request.

Expiresstring · date-timeOptional

Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

get/Images/ScreenCaptures/Redirect
200

Success

Last updated