# Images ## Redirect to an Image. > 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.\` ```json {"openapi":"3.1.1","info":{"title":"Image API","version":"1.0"},"tags":[{"name":"Images"}],"servers":[{"url":"https://api.origin.fabricdata.com/api/Images"}],"security":[{"ApiKeyHeader":[],"ApiKeyQuery":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","description":"Authorize requests passing your apiKey in HTTP header.","name":"Ocp-Apim-Subscription-Key","in":"header"}},"schemas":{"ImageRedirectResponse":{"title":"ImageRedirectResponse","properties":{"Url":{"description":"URL to image request.","type":"string"},"Expires":{"description":"Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z ","type":"string","format":"date-time"}},"description":"ImageRedirectResponse","type":"object"}}},"paths":{"/{FilePath}/Redirect":{"get":{"tags":["Images"],"summary":"Redirect to an Image.","description":"Images should be downloaded and stored on the client server. Use /Common/ImageTypes to see a list of available image types. \n\n\n`Note: The swagger U/I does not support redirects.`","operationId":"GetImage","parameters":[{"schema":{"type":"string"},"name":"FilePath","in":"path","description":"Filepath of Image.","required":true},{"schema":{"type":"boolean"},"name":"Redirect","in":"query","description":"Redirect to the image. Default = true","required":false},{"schema":{"type":"string"},"name":"ExpirationMinutes","in":"query","description":"Image url expiration in minutes. Default = 60. Maximum is 1440.","required":false}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageRedirectResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ImageRedirectResponse"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ImageRedirectResponse"}},"text/html":{"schema":{"$ref":"#/components/schemas/ImageRedirectResponse"}}}},"204":{"description":"No content."},"400":{"description":"Bad request."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden. The subscription key does not have permission to access this method."},"404":{"description":"Not found. The item you requested could not be found or has been deleted."},"409":{"description":"Conflict."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error."},"503":{"description":"Service unavailable."}},"deprecated":false}}}} ``` ## Redirect to a Screen Capture. > Requires a valid filepath of a video asset screen capture. \ > \ > \`Note: The swagger U/I does not support redirects.\` ```json {"openapi":"3.1.1","info":{"title":"Image API","version":"1.0"},"tags":[{"name":"Images"}],"servers":[{"url":"https://api.origin.fabricdata.com/api/Images"}],"security":[{"ApiKeyHeader":[],"ApiKeyQuery":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","description":"Authorize requests passing your apiKey in HTTP header.","name":"Ocp-Apim-Subscription-Key","in":"header"}},"schemas":{"ScreenCaptureRedirectResponse":{"title":"ScreenCaptureRedirectResponse","properties":{"Url":{"description":"URL to image request.","type":"string"},"Expires":{"description":"Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z ","type":"string","format":"date-time"}},"description":"ScreenCaptureRedirectResponse","type":"object"}}},"paths":{"/ScreenCaptures/Redirect":{"get":{"tags":["Images"],"summary":"Redirect to a Screen Capture.","description":"Requires a valid filepath of a video asset screen capture. \n\n`Note: The swagger U/I does not support redirects.`","operationId":"GetScreenCapture","parameters":[{"schema":{"type":"string"},"name":"FilePath","in":"query","description":"Filepath of Image.","required":true},{"schema":{"type":"boolean"},"name":"Redirect","in":"query","description":"Redirect to the image. Default = true","required":false},{"schema":{"type":"string"},"name":"ExpirationMinutes","in":"query","description":"Image url expiration in minutes. Default = 60. Maximum is 1440.","required":false}],"responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenCaptureRedirectResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ScreenCaptureRedirectResponse"}},"text/csv":{"schema":{"$ref":"#/components/schemas/ScreenCaptureRedirectResponse"}},"text/html":{"schema":{"$ref":"#/components/schemas/ScreenCaptureRedirectResponse"}}}},"204":{"description":"No content."},"400":{"description":"Bad request."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden. The subscription key does not have permission to access this method."},"404":{"description":"Not found. The item you requested could not be found or has been deleted."},"409":{"description":"Conflict."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error."},"503":{"description":"Service unavailable."}},"deprecated":false}}}} ``` ## List of Screen Capture Responses. > Requires a list of filepaths. ```json {"openapi":"3.1.1","info":{"title":"Image API","version":"1.0"},"tags":[{"name":"Images"}],"servers":[{"url":"https://api.origin.fabricdata.com/api/Images"}],"security":[{"ApiKeyHeader":[],"ApiKeyQuery":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","description":"Authorize requests passing your apiKey in HTTP header.","name":"Ocp-Apim-Subscription-Key","in":"header"}},"schemas":{"ImageBatchResponse":{"title":"ImageBatchResponse","properties":{"Url":{"description":"URL to image request.","type":"string"},"FilePath":{"description":"Requested FilePath of requested image.","type":"string"},"Expires":{"description":"Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z ","type":"string","format":"date-time"}},"description":"ImageBatchResponse","type":"object"}}},"paths":{"/ScreenCaptures/Batch":{"post":{"tags":["Images"],"summary":"List of Screen Capture Responses.","description":"Requires a list of filepaths.","operationId":"GetScreenCaptureBatch","responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"application/xml":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"text/csv":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"text/html":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}}}},"204":{"description":"No content."},"400":{"description":"Bad request."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden. The subscription key does not have permission to access this method."},"404":{"description":"Not found. The item you requested could not be found or has been deleted."},"409":{"description":"Conflict."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error."},"503":{"description":"Service unavailable."}},"deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"FilePath":{"type":"array","description":"List of Filepaths."}},"required":[]}}}}}}}} ``` ## List of Batch Image. > Requires a list filepath. ```json {"openapi":"3.1.1","info":{"title":"Image API","version":"1.0"},"tags":[{"name":"Images"}],"servers":[{"url":"https://api.origin.fabricdata.com/api/Images"}],"security":[{"ApiKeyHeader":[],"ApiKeyQuery":[]}],"components":{"securitySchemes":{"ApiKeyHeader":{"type":"apiKey","description":"Authorize requests passing your apiKey in HTTP header.","name":"Ocp-Apim-Subscription-Key","in":"header"}},"schemas":{"ImageBatchResponse":{"title":"ImageBatchResponse","properties":{"Url":{"description":"URL to image request.","type":"string"},"FilePath":{"description":"Requested FilePath of requested image.","type":"string"},"Expires":{"description":"Image URLs are hashed and expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z ","type":"string","format":"date-time"}},"description":"ImageBatchResponse","type":"object"}}},"paths":{"/Batch":{"post":{"tags":["Images"],"summary":"List of Batch Image.","description":"Requires a list filepath.","operationId":"GetImageBatch","responses":{"200":{"description":"OK.","content":{"application/json":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"application/xml":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"text/csv":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}},"text/html":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}}}},"204":{"description":"No content."},"400":{"description":"Bad request."},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden. The subscription key does not have permission to access this method."},"404":{"description":"Not found. The item you requested could not be found or has been deleted."},"409":{"description":"Conflict."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error."},"503":{"description":"Service unavailable."}},"deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"FilePath":{"type":"array","description":"List of Filepaths."}},"required":[]}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://knowledgebase.fabricdata.com/origin/apis-all/image-api-docs/images.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.