# Hemsy | API Documentation

## Docs

- [Overview](https://docs.hemsy.ai/embeds/overview.md): Add the Hemsy embed to your storefront: pick an install path, then configure launchers and what happens at checkout.
- [Shopify Theme Extension](https://docs.hemsy.ai/embeds/shopify.md): Install Hemsy on a Shopify storefront from the theme editor: an app embed for the script and a trigger block for launch buttons. No code.
- [Script Install](https://docs.hemsy.ai/embeds/script.md): Install the Hemsy embed with one script tag: for headless Shopify storefronts, custom frontends, and any page where you own the markup.
- [Launch Modes](https://docs.hemsy.ai/embeds/launch-modes.md): Control what each click opens: Sandbox, PDP, Bundle, Share, Flow, or Instant Mode.
- [Checkout vs Cart Resolution](https://docs.hemsy.ai/embeds/checkout-vs-cart.md): Choose what the final CTA does: open Shopify checkout, or hand variant data back to your storefront's own cart.
- [JavaScript API](https://docs.hemsy.ai/embeds/javascript-api.md): Open and close Hemsy programmatically with window.HemsyEmbed, and configure the embed with window.HemsyEmbedConfig.
- [Deep Links](https://docs.hemsy.ai/deep-links.md): Pre-populate a shopper's Hemsy session with products, bundles, shared looks, and attribution data via URL parameters.
- [Segment](https://docs.hemsy.ai/segment.md): Forward Hemsy try-on events from the embedded or hosted experience to your Segment workspace.
- [Endear](https://docs.hemsy.ai/endear.md): Let stylists turn a Hemsy try-on look into an Endear story without leaving the try-on experience.
- [Roles & Permissions](https://docs.hemsy.ai/permissions.md): Owner, admin, and viewer access in the Hemsy merchant dashboard.
- [Merchant Try On](https://docs.hemsy.ai/api-reference/merchant-try-on.md): Generate a try-on render for your own storefront's products, billed to your merchant account.
- [Overview](https://docs.hemsy.ai/agents/overview.md): The Visualize API renders any product photorealistically into any scene photo, built for agents, paid per call with prepaid credits.
- [Authentication](https://docs.hemsy.ai/agents/authentication.md): Create a developer account, buy prepaid credits, and authenticate with a Bearer API key.
- [MCP](https://docs.hemsy.ai/agents/mcp.md): Connect to the Hemsy visualize MCP server from Cursor, Claude, ChatGPT, or any MCP client.
- [REST API](https://docs.hemsy.ai/agents/rest-api.md): POST /visualize: the same render as the MCP tool, callable from anything that speaks HTTP.
- [Agent Try On](https://docs.hemsy.ai/api-reference/agent-try-on.md): Render any product(s) into any scene photo, billed to your developer account. Products from Hemsy merchants automatically upgrade to full catalog fidelity.

## OpenAPI Specs

- [visualize-openapi](https://docs.hemsy.ai/api-reference/visualize-openapi.json)
- [openapi](https://docs.hemsy.ai/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.