Synupv1
Schlüssel erstellen
v1Ressourcen/Media

Media

Die Medienbibliothek eines Standorts lesen und hochladen.

Liefert Logo, Fotos und Videos, die für einen Standort hinterlegt sind, gruppiert nach Kategorie.

Standort-Medien abrufen

get/api/v1/media
media:read
Query-Parameter
locationIdstringerforderlich
Der abzurufende Standort. Erforderlich.
Antwort
dataobjectoptional
locationIdstringoptional
Der Standort, zu dem diese Medien gehören.
logoUrlstringoptional
URL des Logos des Standorts, oder null.
mediaByCategoryobjectoptional
Medienelemente gruppiert nach Kategorie (z. B. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Jedes Element hat eine url und optional ein label, ein kind (PHOTO oder VIDEO), eine source, ein starred-Flag und einen assetKey.
photosSummaryobjectoptional
Zusammengefasste Fotoanzahlen.
totalnumberoptional
Gesamtzahl der Fotos, oder null.
byCategoryarray of objectoptional
Fotoanzahl je Kategorie.
categorystringoptional
countnumberoptional
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/media
Ihr API-Schlüssel
locationId *
{
  "data": {
    "locationId": "loc_456",
    "logoUrl": "https://cdn.synup.com/logos/loc_456.png",
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg",
          "kind": "PHOTO",
          "source": "user_upload",
          "starred": true
        }
      ]
    },
    "photosSummary": {
      "total": 12,
      "byCategory": [
        {
          "category": "EXTERIOR",
          "count": 4
        }
      ]
    }
  }
}
v1Ressourcen/Media/getMedienkategorien auflisten

Die feste Menge an Kategoriewerten, die von POST/DELETE /api/v1/locations/{id}/media akzeptiert werden (COVER, LOGO, INTERIOR, ...).

Medienkategorien auflisten

get/api/v1/media/categories
media:read
Antwort
dataobjectoptional
categoriesarray of stringoptional
Die Kategoriewerte, in der Reihenfolge ihrer Durchsetzung.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/media/categories
Ihr API-Schlüssel
{
  "data": {
    "categories": [
      "COVER",
      "PROFILE",
      "LOGO",
      "EXTERIOR",
      "INTERIOR",
      "PRODUCT",
      "FOOD_AND_DRINK",
      "MENU",
      "AT_WORK",
      "TEAMS",
      "ROOMS",
      "COMMON_AREA",
      "ADDITIONAL"
    ]
  }
}
v1Ressourcen/Media/patchAsset aktualisieren

Aktualisiert die Overlay-Metadaten eines Assets — Tags, Ordnerzugehörigkeit, zugewiesene Standorte — und, nur bei Uploads, seinen Titel. Synchronisierte/generierte Quellen ignorieren den Titel; dort ist er schreibgeschützt.

Asset aktualisieren

patch/api/v1/media/{id}
media:write
Query-Parameter
idstringerforderlich
Das zu aktualisierende Asset.
Anfragetext
titlestringoptional
Neuer Titel. Nur bei Uploads; wird bei anderen Quellen ignoriert.
tagsarray of stringoptional
Ersetzt die vollständige Tag-Liste des Assets, nach Name.
folderIdsarray of stringoptional
Ersetzt die Ordnerzugehörigkeit des Assets.
locationIdsarray of stringoptional
Ersetzt die zugewiesenen Standorte des Assets.
statusstring (ok | needs_review | spam)optional
Setzt das Moderationsurteil manuell. Nur bei synchronisierten Medien.
statusReasonstringoptional
Optionale Notiz zur Begründung des Status, die daneben angezeigt wird.
Antwort
dataobjectoptional
assetobjectoptional
keystringoptional
Zusammengesetzte Kennung für das Asset, im Format „<source>:<id>“.
sourcestringoptional
Herkunft dieses Assets (z. B. ein OS-Upload gegenüber einer importierten Quelle).
idstringoptional
Die ID des Assets innerhalb seiner Quelle.
titlestringoptional
Der Titel des Assets.
filenamestringoptional
Der ursprüngliche Dateiname des Assets.
mimestringoptional
Der MIME-Typ des Assets.
kindstringoptional
Die Art des Assets (Foto oder Video).
sizeBytesnumberoptional
Dateigröße in Bytes, oder null, wenn unbekannt.
urlstringoptional
Sofort nutzbare URL für die Bytes des Assets.
thumbnailUrlstringoptional
URL einer Vorschau-Miniaturansicht, oder null.
tagsarray of stringoptional
Dem Asset zugeordnete Tags.
folderIdsarray of stringoptional
Asset-Ordner, zu denen dieses Asset gehört.
locationIdsarray of stringoptional
Jeder Standort, dem dieses Asset zugeordnet ist.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
patch/api/v1/media/{id}
Ihr API-Schlüssel
id *
Anfragetext
{
  "data": {
    "asset": {
      "key": "upload:abc123",
      "source": "upload",
      "id": "abc123",
      "title": "Storefront photo",
      "filename": "storefront.jpg",
      "mime": "image/jpeg",
      "kind": "image",
      "sizeBytes": 482913,
      "url": "https://cdn.synup.com/media/abc123.jpg",
      "thumbnailUrl": "https://cdn.synup.com/media/abc123-thumb.jpg",
      "tags": [
        "VIP"
      ],
      "folderIds": [
        "folder_1"
      ],
      "locationIds": [
        "loc_456"
      ]
    }
  }
}
v1Ressourcen/Media/deleteEin Medien-Asset archivieren

