pedra.ai API Documentation

API to create virtual home staging images

Welcome to the official documentation for the pedra.ai 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.ai/api

Authentication

All API calls require an apiKey parameter for authentication. Send an email to felix@pedra.ai 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): Image URL (http/https) or base64 data URI (data:image/...).

API Endpoints

Enhance

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

Endpoint: /enhance

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: 25 seconds

Empty Room

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

Endpoint: /empty_room

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: 25 seconds

Furnish

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

Endpoint: /furnish

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "roomType": "string",
  "style": "string",
  "creativity": "Medium" | "High"
}

Expected response time: 25 seconds

roomType (string):

You can write any room type (e.g., "Living room", "Bedroom", "Kitchen", "Office", etc.)

Example values for style:

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

Renovation

Renovates a room according to the specified style.

Endpoint: /renovation

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "creativity": "Medium" | "High",
  "furnish": true | false,
  "style": "string",
  "roomType": "string"
}

Expected response time: 25 seconds

roomType and style:

Same options as the Furnish endpoint above.

Blue Sky

Enhances the sky in exterior images, making it appear blue and vibrant.

Endpoint: /sky_blue

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string"
}

Expected response time: ~15 seconds

Edit with Prompt

Edits the image based on a natural language prompt describing the desired changes.

Endpoint: /edit_via_prompt

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "prompt": "string"
}

Expected response time: ~20 seconds

Remove Object

Removes objects from the image using a mask to specify which areas to remove.

Endpoint: /remove_object

Method: POST

Parameters:

{
  "apiKey": "string",
  "imageUrl": "string",
  "maskUrl": "string"
}

Expected response time: ~15 seconds

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 felix@pedra.ai.