Documentazione API di pedra.ai

API per creare immagini di home staging virtuale

Benvenuti nella documentazione ufficiale per l'API di pedra.ai. La nostra API offre potenti capacità di elaborazione delle immagini per vari compiti di miglioramento e progettazione degli ambienti.

URL di base

L'API è accessibile tramite il seguente URL di base:

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

Autenticazione

Tutte le chiamate API richiedono un parametro apiKey per l'autenticazione. Invia un'email a felix@pedra.ai per richiedere la tua chiave API.

Parametri Comuni

I seguenti parametri sono comuni a tutti gli endpoint:

  • apiKey (string, required): La tua chiave API unica per l'autenticazione.
  • imageUrl (string, required): URL dell'immagine (http/https) o URI dati base64 (data:image/...).

Punti di accesso API

Esegui Miglioramento

Migliora la qualità, il colore, la luce e la risoluzione dell'immagine fornita.

Endpoint: /enhance

Method: POST

Parameters:

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

Expected response time: 25 secondi

Esegui Stanza Vuota

Rimuove i mobili e il disordine dalla stanza nell'immagine fornita.

Endpoint: /empty_room

Method: POST

Parameters:

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

Expected response time: 25 secondi

Esegui Arredamento

Arreda (crea una messa in scena virtuale) di uno spazio secondo i parametri specificati.

Endpoint: /furnish

Method: POST

Parameters:

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

Expected response time: 25 secondi

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"

Esegui Ristrutturazione

Ristruttura una stanza secondo lo stile specificato.

Endpoint: /renovation

Method: POST

Parameters:

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

Expected response time: 25 secondi

roomType and style:

Same options as the Furnish endpoint above.

Cielo Blu

Migliora il cielo nelle immagini esterne, rendendolo blu e vibrante.

Endpoint: /sky_blue

Method: POST

Parameters:

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

Expected response time: ~15 secondi

Modifica con Prompt

Modifica l'immagine in base a un prompt in linguaggio naturale che descrive le modifiche desiderate.

Endpoint: /edit_via_prompt

Method: POST

Parameters:

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

Expected response time: ~20 secondi

Rimuovi Oggetto

Rimuove oggetti dall'immagine utilizzando una maschera per specificare quali aree rimuovere.

Endpoint: /remove_object

Method: POST

Parameters:

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

Expected response time: ~15 secondi

Sfoca Oggetti

Sfoca oggetti specifici nell'immagine in base all'elenco degli oggetti da sfocare fornito.

Endpoint: /blur

Method: POST

Parameters:

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

Il parametro objectsToBlur deve essere un elenco di oggetti separati da virgole (ad esempio, "targa, viso").

Expected response time: ~20 secondi

Crea Video

Crea un video immobiliare professionale combinando più immagini con effetti, sovrapposizioni, musica e branding. I video vengono creati in modo asincrono.

Endpoint: /create_video

Method: POST

Parameters

{
  "apiKey": "string",
  "images": [
    {
      "imageUrl": "string",
      "effect": "zoom-in" | "zoom-out",
      "subtitle": "string",
      "title": "string",
      "watermark": {
        "enabled": true | false,
        "position": "top-left" | "top" | "top-right" | "left" | "center" |
                    "right" | "bottom-left" | "bottom" | "bottom-right",
        "opacity": 0.0-1.0
      },
      "characteristics": {
        "enabled": true | false
      }
    }
  ],
  "isVertical": true | false,
  "propertyCharacteristics": [
    {
      "label": "string",
      "value": "string"
    }
  ],
  "music": {
    "enabled": true | false,
    "track": "calm" | "uplifting" | "corporate" | "piano"
  },
  "voice": {
    "enabled": true | false,
    "audioUrl": "string"
  },
  "branding": {
    "showWatermark": true | false,
    "watermarkUrl": "string",
    "showProfessionalPicture": true | false,
    "professionalPictureUrl": "string",
    "primaryColor": "string"
  },
  "endingTitle": "string",
  "endingSubtitle": "string"
}

Expected response time

2-5 minuti

Sovrapposizione Caratteristiche Proprietà

Aggiungi i dettagli della proprietà come pillola sovrapposta in fondo ai fotogrammi video. Le caratteristiche sono dettagli della proprietà (come camere da letto, bagni, superficie, prezzo) che appaiono sui fotogrammi dove sono abilitati.

Come Funziona

  • Definisci le caratteristiche a livello radice usando l'array propertyCharacteristics
  • Abilita per fotogramma impostando characteristics: {enabled: true} su immagini specifiche
  • Fino a 4 caratteristiche vengono visualizzate per fotogramma con icone e valori
  • Usa etichette standard (Bedrooms, Bathrooms, Surface, Price, ecc.) per la corretta visualizzazione dell'icona

Etichette Caratteristiche Disponibili

Queste etichette sono riconosciute e visualizzate con icone appropriate:

  • Bedrooms - Icona letto (es. "3", "4 cam")
  • Bathrooms - Icona bagno (es. "2", "2,5 bagni")
  • Surface - Icona espansione (es. "120m²", "1.500 mq")
  • Price - Icona dollaro (es. "450k€", "€320.000")
  • Location - Icona puntina (es. "Centro", "Malibu")
  • Parking - Icona auto (es. "2 auto", "Garage")
  • Heating - Icona fuoco (es. "Centralizzato", "Gas")
  • Outdoor - Icona albero (es. "Giardino", "Piscina")

Esempio di Richiesta

Ecco un esempio completo di creazione di un video verticale con sovrapposizione caratteristiche proprietà:

{
  "apiKey": "your-api-key",
  "images": [
    {
      "imageUrl": "https://example.com/image1.jpg",
      "effect": "zoom-in",
      "subtitle": "🏡 Stunning Family Home",
      "watermark": {"enabled": false},
      "characteristics": {"enabled": true}
    },
    {
      "imageUrl": "https://example.com/image2.jpg",
      "effect": "zoom-out",
      "subtitle": "Modern Kitchen & Living",
      "watermark": {"enabled": false},
      "characteristics": {"enabled": true}
    }
  ],
  "propertyCharacteristics": [
    {"label": "Bedrooms", "value": "3"},
    {"label": "Bathrooms", "value": "2"},
    {"label": "Surface", "value": "120m²"},
    {"label": "Price", "value": "$450,000"}
  ],
  "isVertical": true,
  "music": {
    "enabled": true,
    "track": "uplifting"
  },
  "endingTitle": "Schedule a Viewing!",
  "endingSubtitle": "Swipe up or DM us"
}

Formato di Risposta

Tutti gli endpoint API restituiscono risposte in formato JSON. Una risposta di successo avrà un codice di stato 200 e includerà le informazioni sull'immagine elaborata.

Gestione degli Errori

In caso di errore, l'API restituirà un codice di stato HTTP appropriato insieme a una risposta JSON contenente i dettagli dell'errore.

Supporto

Per qualsiasi domanda o problema riguardante l'API, si prega di contattare il nostro team di supporto all'indirizzo felix@pedra.ai.