Schnellstart zur Imagen-API

  • Aktualisiert

Nutze unseren Schnellstart, um zu lernen, wie die Imagen-API funktioniert und deinen Workflow anzupassen.

Onboarding abschließen

Du musst dich bei Imagen anmelden, deine Umgebung einrichten, ein KI-Profil wählen und ein paar andere Schritte durchführen, bevor du diesen Schnellstart nutzen kannst. Siehe Onboarding.

Wenn du die Imagen-API mit wenig Code nutzen möchtest, hier ist das SDK in Python.

1. Liste verfügbarer KI-Profile abrufen

Rufe eine Liste der KI-Profile und ihrer Schlüssel ab. Hier ist die API-Referenzdokumentation für diesen Endpunkt.

GET /v1/profiles/ 

Antwortbeispiel

Die Antwort enthält die verfügbaren KI-Profile. Jedes KI-Profil hat einen profile_key, der es identifiziert. Du brauchst diesen profile_key, um die Fotos in deinem Projekt zu bearbeiten.

{

"data": {

"profiles": [

{

"profile_key": <profile key des persönlichen KI-Profils>,

"profile_name": "Hochzeit",

"profile_type": "Persönlich",

"image_type": "RAW"

},

{

"profile_key": 14715,

"profile_name": "LOVE & LIGHT",

"profile_type": "Talent",

"image_type": "RAW"

},

{

"profile_key": 163322,

"profile_name": "ELEGANT HOME",

"profile_type": "Talent",

"image_type": "RAW"

}

]

}

}

2. Wähle deine Fotos ohne die API aus

Wähle deine Fotos aus, bevor du sie zur Bearbeitung hochlädst. Die Bildauswahl ist nicht Teil der Imagen-API.
 

3. Erstelle ein Projekt und erhalte eine Projekt-ID

Wir empfehlen, für jedes Shooting ein Projekt zu erstellen. Ein Projekt organisiert deine Fotos mit dem KI-Profil, das du für die Bearbeitung dieser Fotos gewählt hast. Hier ist die API-Dokumentation für diesen Endpunkt.

POST /v1/projects/

Antwortbeispiel

Die Antwort ist die project_uuid, mit der du dieses Projekt identifizierst. Verwende diese project_uuid, bis du deine Fotos als JPEG exportierst.

{

"data": {

"project_uuid": "<project_uuid>"

}

}
 

4. Temporäre Upload-Links erstellen, um Fotos hochzuladen

Du brauchst einen temporären Link, um jedes Foto hochzuladen. Füge in der Anfrage im Parameter files_list die Dateinamen der hochzuladenden Fotos ein. Verwende das Format list. Hier ist die API-Dokumentation für diesen Endpunkt.

POST /v1/projects/<PROJECT_UUID>/get_temporary_upload_links

Anfragebeispiel

curl --location 'https://api.dev.imagen-ai.com/v1/projects/<project_uuid>/get_temporary_upload_links' \

--header 'x-api-key: <api_key>' \

--header 'Content-Type: application/json' \

--data '{

    “files_list”: [

        {“file_name”: “922A4846.CR2”},

        {“file_name”: “922A4832.CR2”},

        {“file_name”: “922A4818.CR2”},

        {“file_name”: “922A4809.CR2”}

    ]

}'

 

Antwortbeispiel

Die Antwort enthält für jedes Foto einen temporären Link zum Imagen S3-Bucket auf AWS. Dieser Link ist die AWS Presigned URL.

{

"data": {

"files_list": [

{

"file_name": "922A4846.raw",

"upload_link": "<presigned URL for 922A4846.raw>"

},

{

"file_name": "922A4832.raw",

"upload_link": "<presigned URL for 922A4832.raw>"

},

{

"file_name": "922A4818.raw",

"upload_link": "<presigned URL for 922A4818.raw>"

},

{

"file_name": "922A4809.raw",

"upload_link": "<presigned URL for 922A4809.raw>"

}

]

}

}

 

5. Lade jedes Foto über den temporären Upload-Link hoch

