Pedra.so API Documentation

API to create virtual home staging images

Welcome to the official documentation for the Pedra.so API. Our API provides powerful image processing capabilities for various room enhancement and design tasks.

Base URLs

The API can be accessed through the following base URL:

  • Production: https://app.pedra.so/api

Authentication

All API calls require an apiKey parameter for authentication. Send an email to felix@pedra.so to request your API key.

Common Parameters

The following parameters are common to all endpoints:

  • apiKey (string, required): Your unique API key for authentication.
  • imageUrl (string, required): URL of the image to be processed.
  • creativity (string, required): Level of creative freedom for the AI.
    • Low: Preserves the original architecture with minimal variations.
    • Medium: Maintains the original architecture with noticeable but balanced variations.

API Endpoints

Run Enhance

Enhances the quality, color, light and resolution of the provided image.

Endpoint: /enhance

Method: POST

Parameters: Common parameters (see above)

Expected response time: Between 25 seconds and 1 minute

Run Empty Room

Removes furniture and clutter from the room in the provided image.

Endpoint: /empty_room

Method: POST

Parameters: Common parameters (see above)

Expected response time: Between 2 and 3 minutes

Run Furnish

Furnishes (creates a virtual staging) of a space according to specified parameters.

Endpoint: /furnish

Method: POST

Parameters: Common parameters + roomType + style

Expected response time: Between 2 and 3 minutes

Possible values for roomType:

  • "Bedroom"
  • "Living room"
  • "Kitchen"
  • "Office"
  • "Terrace"
  • "Dining room"
  • "Kitchen + Living room"
  • "Dining + Living room"
  • "Entrance"

Possible values for style:

  • "Traditional"
  • "Minimalist"
  • "Scandinavian"
  • "Mid-century"
  • "Bohemian"
  • "Industrial"
  • "Mediterranean"
  • "Modern"
  • "Pyrenees"

Run Renovation

Renovates a room according to the specified style.

Endpoint: /renovation

Method: POST

Parameters: Common parameters + style + preserveWindows

Expected response time: Between 25 seconds and 2 minutes

Response Format

All API endpoints return JSON responses. A successful response will have a status code of 200 and include the processed image information.

Error Handling

In case of an error, the API will return an appropriate HTTP status code along with a JSON response containing error details.

Support

For any questions or issues regarding the API, please contact our support team at <a href="mailto:felix@pedra.so" style="color: rgb(248, 121, 42); text-decoration: none;">felix@pedra.so</a>.