Passer au contenu
Français
Obtenir une clé API
Guide de l’API

Paramètres

Afficher en Markdown Mis à jour

Chaque modèle conserve ses noms de paramètres natifs, et chaque page de modèle les répertorie. De plus, l'API accepte les noms canoniques pour les paramètres qui ont la même signification sur tous les modèles, afin que le code écrit pour un modèle fonctionne avec le suivant avec moins de modifications.

Noms canoniques

Nom canonique Signification Noms natifs courants
image L'image d'entrée ou la première image image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image La dernière image end_image_url, last_frame_url, tail_image_url
images Une liste d'images de référence image_urls, reference_image_urls
video La vidéo d'entrée video_url
videos Une liste de vidéos de référence video_urls
audio L'audio d'entrée audio_url
audios Une liste de clips audio de référence audio_urls
mask Une image de masque mask_url
num_outputs Le nombre de résultats à générer num_images
generate_audio Générer du son avec la vidéo generate_audio_switch, enable_audio

Voici le champ natif auquel un nom canonique correspond pour chaque modèle actuel :

Nom canonique Champ natif (modèles qui l’utilisent)
audio audio_url (modèles : 126)
audios audio_urls (modèles : 7), reference_audio_urls (modèles : 1)
end_image end_image_url (modèles : 76), last_frame_url (modèles : 12), tail_image_url (modèles : 1)
generate_audio generate_audio_switch (modèles : 16), audio (modèles : 3)
image image_url (modèles : 529), start_image_url (modèles : 20), first_frame_url (modèles : 12), first_image_url (modèles : 7), source_image_url (modèles : 2)
images image_urls (modèles : 148), reference_image_urls (modèles : 31)
mask mask_url (modèles : 46)
num_outputs num_images (modèles : 337)
video video_url (modèles : 197)
videos video_urls (modèles : 13), reference_video_urls (modèles : 1)

Règles :

  • Envoyez soit le nom canonique, soit le nom natif. Si vous envoyez les deux avec des valeurs différentes, l'appel échoue avec 422 invalid_input sur le nom canonique.
  • Un paramètre qui n'est ni un nom natif ni un nom canonique du modèle est rejeté avec 422 invalid_input ("Unknown parameter"), avec le nom valide le plus proche comme suggestion. Les fautes de frappe ne sont jamais acceptées silencieusement.
  • Chaque page de modèle affiche les deux noms côte à côte.

Conversion de types

Les valeurs sont converties vers le type attendu par le modèle, donc tous ces formats fonctionnent :

Vous envoyez Le modèle attend Devient
5, "5", "5s" duration sous forme de chaîne telle que "5" "5"
"8" un entier 8
"1080P", "4K" resolution telle que "1080p", "4k" l'orthographe exacte autorisée
"true", "false", 1, 0 une valeur booléenne true, false
"https://…/a.jpg" une liste d'URL ["https://…/a.jpg"]
42 une chaîne "42"

Les valeurs autorisées sont d'abord comparées exactement, puis sans tenir compte de la casse, puis comme des nombres (5 correspond à "5", "5s" et aux valeurs au format "5 s").

Valeurs par défaut

Les paramètres que vous omettez utilisent la valeur par défaut du modèle, indiquée dans le tableau des paramètres du modèle. Le prix est calculé avec ces mêmes valeurs par défaut (par exemple, un modèle vidéo dont generate_audio vaut true par défaut est facturé avec le son, sauf si vous envoyez "generate_audio": false).

Paramètres de fichier

Les paramètres d'image, de vidéo et d'audio acceptent une URL publique, un URI data: de 10 Mo maximum ou le file_url d'un fichier importé. Consultez Fichiers.