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.

Authorizations

ApiKeyHeader & ApiKeyQuery

Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

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

OK.

application/jsonapplication/xmltext/csvtext/html

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

204

No content.

400

Bad request.

401

Unauthorized.

403

Forbidden. The subscription key does not have permission to access this method.

404

Not found. The item you requested could not be found or has been deleted.

409

Conflict.

429

Too many requests.

500

Internal server error.

503

Service unavailable.

get

/{FilePath}/Redirect

HTTPcURLJavaScriptPython

GET /api/Images/{FilePath}/Redirect HTTP/1.1
Host: api.origin.fabricdata.com
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: application/json

{
  "Url": "text",
  "Expires": "2026-02-23T21:19:56.931Z"
}

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.

Authorizations

ApiKeyHeader & ApiKeyQuery

Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

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

OK.

application/jsonapplication/xmltext/csvtext/html

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

204

No content.

400

Bad request.

401

Unauthorized.

403

Forbidden. The subscription key does not have permission to access this method.

404

Not found. The item you requested could not be found or has been deleted.

409

Conflict.

429

Too many requests.

500

Internal server error.

503

Service unavailable.

get

/ScreenCaptures/Redirect

HTTPcURLJavaScriptPython

GET /api/Images/ScreenCaptures/Redirect?FilePath=text HTTP/1.1
Host: api.origin.fabricdata.com
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: application/json

{
  "Url": "text",
  "Expires": "2026-02-23T21:19:56.931Z"
}

List of Screen Capture Responses.

post

Requires a list of filepaths.

Authorizations

ApiKeyHeader & ApiKeyQuery

Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters

Acceptstring · enumRequired

Accept Header

Possible values:

Body

application/x-www-form-urlencoded

FilePatharrayOptional

List of Filepaths.

Responses

200

OK.

application/jsonapplication/xmltext/csvtext/html

ImageBatchResponse

UrlstringOptional

URL to image request.

FilePathstringOptional

Requested FilePath of requested image.

Expiresstring · date-timeOptional

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

204

No content.

400

Bad request.

401

Unauthorized.

403

Forbidden. The subscription key does not have permission to access this method.

404

Not found. The item you requested could not be found or has been deleted.

409

Conflict.

429

Too many requests.

500

Internal server error.

503

Service unavailable.

post

/ScreenCaptures/Batch

HTTPcURLJavaScriptPython

POST /api/Images/ScreenCaptures/Batch HTTP/1.1
Host: api.origin.fabricdata.com
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Content-Length: 15

"FilePath=[]"

[
  {
    "Url": "text",
    "FilePath": "text",
    "Expires": "2026-02-23T21:19:56.931Z"
  }
]

List of Batch Image.

post

Requires a list filepath.

Authorizations

ApiKeyHeader & ApiKeyQuery

Ocp-Apim-Subscription-KeystringRequired

Authorize requests passing your apiKey in HTTP header.

subscription-KeystringRequired

Authorize requests passing your apiKey in Querystring.

Header parameters

Acceptstring · enumRequired

Accept Header

Possible values:

Body

application/x-www-form-urlencoded

FilePatharrayOptional

List of Filepaths.

Responses

200

OK.

application/jsonapplication/xmltext/csvtext/html

ImageBatchResponse

UrlstringOptional

URL to image request.

FilePathstringOptional

Requested FilePath of requested image.

Expiresstring · date-timeOptional

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

204

No content.

400

Bad request.

401

Unauthorized.

403

Forbidden. The subscription key does not have permission to access this method.

404

Not found. The item you requested could not be found or has been deleted.

409

Conflict.

429

Too many requests.

500

Internal server error.

503

Service unavailable.

post

/Batch

HTTPcURLJavaScriptPython

POST /api/Images/Batch HTTP/1.1
Host: api.origin.fabricdata.com
Ocp-Apim-Subscription-Key: YOUR_API_KEY
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Content-Length: 15

"FilePath=[]"

[
  {
    "Url": "text",
    "FilePath": "text",
    "Expires": "2026-02-23T21:19:56.931Z"
  }
]