Lade Fotos mit einer PUT-Anfrage in den S3-Bucket von Imagen auf AWS hoch. Nutze die temporären Upload-Links aus der Antwort des vorherigen Schritts.

Testen in Postman

  • Deaktiviere Content-Type in den Kopfzeilen.
  • Sende kein Content-Type in den Query-Parametern.

Anforderungen an die Kopfzeile einer Anfrage im Code

Füge Content-Type zur Kopfzeile hinzu mit einem leeren String ("") als Wert.
 

6. Bearbeite die Fotos in deinem Projekt

Bevor du deine Fotos zur Bearbeitung sendest, brauchst du:

  • Den Wert deiner project_uuid
  • Den Wert deiner profile_key. Siehe die Antwort von 1. Liste der verfügbaren KI-Profile abrufen für deinen profile_key.
  • KI-Tools. Siehe Imagen KI-Tools, um die richtigen Tools für dein Projekt zu wählen.
  • (Optional) Callback-URL. Siehe [Callback-URL hinzufügen, um Statusmeldungen zu erhalten]

Hier ist die API-Referenzdokumentation für diesen Endpunkt.

POST /v1/projects/{project_uuid}/edit

Anfrage-Beispiel

{

  "profile_key": <profile key>,

  "hdr_merge": true,

  "photography_type": "REAL_ESTATE",

  "callback_url": "string",

  "perspective_correction": true,

"sky_replacement": true,

"sky_replacement_template_id": “2”

}

Antwortbeispiel

Die Antwort ist eine Nachricht, dass das Projekt erfolgreich bearbeitet wurde. Bei einem Fehler schreib unserem Customer-Success-Team.

{“project_uuid”: “<die Projekt-UUID>”, “status”: “Failed/Completed/Pending”, “action”: “edit/export”“}

 

Callback-URL hinzufügen, um Statusnachrichten zu erhalten

Die callback_url ist ein POST-Endpunkt, über den Imagen dir Statusnachrichten senden kann. Dieser Parameter ist optional. Wenn du ihn verwendest, musst du den Bearbeitungsstatus nicht prüfen. Dieser Endpunkt muss für Imagen zugänglich sein.

Mögliche Status in der Anfrage:

Antwortbeispiel

{“project_uuid”: “<die Projekt-UUID>”, “status”: “Failed/Completed”, “action”: “edit/export”“}

 

7. Bearbeitungsstatus prüfen

Falls du keine Callback-URL zu deiner Bearbeitungsanfrage hinzugefügt hast, hole dir den aktuellen Status des Bearbeitungsprozesses. Rufe diesen Endpunkt mit Long Polling weiter auf, bis der Status Completed ist.

Hier sind die API-Referenzdokumente für diesen Endpunkt.

GET /v1/projects/<PROJECT_UUID>/edit/status

Das sind die Status in der Antwort:

8. Temporäre Download-Links abrufen, um bearbeitete Fotos oder XMPs herunterzuladen

Nachdem du den Status Abgeschlossen erhalten hast, rufe die temporären Download-Links ab, um die bearbeiteten Fotos herunterzuladen.

Hier findest du die API-Referenzdokumentation für diesen Endpunkt.

GET /v1/projects/<PROJECT_UUID>/edit/get_temporary_download_links 

Antwortbeispiel

Die Antwort enthält einen temporären Link für jedes Foto zum S3-Bucket von Imagen auf AWS. Dieser Link ist die AWS Presigned URL.

{

"data": {

"files_list": [

{

"file_name": "922A4846.DNG",

"download_link": "<presigned URL for 922A4846.DNG>"

},

{

"file_name": "922A4832.DNG",

"download_link": "<presigned URL for 922A4832.DNG>"

},

{

"file_name": "922A4818.DNG",

"download_link": "<presigned URL for 922A4818.DNG>"

},

{

"file_name": "922A4809.DNG",

"download_link": "<presigned URL for 922A4809.DNG>"

}

]

}

}

 

9. Bearbeitete Fotos lokal herunterladen

