--- title: "Retrieve metadata about a specific image" method: GET path: "/v1/images/{id}" tags: ["Images"] --- # Retrieve metadata about a specific image `GET /v1/images/{id}` ## Request - Base URL: `https://hcti.io` - URL: `https://hcti.io/v1/images/{id}` - Auth: HTTP basic ## Path parameters - `id` string, required ## Response `200` OK - union: Metadata shared by all images. The image_type discriminator identifies the response as html_css, url, or templated. - object: An image created from HTML and CSS, including its source content and stored rendering settings. The image_type is html_css. - `image_type` 'html_css', required - `css` string, nullable: CSS used to style the rendered HTML. - `device_scale` union: Screenshot pixel ratio. A value of 2 produces two output pixels per CSS pixel in each dimension. - number, double - string, double - `google_fonts` string, nullable: Google Font families to load, separated by a pipe, for example Roboto|Open Sans. - `html` string: HTML source supplied for rendering the image. - `max_wait_ms` union: Maximum loading wait in milliseconds before capture when the page continues loading content. - integer - string, int32 - `metadata` object, nullable: Custom key-value metadata stored with the image. - `ms_delay` union: Additional delay in milliseconds before taking the screenshot. - integer - string, int32 - `render_when_ready` boolean, nullable: Whether capture waits for the page to call ScreenshotReady(). Rendering fails if the readiness signal is not received. - `selector` string, nullable: CSS selector of the element to capture. When set, the image is cropped to the matching element. - `viewport_height` union: Browser viewport height in CSS pixels. - integer - string, int32 - `viewport_width` union: Browser viewport width in CSS pixels. - integer - string, int32 - `pdf_options` PDFOptions - `page_height` string, nullable: Height of the page, with unit (px, in, cm, mm, pt) - `page_width` string, nullable: Width of the page, with unit (px, in, cm, mm, pt) - `scale` union: Scale of the webpage rendering. Defaults to 1. - number, double - string, double - `margins` string[], nullable: Margins of the webpage rendering. Defaults to 0. 4 values must be supplied: top, right, bottom, left. Units are px, cm, in, mm, or pt. - `print_background` boolean: Print background graphics. - `disable_twemoji` boolean, nullable: HTML/CSS images use Twemoji by default; set true to disable it. URL images inject Twemoji only when explicitly set to false. For URLs, omitted, null, or true leaves the page's emoji handling unchanged. - `max_render_once` boolean, nullable: Whether the image is restricted to being rendered and saved at most once. - `color_scheme` unknown - `timezone` string, nullable: IANA timezone identifier exposed to the rendered page, such as America/New_York or UTC. - `viewport_mobile` boolean, nullable: Whether the browser viewport emulates a mobile device. - `viewport_landscape` boolean, nullable: Whether the browser viewport emulates landscape orientation. - `viewport_touch` boolean, nullable: Whether the browser emulates support for touch input. - `media_type` unknown - `proxy_id` string, nullable: ID of the proxy configured for browser requests, or null when no proxy is configured. - `storage_destination_id` string, nullable: ID of the configured storage destination for rendered files, or null when none is configured. - `jumbo_max_height` union: Maximum output height in pixels for jumbo rendering. Used together with jumbo_max_width. - integer - string, int32 - `jumbo_max_width` union: Maximum output width in pixels for jumbo rendering. Used together with jumbo_max_height. - integer - string, int32 - `transparent_background` boolean, nullable: Whether the default browser background is transparent. Backgrounds explicitly set by the page still apply. - `request_overrides` RequestOverride[], nullable: Browser request overrides. Block rules match URL wildcard patterns and/or resource types; supplied matchers must all match. - `action` 'block', required - `url` string, nullable: URL wildcard pattern to match, using * for any sequence of characters. When resource_types is also supplied, both matchers must match. - `resource_types` RequestOverrideResourceType[], nullable: Resource types to match, supplied as an array of names, such as image, script, xhr, or fetch. Any listed type may match. When url is also supplied, it must match too. - `id` string: Unique image ID. Use this value to retrieve image metadata or render the image. - `created_at` string, date-time: Date and time the image was created, in UTC. - `last_render_stored_at` string, date-time, nullable: Last recorded date and time a rendered image was stored by HCTI, in UTC. Null when no stored render timestamp is available. This value can change after rendering again or be cleared when the stored render is removed. - `og_config_id` string, nullable: ID of the Open Graph configuration that created this image, or null when the image is not associated with one. - `og_config_content_version` union: Content version of the Open Graph configuration associated with this image, or null when unavailable. - integer - string, int64 - `saved_to_storage_destination_at` string, date-time, nullable: Recorded date and time the base image was saved to its configured storage destination, in UTC. Null until a save is recorded; does not describe saves of resized or reformatted variants. - `storage_destination_hcti_storage_disabled` boolean, nullable: Whether HCTI storage is disabled for this image, recorded from the storage destination when the image was created. When true, rendered files are saved to the configured storage destination without a public HCTI image URL or HCTI CDN caching. - object: An image created by capturing a web page, including its source URL and stored rendering settings. The image_type is url. - `image_type` 'url', required - `css` string, nullable: CSS injected into the loaded URL to override styles on the page. - `device_scale` union: Screenshot pixel ratio. A value of 2 produces two output pixels per CSS pixel in each dimension. - number, double - string, double - `full_screen` boolean, nullable: Whether the screenshot captures the entire scrollable page after scrolling down and back to the top. - `max_wait_ms` union: Maximum loading wait in milliseconds before capture when the page continues loading content. - integer - string, int32 - `metadata` object, nullable: Custom key-value metadata stored with the image. - `ms_delay` union: Additional delay in milliseconds before taking the screenshot. - integer - string, int32 - `render_when_ready` boolean, nullable: Whether capture waits for the page to call ScreenshotReady(). Rendering fails if the readiness signal is not received. - `selector` string, nullable: CSS selector of the element to capture. When set, the image is cropped to the matching element. - `url` string: Source URL of the web page to capture. - `viewport_height` union: Browser viewport height in CSS pixels. - integer - string, int32 - `viewport_width` union: Browser viewport width in CSS pixels. - integer - string, int32 - `pdf_options` PDFOptions - `page_height` string, nullable: Height of the page, with unit (px, in, cm, mm, pt) - `page_width` string, nullable: Width of the page, with unit (px, in, cm, mm, pt) - `scale` union: Scale of the webpage rendering. Defaults to 1. - number, double - string, double - `margins` string[], nullable: Margins of the webpage rendering. Defaults to 0. 4 values must be supplied: top, right, bottom, left. Units are px, cm, in, mm, or pt. - `print_background` boolean: Print background graphics. - `disable_twemoji` boolean, nullable: HTML/CSS images use Twemoji by default; set true to disable it. URL images inject Twemoji only when explicitly set to false. For URLs, omitted, null, or true leaves the page's emoji handling unchanged. - `max_render_once` boolean, nullable: Whether the image is restricted to being rendered and saved at most once. - `color_scheme` unknown - `timezone` string, nullable: IANA timezone identifier exposed to the rendered page, such as America/New_York or UTC. - `block_consent_banners` boolean, nullable: Whether the browser attempts to block cookie and consent banners before capture. - `identify_as_hcti` boolean, nullable: Whether top-level page navigation includes the X-HCTI-SCREENSHOT: 1 header to identify the request as an HCTI screenshot. - `headers` object, nullable: Custom HTTP headers sent on top-level page navigations to the source URL's origin and any additional_header_origins. - `additional_header_origins` string[], nullable: Additional exact HTTP or HTTPS origins allowed to receive custom headers, in the form scheme://host[:port] without a path. - `include_headers_on_subrequests` boolean, nullable: Whether custom headers are also sent on subrequests to the source URL's origin and any additional_header_origins. - `viewport_mobile` boolean, nullable: Whether the browser viewport emulates a mobile device. - `viewport_landscape` boolean, nullable: Whether the browser viewport emulates landscape orientation. - `viewport_touch` boolean, nullable: Whether the browser emulates support for touch input. - `media_type` unknown - `proxy_id` string, nullable: ID of the proxy configured for browser requests, or null when no proxy is configured. - `storage_destination_id` string, nullable: ID of the configured storage destination for rendered files, or null when none is configured. - `jumbo_max_height` union: Maximum output height in pixels for jumbo rendering. Used together with jumbo_max_width. - integer - string, int32 - `jumbo_max_width` union: Maximum output width in pixels for jumbo rendering. Used together with jumbo_max_height. - integer - string, int32 - `transparent_background` boolean, nullable: Whether the default browser background is transparent. Backgrounds explicitly set by the page still apply. - `request_overrides` RequestOverride[], nullable: Browser request overrides. Block rules match URL wildcard patterns and/or resource types; supplied matchers must all match. - `action` 'block', required - `url` string, nullable: URL wildcard pattern to match, using * for any sequence of characters. When resource_types is also supplied, both matchers must match. - `resource_types` RequestOverrideResourceType[], nullable: Resource types to match, supplied as an array of names, such as image, script, xhr, or fetch. Any listed type may match. When url is also supplied, it must match too. - `id` string: Unique image ID. Use this value to retrieve image metadata or render the image. - `created_at` string, date-time: Date and time the image was created, in UTC. - `last_render_stored_at` string, date-time, nullable: Last recorded date and time a rendered image was stored by HCTI, in UTC. Null when no stored render timestamp is available. This value can change after rendering again or be cleared when the stored render is removed. - `og_config_id` string, nullable: ID of the Open Graph configuration that created this image, or null when the image is not associated with one. - `og_config_content_version` union: Content version of the Open Graph configuration associated with this image, or null when unavailable. - integer - string, int64 - `saved_to_storage_destination_at` string, date-time, nullable: Recorded date and time the base image was saved to its configured storage destination, in UTC. Null until a save is recorded; does not describe saves of resized or reformatted variants. - `storage_destination_hcti_storage_disabled` boolean, nullable: Whether HCTI storage is disabled for this image, recorded from the storage destination when the image was created. When true, rendered files are saved to the configured storage destination without a public HCTI image URL or HCTI CDN caching. - object: An image created from a specific template version and resolved template values. The image_type is templated. - `image_type` 'templated', required - `template_id` string: ID of the template used to create this image. - `template_version` union: Version of the template used to create this image. - integer - string, int64 - `template_values` JsonObject - `id` string: Unique image ID. Use this value to retrieve image metadata or render the image. - `created_at` string, date-time: Date and time the image was created, in UTC. - `last_render_stored_at` string, date-time, nullable: Last recorded date and time a rendered image was stored by HCTI, in UTC. Null when no stored render timestamp is available. This value can change after rendering again or be cleared when the stored render is removed. - `og_config_id` string, nullable: ID of the Open Graph configuration that created this image, or null when the image is not associated with one. - `og_config_content_version` union: Content version of the Open Graph configuration associated with this image, or null when unavailable. - integer - string, int64 - `saved_to_storage_destination_at` string, date-time, nullable: Recorded date and time the base image was saved to its configured storage destination, in UTC. Null until a save is recorded; does not describe saves of resized or reformatted variants. - `storage_destination_hcti_storage_disabled` boolean, nullable: Whether HCTI storage is disabled for this image, recorded from the storage destination when the image was created. When true, rendered files are saved to the configured storage destination without a public HCTI image URL or HCTI CDN caching. ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not Found ## Changes - **2026-09-30** `398cec19904b`: 2 info - added the optional property `anyOf[subschema #1: HTML/CSS Image]/request_overrides` to the response with the `200` status - added the optional property `anyOf[subschema #2: URL Image]/request_overrides` to the response with the `200` status - **2026-09-18** `ac9c51e1cec0`: 1 info - added the optional property `anyOf[subschema #3: Templated Image]/storage_destination_hcti_storage_disabled` to the response with the `200` status - **2026-09-15** `f0ffd4d0e310`: 1 info - endpoint added [Operation history](https://skmtc.dev/htmlcsstoimage/apis/html-css-to-image-api/changes/v1/images/:id/get.md) --- [API](https://skmtc.dev/htmlcsstoimage/apis/html-css-to-image-api.md) - [All operations](https://skmtc.dev/htmlcsstoimage/apis/html-css-to-image-api/llms.txt) - [OpenAPI document](https://skmtc.dev/htmlcsstoimage/apis/html-css-to-image-api/revisions/100550373ae1?raw)