Loading...
Mit der Profile Bakery API kannst du den KI-Headshot-Workflow deiner Organisation programmatisch steuern.
curl -X GET "https://app.profilebakery.com/api/v2/organization" \ -H "Authorization: Bearer YOUR_API_KEY"
curl -X POST "https://app.profilebakery.com/api/v2/organization/invites" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com"}'Alle API-Requests gehen an:
https://app.profilebakery.com/api/v2
| Version | Status | Base URL |
|---|---|---|
| V2 | Aktuell | /api/v2/organization/... |
| V1 | Legacy | /api/v1/organization/... |
Erfolg
{
"success": true,
"data": { ... }
}Fehler
{
"success": false,
"error": "Error message",
"code": "ERROR_CODE"
}Hilfe Fehlercodes prüfen, Rate Limits, support@profilebakery.com
Die API nutzt Bearer-Token-Authentifizierung. Jeder Request muss den API-Schlüssel im Authorization-Header enthalten.
API-Schlüssel werden nur einmal angezeigt. Sicher aufbewahren und nicht in Quellcode committen.
curl -X GET "https://app.profilebakery.com/api/v2/organization" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
401 Fehlender oder ungültiger API-Schlüssel · 403 Schlüssel gültig, aber keine Berechtigung
Endpoints für Organisationsdetails und Kreditguthaben.
GET /organization — Organisationsdetails abrufen
GET /organization/credits — Kreditguthaben abrufen
Credits werden beim Foto-Upload und Start des KI-Trainings verbraucht. Beim Erstellen einer Einladung, Abrufen von Fotos oder Verwalten von Teams werden keine Credits verbraucht.
Team-Mitglieder einladen, damit sie ihre KI-Headshots erstellen können.
GET /organization/invites — Alle Einladungen auflisten
POST /organization/invites — Einladung erstellen
Credits werden beim Foto-Upload verbraucht, nicht beim Erstellen der Einladung. Einladungslinks verfallen nach 30 Tagen.
Teams in der Organisation anlegen und verwalten.
Team-Mitglieder auflisten und verwalten.
GET /organization/team — Alle Mitglieder auflisten (Angenommen, In Bearbeitung, Abgeschlossen)
POST /organization/teams/:teamId/members — Mitglieder zu Team hinzufügen
Modelle sind einzelne KI-Headshot-Sessions. Jedes Teammitglied hat ein zugehöriges Modell mit generierten Fotos.
Entwicklungsmodus: schneller Durchlauf, keine Credits.
Endpoints für generierte KI-Headshot-Fotos.
Profile Bakery per signierter URL in die eigene Anwendung einbinden. Nutzer brauchen keinen Profile-Bakery-Account.
Voraussetzungen: Whitelabel für die Organisation aktiviert, Webhook-URL konfiguriert, ausreichend Credits.
Integration: Modell per POST anlegen → signierte URL zurück → in iframe/redirect einbinden → Nutzer lädt Fotos hoch → Webhooks bei Statusänderung → Fotos per API abrufen.
POST https://app.profilebakery.com/api/v2/organization/models
{ "email": "user@example.com", "teamId": "optional", "isDevelopment": false }
→ modelId, status, signedUrlKonventionelle HTTP-Statuscodes und einheitliche Fehlerobjekte.
Fehlerformat: success: false, error, code
HTTP-Statuscodes: 200, 400, 401, 402, 403, 404, 429, 500
Fehlercodes (UNAUTHORIZED, FORBIDDEN, INVALID_REQUEST, NOT_FOUND, INSUFFICIENT_CREDITS, RATE_LIMIT_EXCEEDED).
Faire Nutzung und Stabilität. Limits pro Minute je nach Plan.
Header X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
Bei Überschreitung: 429 und RATE_LIMIT_EXCEEDED.
Echtzeit-HTTP-Benachrichtigungen bei Ereignissen.
Ereignisse: model.created, model.status.updated, model.photos_ready, model.favorite_selected, model.deleted.
Signatur per HMAC-SHA256 prüfen (Header X-ProfileBakery-Signature).
Schnell mit 200 antworten, Verarbeitung asynchron.