Skip to content
Nappai Documentation

StageinHome API

StageinHome API is a tool that lets you transform a plain room photo into a beautifully decorated interior. By sending an image and choosing a room type and style, the component talks to the StageInHome AI service and returns a new image that shows how the space could look after a professional interior design makeover.

How it Works

The component takes an image that you provide in base‑64 format. It then sends this image to the StageInHome API, telling the service which room (bedroom, living room, bathroom, or kitchen) and which design style (modern, rustic, industrial, or Scandinavian) you want. The API processes the image, applies the chosen style, and returns a new image. The component receives that image, keeps it in base‑64 form, and outputs it as a Data object that can be used elsewhere in your workflow.

Inputs

  • Image in base 64: The photo you want to decorate, encoded as a base‑64 string.
  • Room Choice: Pick the type of room you are decorating (bedroom, living room, bathroom, kitchen).
  • Style Choice: Pick the interior design style you prefer (modern, rustic, industrial, scandinavian).

Credential
This component requires a credential of type StageInHome AI system.

  1. First, add the credential in Nappai’s credentials section.
  2. Then, select that credential in the component’s Credential field.
    The credential holds the StageInHome API Key that the component uses to talk to the service.

Outputs

  • Output: A Data object that contains the decorated image as a base‑64 string. The image is wrapped in Markdown syntax so it can be displayed directly in dashboards or exported to other tools.

Usage Example

  1. Prepare an image: Convert a photo of a bedroom to a base‑64 string (many online tools can do this).
  2. Add the StageinHome API component to your workflow.
  3. Set the inputs:
    • Image in base 64: paste the base‑64 string.
    • Room Choice: bedroom
    • Style Choice: modern
  4. Select the StageInHome credential you created earlier.
  5. Run the workflow.
  6. Use the Output: The resulting Data object can be fed into an Image Display component, saved to a file, or sent to another system.
  • Image Input – Capture or upload an image to use as the source.
  • Image Output – Display or export images produced by other components.
  • AI Decoration – Other AI‑powered decoration tools that may offer different styles or customization options.

Tips and Best Practices

  • Keep the image resolution high enough to see details but not so large that it slows the API call.
  • Test with a few different styles to find the look that best fits your brand or project.
  • Store the API key in a secure credential store; never hard‑code it in your workflow.
  • If you need to decorate many images, consider batching them to reduce the number of API calls.

Security Considerations

  • The StageInHome API Key is sensitive; treat it like a password.
  • Use Nappai’s credential management to keep the key out of the workflow code.
  • Ensure that any logs or monitoring tools do not expose the key or the base‑64 image data.