Documentazione

Riferimento API

Consulta un'attività immagine

GET/v1/image-tasks/{task_id}

Consultazione secondo la stessa Key e le autorizzazioni attuali del modello.

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

Parametri del percorso

  • task_idstringObbligatorio

    ID pubblico di un'attività creata con la stessa Key.

Risposte ed errori

HTTP 200

Attività immagine consultata

application/json

Tipo
object
Campi obbligatori
modelpromptsizenreferencesidstatuscreated_atupdated_atreserved_quotafinal_quotabilling_statusresults
  • modelstringObbligatorio

    ID pubblico del modello nel catalogo della Key corrente.

  • promptstringObbligatorio

    Prompt di generazione.

  • sizestringObbligatorio

    Dimensione restituita da image-models per il modello scelto; capacità e dimensioni validate separatamente per modello.

  • nintegerObbligatorio

    Numero di immagini richiesto, sempre soggetto al massimo del modello.

  • referencesarrayObbligatorio

    Elenco delle immagini di riferimento per la generazione.

    Campi figli di references (1)
    • []objectFacoltativo
      Campi figli di [] (3)
      • file_idstringFacoltativo

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

      • asset_idstringFacoltativo

        ID risorsa caricata dello stesso account e della stessa Key.

      • urlstringFacoltativo

        URL HTTPS pubblico, senza userinfo o fragment; soggetto a verifica SSRF.

        Formato
        "uri"
      Ramo oneOf 1

      Obbligatorio in questo ramo: file_id

      Ramo oneOf 2

      Obbligatorio in questo ramo: asset_id

      Ramo oneOf 3

      Obbligatorio in questo ramo: url

  • source_task_idstringFacoltativo

    ID pubblico dell'attività sorgente, solo per tracciabilità.

  • quote_idstringFacoltativo

    ID pubblico del preventivo; alla creazione deve rispettare i vincoli di prezzo/richiesta.

  • idstringObbligatorio

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

  • statusstringObbligatorio

    unknown non viene reinviato automaticamente; la prenotazione contabile può restare pending.

    Enumerazione
    ["queued","dispatching","running","succeeded","partial_succeeded","failed","unknown","deleted"]
  • created_atintegerObbligatorio

    Ora di creazione in secondi Unix.

  • updated_atintegerObbligatorio

    Ultimo aggiornamento in secondi Unix.

  • reserved_quotaintegerObbligatorio

    Prenotazione in unità quota della piattaforma, non in dollari.

  • final_quotaintegerObbligatorio

    Costo finale in unità quota della piattaforma; null indica non determinato.

  • billing_statusstringObbligatorio

    Stato di prenotazione/addebito/rimborso, da verificare separatamente dall'attività e dall'archiviazione.

  • error_codestringFacoltativo

    Codice errore pubblico utilizzabile per scegliere il ramo di gestione.

  • error_messagestringFacoltativo

    Spiegazione per l'utente secondo la classificazione pubblica degli errori.

  • resultsarrayObbligatorio

    Elementi generati in uscita; archiviazione indipendente per ciascuno.

    Campi figli di results (1)
    • []objectFacoltativo
      Campi figli di [] (7)
      • file_idstringFacoltativo

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

      • storage_statusstringFacoltativo

        Stato di archiviazione del file; il download ospitato è garantito solo dopo ready.

      • storage_errorstringFacoltativo

        Categoria pubblica dell'errore di archiviazione del file.

      • expires_atintegerFacoltativo

        Scadenza in secondi Unix; 0 indica nessuna scadenza fissa.

      • urlstringFacoltativo

        URL di accesso al risultato o riferimento; gli URL firmati sono temporanei.

      • b64_jsonstringFacoltativo

        Stringa Base64 dell'immagine; non richiederla come URL.

      • revised_promptstringFacoltativo

        Prompt rivisto restituito dal servizio, se presente.

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