Produkt
Preise

Pedra.so API-Dokumentation

API zur Erstellung von virtuellen Home-Staging-Bildern

Willkommen bei der offiziellen Dokumentation der Pedra.so API. Unsere API bietet leistungsstarke Bildverarbeitungsfunktionen für verschiedene Raumverbesserungs- und Designaufgaben.


Basis-URLs

Die API ist über die folgende Basis-URL erreichbar:

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

Authentifizierung

Alle API-Aufrufe erfordern einen apiKey Parameter zur Authentifizierung. Senden Sie eine E-Mail an felix@pedra.so, um Ihren API-Schlüssel anzufordern.


Allgemeine Parameter

Die folgenden Parameter sind für alle Endpunkte gleich:

  • apiKey (String, erforderlich): Ihr einzigartiger API-Schlüssel zur Authentifizierung.
  • imageUrl (String, erforderlich): URL des zu verarbeitenden Bildes.

Endpunkte

Enhance ausführen

Verbessert die Qualität, Farbe, Licht und Auflösung des bereitgestellten Bildes.

Endpunkt: /enhance

Methode: POST

Parameter: Allgemeine Parameter (siehe oben)

Erwartete Antwortzeit: Zwischen 25 Sekunden und 1 Minute


Empty Room ausführen

Entfernt Möbel und Unordnung aus dem Raum im bereitgestellten Bild.

Endpunkt: /empty_room

Methode: POST

Parameter: Allgemeine Parameter (siehe oben)

Erwartete Antwortzeit: Zwischen 2 und 3 Minuten


Furnish ausführen

Möbliert (erstellt ein virtuelles Staging) einen Raum gemäß den angegebenen Parametern.

Endpunkt: /furnish

Methode: POST

Parameter:

  • Allgemeine Parameter (siehe oben)
  • roomType (String, erforderlich): Art des zu möblierenden Raums.
  • style (String, erforderlich): Anzuwendender Designstil.

Erwartete Antwortzeit: Zwischen 2 und 3 Minuten

Mögliche Werte für roomType:

  • "Schlafzimmer"
  • "Wohnzimmer"
  • "Küche"
  • "Büro"
  • "Terrasse"
  • "Esszimmer"
  • "Küche + Wohnzimmer"
  • "Ess- + Wohnzimmer"
  • "Eingang"

Mögliche Werte für style:

  • "Traditionell"
  • "Minimalistisch"
  • "Skandinavisch"
  • "Mid-Century"
  • "Bohemian"
  • "Industrial"
  • "Mediterran"
  • "Modern"
  • "Pyrenäen"

Renovation ausführen

Renoviert einen Raum gemäß dem angegebenen Stil.

Endpunkt: /renovation

Methode: POST

Parameter:

  • Allgemeine Parameter (siehe oben)
  • style (String, erforderlich): Anzuwendender Designstil für die Renovierung.
  • preserveWindows (Boolean, erforderlich): Ob bestehende Fenster während der Renovierung erhalten bleiben sollen.

Erwartete Antwortzeit: Zwischen 25 Sekunden und 2 Minuten


Antwortformat

Alle API-Endpunkte geben JSON-Antworten zurück. Eine erfolgreiche Antwort hat einen Statuscode von 200 und enthält die verarbeiteten Bildinformationen.


Fehlerbehandlung

Im Fehlerfall gibt die API einen entsprechenden HTTP-Statuscode zusammen mit einer JSON-Antwort zurück, die Fehlerdetails enthält.


Support

Bei Fragen oder Problemen mit der API wenden Sie sich bitte an unser Support-Team unter felix@pedra.so.