Dokumentation

API-Referenz

Referenzbild hochladen

POST/v1/image-assets

Erster und einziger multipart-Teil ist file mit Dateiname; nicht animiertes JPEG/PNG/WebP, vor und nach Neukodierung jeweils höchstens 10 MiB.

Authentifizierung und Berechtigungen

Verwenden Sie Ihren aktuellen GloopAPI-Schlüssel. Verfügbare Modelle, Funktionen und Berechtigungen hängen von seinem Katalog und der Endpunktdokumentation ab.

Authorization: Bearer $GLOOP_API_KEY

Authentifizierungsschemata: BearerAuth

Anfrage

Anfrageheader

  • Idempotency-KeystringErforderlich

    Ursprüngliche Anfrageabsicht mit demselben Schlüssel aufbewahren. Nach einer Netzwerkunterbrechung zuerst die Wiederherstellung abfragen; bei unbekanntem Status nicht blind erneut senden.

    Mindestlänge
    1
    Maximale Länge
    191

Anfragekörper · multipart/form-data

Typ
object
Pflichtfelder
file
Zusätzliche Eigenschaften
false

Anfragekörper erforderlich

  • filestringErforderlich

    Einziger Bildteil mit filename; nicht animiertes JPEG/PNG/WebP <=10MiB.

    Format
    "binary"

Antworten und Fehler

HTTP 200

Referenzbild hochgeladen

application/json

Typ
object
Pflichtfelder
idmime_typesize_byteswidthheightexpires_at
  • file_idstringOptional

    Öffentliche ID einer verwalteten Datei desselben Kontos und Schlüssels.

  • idstringErforderlich

    Öffentliche Kennung dieses Objekts für den zugehörigen Detailpfad.

  • mime_typestringErforderlich

    Geprüfter MIME-Typ der Datei.

  • size_bytesintegerErforderlich

    Dateigröße in Bytes.

  • widthintegerErforderlich

    Bildbreite in Pixeln.

  • heightintegerErforderlich

    Bildhöhe in Pixeln.

  • expires_atintegerErforderlich

    Unix-Sekunden; 0 bedeutet keinen festen Ablauf. Upload ist mit gehosteter Datei verknüpft; Lesen erfordert dasselbe Konto und dieselbe Key.

HTTP 400

Ungültige Anfragefelder oder Parameter.

application/json

Typ
object
Pflichtfelder
error

HTTP 401

Key fehlt, ist ungültig, abgelaufen oder widerrufen.

application/json

Typ
object
Pflichtfelder
error

HTTP 403

Unzureichende IP-, Konto-, Modell- oder Tool-Berechtigungen.

application/json

Typ
object
Pflichtfelder
error

HTTP 404

Objekt/Funktion nicht verfügbar oder Funktionsschalter deaktiviert.

application/json

Typ
object
Pflichtfelder
error

HTTP 409

Idempotenz-/Kostenvoranschlagskonflikt, Objekt nicht bereit oder noch referenziert.

application/json

Typ
object
Pflichtfelder
error

HTTP 429

Anfrage-/Warteschlangenlimit.

application/json

Typ
object
Pflichtfelder
error

HTTP 500

Interner Authentifizierungs- oder Datenspeicherungsfehler.

application/json

Typ
object
Pflichtfelder
error

HTTP 503

Dienst, Preisberechnung oder Speicherung nicht verfügbar.

application/json

Typ
object
Pflichtfelder
error
Bereit zum Entwickeln? Öffnen Sie Konsole um einen API-Schlüssel zu erstellen, oder durchsuchen Sie Funktionen.