Archiviert ein hochgeladenes Foto/eine Datei aus der Asset-Bibliothek — diese API löscht niemals dauerhaft. Die Bytes, der Datensatz, die Tag-/Ordner-Zugehörigkeiten und die Freigabelinks bleiben alle erhalten; es erscheint nur nirgends mehr in der Bibliothek. Nur Uploads können so archiviert werden.

Ein Medien-Asset archivieren

delete/api/v1/media/{id}
media:write
Query-Parameter
idstringerforderlich
Der Asset-Schlüssel, URL-kodiert (z. B. upload%3Aabc123).
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Die Quelle dieses Assets ist schreibgeschützt (von Sydekick generiert oder synchronisierte Medien) und kann hier nicht archiviert werden.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/media/{id}
Ihr API-Schlüssel
id *
{}
v1Ressourcen/Media/postEin Asset per KI bearbeiten

Erzeugt das Bild (oder den Text) eines Sydekick-generierten Assets anhand eines Text-Prompts direkt vor Ort neu — dieselbe Aktion "Mit KI bearbeiten" im Tab Daten. Nur Sydekick-generierte Assets; Uploads und synchronisierte Medien liefern einen 409. Läuft als Hintergrundjob, der bei einem kalten Start eine Minute oder länger dauern kann.

Ein Asset per KI bearbeiten

post/api/v1/media/{id}/edit
media:write
Query-Parameter
idstringerforderlich
Das zu bearbeitende generierte Asset, prozentcodiert (z. B. generated%3Aabc123).
Anfragetext
promptstringerforderlich
Was geändert werden soll, in einfacher Sprache.
Antwort
dataobjectoptional
assetobjectoptional
keystringoptional
Zusammengesetzte Kennung für das Asset, im Format „<source>:<id>“.
sourcestringoptional
Herkunft dieses Assets (z. B. ein OS-Upload gegenüber einer importierten Quelle).
idstringoptional
Die ID des Assets innerhalb seiner Quelle.
titlestringoptional
Der Titel des Assets.
filenamestringoptional
Der ursprüngliche Dateiname des Assets.
mimestringoptional
Der MIME-Typ des Assets.
kindstringoptional
Die Art des Assets (Foto oder Video).
sizeBytesnumberoptional
Dateigröße in Bytes, oder null, wenn unbekannt.
urlstringoptional
Sofort nutzbare URL für die Bytes des Assets.
thumbnailUrlstringoptional
URL einer Vorschau-Miniaturansicht, oder null.
tagsarray of stringoptional
Dem Asset zugeordnete Tags.
folderIdsarray of stringoptional
Asset-Ordner, zu denen dieses Asset gehört.
locationIdsarray of stringoptional
Jeder Standort, dem dieses Asset zugeordnet ist.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
409Nur Sydekick-generierte Assets können per KI bearbeitet werden.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/media/{id}/edit
Ihr API-Schlüssel
id *
Anfragetext*
{
  "data": {
    "asset": {
      "key": "upload:def456",
      "source": "upload",
      "id": "def456",
      "title": "Storefront photo (edited)",
      "filename": "storefront-edited.jpg",
      "mime": "image/jpeg",
      "kind": "image",
      "sizeBytes": 511204,
      "url": "https://cdn.synup.com/media/def456.jpg",
      "thumbnailUrl": "https://cdn.synup.com/media/def456-thumb.jpg",
      "tags": [
        "VIP"
      ],
      "folderIds": [
        "folder_1"
      ],
      "locationIds": [
        "loc_456"
      ]
    }
  }
}
v1Ressourcen/Media/postEin Medien-Asset hochladen

