pedra.ai API-Dokumentation
API zur Erstellung virtueller Home-Staging-Bilder
Willkommen zur offiziellen Dokumentation der pedra.ai API. Unsere API bietet leistungsstarke Bildverarbeitungsfähigkeiten für verschiedene Raumverbesserungs- und Designaufgaben.
URLs Base
L'API peut être accédée via l'URL de base suivante :
- Production:
https://app.pedra.ai/api
Authentification
Tous les appels API nécessitent un paramètre apiKey pour l'authentification. Envoyez un email à felix@pedra.ai pour demander votre clé API.
Paramètres Communs
Les paramètres suivants sont communs à tous les endpoints :
apiKey(string, required): Votre clé API unique pour l'authentification.imageUrl(string, required): Bild-URL (http/https) oder base64-Daten-URI (data:image/...).
API-Endpoints
Verbesserung ausführen
Verbessert Qualität, Farbe, Licht und Auflösung des bereitgestellten Bildes.
Endpoint: /enhance
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string"
}Expected response time: 25 Sekunden
Leeren Raum ausführen
Entfernt Möbel und Unordnung aus dem Raum im bereitgestellten Bild.
Endpoint: /empty_room
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string"
}Expected response time: 25 Sekunden
Möblierung ausführen
Möbliert (erstellt virtuelles Staging) eines Raumes nach spezifizierten Parametern.
Endpoint: /furnish
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string",
"roomType": "string",
"style": "string",
"creativity": "Medium" | "High"
}Expected response time: 25 Sekunden
roomType (string):
You can write any room type (e.g., "Living room", "Bedroom", "Kitchen", "Office", etc.)
Example values for style:
- "Traditionell"
- "Minimalistisch"
- "Scandinave"
- "Mid-Century"
- "Bohème"
- "Industrial"
- "Mediterran"
- "Modern"
- "Pyrenéen"
Renovierung ausführen
Renoviert einen Raum nach dem spezifizierten Stil.
Endpoint: /renovation
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string",
"creativity": "Medium" | "High",
"furnish": true | false,
"style": "string",
"roomType": "string"
}Expected response time: 25 Sekunden
roomType and style:
Same options as the Furnish endpoint above.
Himmel Blau
Verbessert den Himmel in Außenaufnahmen und lässt ihn blau und lebendig erscheinen.
Endpoint: /sky_blue
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string"
}Expected response time: ~15 Sekunden
Mit Prompt Bearbeiten
Bearbeitet das Bild basierend auf einer natürlichsprachigen Eingabe, die die gewünschten Änderungen beschreibt.
Endpoint: /edit_via_prompt
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string",
"prompt": "string"
}Expected response time: ~20 Sekunden
Objekt Entfernen
Entfernt Objekte aus dem Bild mithilfe einer Maske, um anzugeben, welche Bereiche entfernt werden sollen.
Endpoint: /remove_object
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string",
"maskUrl": "string"
}Expected response time: ~15 Sekunden
Objekte Verwischen
Verwischt bestimmte Objekte im Bild basierend auf der bereitgestellten Liste der zu verwischenden Objekte.
Endpoint: /blur
Method: POST
Parameters:
{
"apiKey": "string",
"imageUrl": "string",
"objectsToBlur": "string"
}Der Parameter objectsToBlur sollte eine durch Kommas getrennte Liste von Objekten sein (z. B. "Autokennzeichen, Gesicht").
Expected response time: ~20 Sekunden
Video Erstellen
Erstellt ein professionelles Immobilienvideo durch Kombination mehrerer Bilder mit Effekten, Überlagerungen, Musik und Branding. Videos werden asynchron erstellt.
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 Minuten
Immobilieneigenschaften Overlay
Fügen Sie Immobiliendetails als Overlay-Pill am unteren Rand der Videoframes hinzu. Eigenschaften sind Immobiliendetails (wie Schlafzimmer, Badezimmer, Fläche, Preis), die auf aktivierten Frames erscheinen.
Wie es funktioniert
- Definieren Sie Eigenschaften auf Root-Ebene mit dem propertyCharacteristics-Array
- Aktivieren Sie pro Frame durch Setzen von characteristics: {enabled: true} auf bestimmten Bildern
- Bis zu 4 Eigenschaften werden pro Frame mit Symbolen und Werten angezeigt
- Verwenden Sie Standardbezeichnungen (Bedrooms, Bathrooms, Surface, Price usw.) für die korrekte Symbolanzeige
Verfügbare Eigenschaftsbezeichnungen
Diese Bezeichnungen werden erkannt und mit entsprechenden Symbolen angezeigt:
- Bedrooms - Bett-Symbol (z.B. "3", "4 bed")
- Bathrooms - Bad-Symbol (z.B. "2", "2,5 bath")
- Surface - Flächen-Symbol (z.B. "120m²", "1.500 qm")
- Price - Dollar-Symbol (z.B. "450.000€", "$320.000")
- Location - Pin-Symbol (z.B. "Stadtzentrum", "Malibu")
- Parking - Auto-Symbol (z.B. "2 Autos", "Garage")
- Heating - Feuer-Symbol (z.B. "Zentralheizung", "Gas")
- Outdoor - Baum-Symbol (z.B. "Garten", "Pool")
Beispielanfrage
Hier ist ein vollständiges Beispiel für die Erstellung eines vertikalen Videos mit Immobilieneigenschaften-Overlay:
{
"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"
}Antwortformat
Alle API-Endpoints geben JSON-Antworten zurück. Eine erfolgreiche Antwort hat einen Statuscode 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
Für Fragen oder Probleme bezüglich der API kontaktieren Sie bitte unser Support-Team unter felix@pedra.ai.