Get Result Image
Stream a PNG/JPEG visual image referenced by an extraction
response under bounding_boxes.Images[].image_url.
The URL is API-hosted instead of raw S3 — the underlying object
store is intentionally not part of the public contract. The host
in image_url mirrors the request origin (e.g. a request to a
beta deployment returns image URLs on that same host).
Authentication is required. Unlike single-use result download
links, visual artifacts are
independently-addressable resources — every fetch must present a
valid API key for the owning org. There is no anonymous /
TTL-based fallback. Use the same x-api-key header you use for
/extract.
Fetching an image does not consume the parent extraction’s result-delivery slot, so one extraction can produce many image URLs and each can be fetched repeatedly while the artifact is retained.
Overview
Fetch a PNG or JPEG visual image referenced by an extraction response underbounding_boxes.Images[].image_url.
When you call /extract with figure_processing.show_images: true, every detected chart or embedded image in the response carries an image_url field. Those URLs point at this endpoint — GET /results/{jobId}/images/{filename} — which streams the actual image bytes.
When to use this vs. /large_results/{jobId}
End-to-End Example
The full path: extract a workbook → walk the typedImages array → fetch one chart’s bytes.
Authentication
Every request must present a validx-api-key header for the org that owns the extraction. Unlike the legacy single-use /large_results/{jobId} route, visual artifacts are independently-addressable resources — there is no anonymous fallback or short-lived public link.
- Authenticated same-org calls (your
x-api-keymatches the org that produced the extraction): succeed for as long as the underlying artifact is retained — same window as any other extraction artifact for that org. - Missing credentials (no
x-api-keyheader): rejected with401 Unauthorized(AUTH_001). - Cross-org authenticated calls (valid key, but not the owning org): rejected with
403 Forbidden(AUTH_002).
Pulse(api_key=...) / new PulseClient({ apiKey: ... }) constructor will attach x-api-key to every results.getImage fetch automatically.
image_url are fine — the link is multi-use. Fetching does not consume the parent extraction’s result-delivery slot, so one extraction can produce many image URLs and each can be downloaded as many times as needed.Errors
Next Steps
Bounding Boxes
Images, Tables, Text, Title, and Footer arrays.Extract Endpoint
figure_processing.show_images to populate image_url.Authorizations
Path Parameters
Job identifier — same value used in the image_url returned from /extract.
Visual filename — e.g. excel_image_1_1.png. Must be the exact filename segment from the image_url.
Response
Visual image bytes (image/png or image/jpeg).
The response is of type file.