Vai al contenuto
Guida all'API

Parametri

Visualizza come Markdown Aggiornato

Ogni modello mantiene i propri nomi nativi dei parametri, elencati nella pagina del modello. Inoltre, l'API accetta nomi canonici per i parametri che hanno lo stesso significato in tutti i modelli, così il codice scritto per un modello funziona con quello successivo con meno modifiche.

Nomi canonici

Nome canonico Significato Nomi nativi tipici
image L'immagine di input o del primo fotogramma image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image L'immagine dell'ultimo fotogramma end_image_url, last_frame_url, tail_image_url
images Un elenco di immagini di riferimento image_urls, reference_image_urls
video Il video di input video_url
videos Un elenco di video di riferimento video_urls
audio L'audio di input audio_url
audios Un elenco di clip audio di riferimento audio_urls
mask Un'immagine maschera mask_url
num_outputs Quanti risultati generare num_images
generate_audio Generare l'audio insieme al video generate_audio_switch, enable_audio

A quale campo nativo corrisponde un nome canonico in ciascun modello attuale:

Nome canonico Campo nativo (modelli che lo usano)
audio audio_url (modelli: 126)
audios audio_urls (modelli: 7), reference_audio_urls (modelli: 1)
end_image end_image_url (modelli: 76), last_frame_url (modelli: 12), tail_image_url (modelli: 1)
generate_audio generate_audio_switch (modelli: 16), audio (modelli: 3)
image image_url (modelli: 529), start_image_url (modelli: 20), first_frame_url (modelli: 12), first_image_url (modelli: 7), source_image_url (modelli: 2)
images image_urls (modelli: 148), reference_image_urls (modelli: 31)
mask mask_url (modelli: 46)
num_outputs num_images (modelli: 337)
video video_url (modelli: 197)
videos video_urls (modelli: 13), reference_video_urls (modelli: 1)

Regole:

  • Invia il nome canonico oppure quello nativo. Se li invii entrambi con valori diversi, la chiamata non va a buon fine con 422 invalid_input sul nome canonico.
  • Un parametro che non è né un nome nativo né un nome canonico del modello viene rifiutato con 422 invalid_input ("Unknown parameter"), insieme al nome valido più simile come suggerimento. Gli errori di battitura non vengono mai accettati silenziosamente.
  • La pagina di ogni modello mostra entrambi i nomi affiancati.

Conversione dei tipi

I valori vengono convertiti nel tipo previsto dal modello, quindi tutti questi esempi funzionano:

Invii Il modello prevede Diventa
5, "5", "5s" duration come stringa, ad esempio "5" "5"
"8" un intero 8
"1080P", "4K" resolution come "1080p", "4k" la grafia esatta consentita
"true", "false", 1, 0 un booleano true, false
"https://…/a.jpg" un elenco di URL ["https://…/a.jpg"]
42 una stringa "42"

I valori consentiti vengono confrontati prima esattamente, poi senza distinguere tra maiuscole e minuscole, quindi come numeri (5 corrisponde a valori come "5", "5s" e "5 s").

Valori predefiniti

I parametri omessi usano il valore predefinito del modello, indicato nella tabella dei parametri del modello. Il prezzo viene calcolato usando gli stessi valori predefiniti (ad esempio, un modello video il cui valore predefinito per generate_audio è true viene addebitato con audio incluso, a meno che tu non invii "generate_audio": false).

Parametri di file

I parametri immagine, video e audio accettano un URL pubblico, un URI data: fino a 10 MB oppure il file_url di un caricamento. Vedi Files.