> For the complete documentation index, see [llms.txt](https://knowledgebase.fabricdata.com/origin/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.fabricdata.com/origin/apis-all/image-api-docs/images.md). # 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":"fabric Origin API","version":"3.0"},"tags":[{"name":"images"}],"servers":[{"url":"https://api.origin.fabricdata.com"}],"paths":{"/Images/{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. Note: The swagger U/I does not support redirects.","operationId":"GetImageRedirectFilePathRedirect_Get","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":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageRedirectResponse"}}}}},"deprecated":false}}},"components":{"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"}}}} ``` ## List of Batch Image. > Requires a list filepath. ```json {"openapi":"3.1.1","info":{"title":"fabric Origin API","version":"3.0"},"tags":[{"name":"images"}],"servers":[{"url":"https://api.origin.fabricdata.com"}],"paths":{"/Images/Batch":{"post":{"tags":["images"],"summary":"List of Batch Image.","description":"Requires a list filepath.","operationId":"GetImageBatchBatch_Post","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}}}}},"deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"FilePath":{"type":"array","description":"List of Filepaths."}},"required":[]}}}}}}},"components":{"schemas":{}}} ``` ## List of Screen Capture Responses. > Requires a list of filepaths. ```json {"openapi":"3.1.1","info":{"title":"fabric Origin API","version":"3.0"},"tags":[{"name":"images"}],"servers":[{"url":"https://api.origin.fabricdata.com"}],"paths":{"/Images/ScreenCaptures/Batch":{"post":{"tags":["images"],"summary":"List of Screen Capture Responses.","description":"Requires a list of filepaths.","operationId":"GetScreenCaptureBatchScreenCapturesBatch_Post","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"title":"List","type":"array","items":{"$ref":"#/components/schemas/ImageBatchResponse"}}}}}},"deprecated":false,"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"FilePath":{"type":"array","description":"List of Filepaths."}},"required":[]}}}}}}},"components":{"schemas":{}}} ``` ## 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":"fabric Origin API","version":"3.0"},"tags":[{"name":"images"}],"servers":[{"url":"https://api.origin.fabricdata.com"}],"paths":{"/Images/ScreenCaptures/Redirect":{"get":{"tags":["images"],"summary":"Redirect to a Screen Capture.","description":"Requires a valid filepath of a video asset screen capture. Note: The swagger U/I does not support redirects.","operationId":"GetScreenCaptureRedirectScreenCapturesRedirect_Get","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":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenCaptureRedirectResponse"}}}}},"deprecated":false}}},"components":{"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"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://knowledgebase.fabricdata.com/origin/apis-all/image-api-docs/images.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.