Fügt der Medienbibliothek der Agentur ein neues Foto oder Video aus einer URL oder einem base64-kodierten Payload hinzu, optional beschränkt auf ein Konto, einen Kunden, einen Standort oder eine Marke.

Ein Medien-Asset hochladen

post/api/v1/media/upload
media:write
Anfragetext
urlstringoptional
Eine öffentlich erreichbare URL, von der das Asset abgerufen wird. Entweder dies oder base64 angeben, nicht beides.
base64stringoptional
Der rohe Dateiinhalt, base64-kodiert. Entweder dies oder url angeben, nicht beides.
mimestringoptional
MIME-Typ der Datei, z. B. image/jpeg. Wird abgeleitet, wenn nicht angegeben.
filenamestringoptional
Ursprünglicher Dateiname, zur Anzeige verwendet.
titlestringoptional
Ein für Menschen lesbarer Titel für das Asset.
scopeTypestring (account | client | location | brand)optional
Wozu dieses Asset gehört: account (agenturweit), client, location oder brand.
scopeIdstringoptional
Die Kunden- oder Standort-ID, auf die das Asset beschränkt ist, wenn scopeType client oder location ist.
folderIdstringoptional
Ein vorhandener Asset-Ordner, in den dieser Upload eingeordnet werden soll.
tagsarray of stringoptional
Freie Tags, die dem Asset zugeordnet werden.
locationIdsarray of stringoptional
Weitere Standorte, die diesem Asset zugeordnet werden sollen, zusätzlich zu scopeId.
Antwort
dataobjectoptional
assetobjectoptional
keystringoptional
Zusammengesetzte Kennung für das Asset, im Format „<source>:<id>“.
sourcestringoptional
Herkunft dieses Assets (z. B. ein OS-Upload gegenüber einer importierten Quelle).
idstringoptional
Die ID des Assets innerhalb seiner Quelle.
titlestringoptional
Der Titel des Assets.
filenamestringoptional
Der ursprüngliche Dateiname des Assets.
mimestringoptional
Der MIME-Typ des Assets.
kindstringoptional
Die Art des Assets (Foto oder Video).
sizeBytesnumberoptional
Dateigröße in Bytes, oder null, wenn unbekannt.
urlstringoptional
Sofort nutzbare URL für die Bytes des Assets.
thumbnailUrlstringoptional
URL einer Vorschau-Miniaturansicht, oder null.
tagsarray of stringoptional
Dem Asset zugeordnete Tags.
folderIdsarray of stringoptional
Asset-Ordner, zu denen dieses Asset gehört.
locationIdsarray of stringoptional
Jeder Standort, dem dieses Asset zugeordnet ist.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
422Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/media/upload
Ihr API-Schlüssel
Anfragetext
{
  "data": {
    "asset": {
      "key": "upload:ghi789",
      "source": "upload",
      "id": "ghi789",
      "title": "New storefront photo",
      "filename": "new-storefront.jpg",
      "mime": "image/jpeg",
      "kind": "image",
      "sizeBytes": 398211,
      "url": "https://cdn.synup.com/media/ghi789.jpg",
      "thumbnailUrl": "https://cdn.synup.com/media/ghi789-thumb.jpg",
      "tags": [],
      "folderIds": [],
      "locationIds": []
    }
  }
}
v1Ressourcen/Media/postAsset freigeben

Erstellt (oder erneuert) einen öffentlichen Link für das Asset. Beim Erneuern wird jeder zuvor ausgestellte Link widerrufen.

Asset freigeben

post/api/v1/media/{id}/share
media:write
Query-Parameter
idstringerforderlich
Das freizugebende Asset.
Antwort
dataobjectoptional
urlstringoptional
Die öffentliche Freigabe-URL.
accessstring (link)optional
Bei Erfolg immer „link“.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
post/api/v1/media/{id}/share
Ihr API-Schlüssel
id *
{
  "data": {
    "url": "https://synup.com/s/kL9mN2pQr",
    "access": "link"
  }
}
v1Ressourcen/Media/deleteAsset-Freigabe aufheben

Widerruft den öffentlichen Link des Assets.

Asset-Freigabe aufheben

delete/api/v1/media/{id}/share
media:write
Query-Parameter
idstringerforderlich
Das Asset, dessen Freigabe aufgehoben wird.
Antwort
dataobjectoptional
accessstring (restricted)optional
Bei Erfolg immer „restricted“.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
delete/api/v1/media/{id}/share
Ihr API-Schlüssel
id *
{
  "data": {
    "access": "restricted"
  }
}