Agent Try On - Hemsy | API Documentation

curl --request POST \
  --url https://api.hemsy.ai/visualize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sceneImage": "https://example.com/my-bedroom.jpg",
  "products": [
    {
      "title": "Linen Duvet Cover",
      "category": "bedding",
      "productUrl": "https://brand.com/products/linen-duvet",
      "images": [
        "https://brand.com/cdn/duvet-front.jpg"
      ]
    }
  ]
}
'

{
  "image": "<string>",
  "products": [
    {
      "index": 123,
      "fidelity": "generic",
      "storeSlug": "<string>"
    }
  ],
  "usage": {
    "credits": 123,
    "balance": 123
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

POST

visualize

curl --request POST \
  --url https://api.hemsy.ai/visualize \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sceneImage": "https://example.com/my-bedroom.jpg",
  "products": [
    {
      "title": "Linen Duvet Cover",
      "category": "bedding",
      "productUrl": "https://brand.com/products/linen-duvet",
      "images": [
        "https://brand.com/cdn/duvet-front.jpg"
      ]
    }
  ]
}
'

{
  "image": "<string>",
  "products": [
    {
      "index": 123,
      "fidelity": "generic",
      "storeSlug": "<string>"
    }
  ],
  "usage": {
    "credits": 123,
    "balance": 123
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

{
  "error": "<string>",
  "code": "<string>",
  "message": "<string>",
  "remaining_credits": 123,
  "developers_url": "<string>"
}

Authorizations

Authorization

string

header

required

Developer API key from developers.hemsy.ai (hemsy_...)

Body

application/json

sceneImage

string

required

Scene photo to render into: https URL or data URL (room, person, or space). Inline data URLs are capped at 8 MB.

products

object[]

required

Products to compose into the scene. Pass only the item(s) the user picked.

Required array length: 1 - 6 elements

Show child attributes

aspect

enum<string>

Output aspect. Only "auto" is supported: output matches the scene image.

Available options:

auto

Response

Successful render

image

string

The rendered image (data URL).

products

object[]

Show child attributes

usage

object

Show child attributes