HTML/CSS to Image API

Deletes a webhook. Deliveries that have not been sent yet are not sent. Repeated deletion succeeds. Returns true on success.

delete_webhook

Deletes an Open Graph image configuration. Returns true on success.

delete_og_config

Returns the current organization's external_id and HCTI writer_role_arn. Use external_id as sts:ExternalId and writer_role_arn as Principal.AWS in the AWS IAM role trust policy when configuring S3 storage. No storage destination ID is required.

get_aws_storage_external_id

Gets an organization's proxy configuration, including whether it is enabled and whether authentication is configured. The configured username is returned; passwords are never returned.

get_proxy

Gets a storage destination's configuration, enabled state, and most recent connection test result. Secret access keys are never returned.

get_storage_destination

Gets a webhook's endpoint, subscribed events, parameters, signing setting, and enabled state. Secret parameter values and the signing secret are never returned.

get_webhook

Gets one webhook event: its payload, and each destination's delivery status and attempts with HTTP results. data is null and payload_withheld is true when you can't read the event's resource.

get_webhook_event

Retrieves one Open Graph image configuration by ID. Returns its mode, enabled state, domain_id, and mode-specific rendering options or template settings in item. Use this before update_og_config to preserve existing settings; use list_og_configs to discover an ID.

get_og_config

Lists the organization's Open Graph configurations in descending creation order, including disabled configurations. Results are in item.data. Pass item.pagination.next_page_start as page_start to continue; a null cursor marks the last page.

list_og_configs

Lists the organization's proxies, including disabled proxies. Returns configuration without passwords in item.data. Use an entry's id as proxy_id in image or template requests. Pass item.pagination.next_page_start as page_start to continue; a null cursor marks the last page.

list_proxies

Lists the organization's storage destinations, including disabled destinations. Returns configuration without secret access keys in item.data. Use an entry's id as storage_destination_id in image or template requests. Pass item.pagination.next_page_start as page_start to continue; a null cursor marks the last page.

list_storage_destinations

Lists saved versions of one template, newest first, with their content and rendering settings in data. Use this to inspect a template before updating it or select an older version for create_templated_image. Pass pagination.next_page_start as max_version to continue; stop when data is empty or the cursor is null.

list_template_versions

Lists the connected organization's templates with their latest versions, newest first. Use this to find a template by name and inspect its content and rendering settings. Results are in data; pass an entry's id as template_id to create_templated_image. For more results, pass pagination.next_page_start as max_version. Stop when data is empty or the cursor is null.

list_templates

Lists the organization's webhooks, including disabled webhooks. Returns endpoints, subscribed events, and parameters in item.data; secret parameter values and signing secrets are never returned. Pass item.pagination.next_page_start as page_start to continue; a null cursor marks the last page.

list_webhooks

Get the maximum number of images that can be created in a single batch according to the user's plan. Returns 0 when batching is not supported; create images individually instead.

get_max_batch_size

Sends a webhook_test delivery to an enabled webhook's endpoint, signed and with its parameters like any other delivery. Each webhook accepts one test every 30 seconds, including the test sent when it is created or its delivery settings change. Returns the event ID; check delivery status with get_webhook_event.

send_webhook_test_event

Sends feedback to the HCTI team about HTML/CSS to Image, its API, or its MCP tools. Use this to report bugs or unexpected rendering results, request features, describe confusing behavior or documentation, and suggest improvements. Include relevant context such as what you tried, what you expected, and what happened. If the user did not ask you to send feedback, ask them before submitting. Do not include API keys, credentials, tokens, or personal or confidential data. Returns a confirmation message and feedback ID.

submit_feedback

Updates an existing HTML/CSS image template. Replaces its latest version when that version has not been rendered; otherwise creates a new version. Returns item.template_id and item.template_version. Call create_templated_image with the returned ID and version to render the updated design. Use list_template_versions to inspect existing content before replacing it.

update_template

Replaces an existing Open Graph image configuration and returns the saved configuration in item. Call get_og_config first to inspect settings that should be preserved; omitted optional settings are cleared or reset to defaults. Supply the complete configuration for the chosen config_type. Changes affect subsequent image requests using this configuration. After a plan downgrade, only disabling is accepted and other changes are ignored.

update_og_config