Wenn Imagen die bearbeiteten Dateien zurückgibt, haben sie folgende Formate:

Dateiformat vor der Bearbeitung Dateiformat nach der Bearbeitung
RAW

XMP

Hinweis: Bei der Bearbeitung von Fotos mit HDR-Zusammenführung ist das zurückgegebene Format immer DNG, auch wenn das Dateiformat vor der Bearbeitung RAW war.
RAW + DNG DNG mit eingebettetem XMP
DNG DNG mit eingebettetem XMP
JPEG JPEG mit eingebettetem XMP


Lade die Fotos aus Imagens S3-Bucket auf AWS mit den temporären Download-Links aus der Antwort im vorherigen Schritt herunter. Nutze eine beliebige Methode. Beispielcode in Python findest du in api_client.py im Imagen-API-Projekt auf Github.

Überprüfe die Bearbeitungen in Adobe-Software. Wenn du die Fotos mit dem Standard-Fotobetrachter auf deinem Computer öffnest, siehst du die Bearbeitungen nicht. Hilfe findest du hier:

10. Optional: Finale JPEGs für die Auslieferung exportieren

Die Imagen-API exportiert alle Fotos in einem Projekt ins JPEG-Format. Dieser Schritt ist optional. Manche Fotografen nehmen Feinanpassungen vor und exportieren sie mit ihrer Bearbeitungssoftware. Nach dem Export der finalen JPEGs lieferst du sie aus oder lädst sie in eine Galerie hoch.

1. Exportiere die Fotos im Projekt

POST /v1/projects/<PROJECT_UUID>/export 

Hier sind die API-Dokumentation für diesen Endpunkt.

Die Antwort enthält die project_uuid und eine Nachricht, dass der Export erfolgreich war. Bei einem Fehler schreib unserem Customer Success Team.

 

2. Exportstatus prüfen

Wenn du keine Callback-URL in deiner Bearbeitungsanfrage hinzugefügt hast, frag den Exportstatus ab.

GET /v1/projects/<PROJECT_UUID>/export/status.

Hier sind die API-Dokumentation für diesen Endpunkt.

Die Antwort enthält den Status des Exports. Mögliche Status sind:

  • In Bearbeitung: Die Imagen-API bearbeitet gerade die Fotos.
  • Fehlgeschlagen: Schreib dem Customer Success Team.
  • Abgeschlossen: Die Imagen-API hat den Export der Fotos nach JPEG abgeschlossen.

3. Temporäre Download-Links für finale JPEG-Fotos abrufen

Rufe die temporären Download-Links ab, sobald der Export-Status als COMPLETED zurückgegeben wird.

GET /v1/projects/<PROJECT_UUID>/export/get_temporary_download_links 

Füge in der Anfrage die zu downloadenden exportierten Fotos im Parameter files_list hinzu. Verwende das Format list.

Hier findest du die API-Referenzdokumentation für diesen Endpunkt.

Antwortbeispiel

Die Antwort enthält für jedes Foto einen temporären Link zum S3-Bucket von Imagen auf AWS. Dieser Link ist die AWS Presigned URL.

{

"data": {

"files_list": [

{

"file_name": "922A4846.JPG",

"download_link": "<presigned URL for 922A4846.JPG>"

},

{

"file_name": "922A4832.JPG",

"download_link": "<presigned URL for 922A4832.JPG>"

},

{

"file_name": "922A4818.JPG",

"download_link": "<presigned URL for 922A4818.JPG>"

},

{

"file_name": "922A4809.JPG",

"download_link": "<presigned URL for 922A4809.JPG>"

}

]

}

}

 

4. Finale JPEG-Fotos lokal herunterladen

Lade die Fotos aus Imagens S3-Bucket auf AWS mit den temporären Download-Links aus der Antwort im vorherigen Schritt herunter. Nutze dafür eine beliebige Methode. Beispielcode in Python findest du in api_client.py im Imagen-API-Projekt auf Github.

War dieser Beitrag hilfreich?

Haben Sie Fragen? Anfrage einreichen