Documentazione

Riferimento API

Carica immagine di riferimento

POST/v1/image-assets

La prima e unica parte multipart è file, con nome file; JPEG/PNG/WebP non animato, massimo 10 MiB sia al caricamento sia dopo la ricodifica.

Autenticazione e autorizzazioni

Usa la chiave GloopAPI corrente. Modelli, funzionalità e autorizzazioni disponibili dipendono dal relativo catalogo e dalla documentazione dell'endpoint.

Authorization: Bearer $GLOOP_API_KEY

Schemi di autenticazione: BearerAuth

Richiesta

Header della richiesta

  • Idempotency-KeystringObbligatorio

    Conserva l'intento originale con la stessa Key. Dopo un'interruzione di rete, consulta prima il recupero; niente reinvii alla cieca per stati sconosciuti.

    Lunghezza minima
    1
    Lunghezza massima
    191

Corpo della richiesta · multipart/form-data

Tipo
object
Campi obbligatori
file
Proprietà aggiuntive
false

Corpo della richiesta obbligatorio

  • filestringObbligatorio

    Unica parte immagine con filename; JPEG/PNG/WebP <=10MiB, non animata.

    Formato
    "binary"

Risposte ed errori

HTTP 200

Immagine di riferimento caricata

application/json

Tipo
object
Campi obbligatori
idmime_typesize_byteswidthheightexpires_at
  • file_idstringFacoltativo

    ID pubblico del file ospitato dello stesso account e della stessa Key.

  • idstringObbligatorio

    Identificatore pubblico dell'oggetto, usato nel relativo percorso dei dettagli.

  • mime_typestringObbligatorio

    Tipo MIME del file verificato.

  • size_bytesintegerObbligatorio

    Dimensione del file in byte.

  • widthintegerObbligatorio

    Larghezza dell'immagine in pixel.

  • heightintegerObbligatorio

    Altezza dell'immagine in pixel.

  • expires_atintegerObbligatorio

    Secondi Unix; 0 indica nessuna scadenza fissa. Il caricamento è collegato a un file ospitato; lettura con stesso account e Key.

HTTP 400

Campi o parametri della richiesta non validi.

application/json

Tipo
object
Campi obbligatori
error

HTTP 401

Key assente, non valida, scaduta o revocata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 403

Autorizzazioni IP, account, modello o strumento insufficienti.

application/json

Tipo
object
Campi obbligatori
error

HTTP 404

Oggetto/funzionalità non disponibile o disabilitata.

application/json

Tipo
object
Campi obbligatori
error

HTTP 409

Conflitto di idempotenza/preventivo, oggetto non pronto o ancora referenziato.

application/json

Tipo
object
Campi obbligatori
error

HTTP 429

Limite di frequenza delle richieste/della coda.

application/json

Tipo
object
Campi obbligatori
error

HTTP 500

Errore interno di autenticazione o storage dei dati.

application/json

Tipo
object
Campi obbligatori
error

HTTP 503

Servizio, prezzi o storage non disponibile.

application/json

Tipo
object
Campi obbligatori
error