Hoppa till innehåll
API-guide

Parametrar

Visa som Markdown Uppdaterad

Varje modell behåller sina ursprungliga parameternamn, och varje modellsida listar dem. Dessutom accepterar API:t kanoniska namn för parametrar som betyder samma sak i alla modeller, så kod som skrivits för en modell fungerar för nästa med färre ändringar.

Kanoniska namn

Kanoniskt namn Betydelse Vanliga ursprungliga namn
image Bilden som indata eller första bildrutan image_url, start_image_url, first_frame_url, first_image_url, source_image_url
end_image Bilden för den sista bildrutan end_image_url, last_frame_url, tail_image_url
images En lista med referensbilder image_urls, reference_image_urls
video Videon som indata video_url
videos En lista med referensvideor video_urls
audio Ljudet som indata audio_url
audios En lista med referensljudklipp audio_urls
mask En maskbild mask_url
num_outputs Hur många resultat som ska genereras num_images
generate_audio Generera ljud med videon generate_audio_switch, enable_audio

Vilket ursprungligt fält ett kanoniskt namn mappas till i varje aktuell modell:

Kanoniskt namn Inbyggt fält (modeller som använder det)
audio audio_url (modeller: 126)
audios audio_urls (modeller: 7), reference_audio_urls (modeller: 1)
end_image end_image_url (modeller: 76), last_frame_url (modeller: 12), tail_image_url (modeller: 1)
generate_audio generate_audio_switch (modeller: 16), audio (modeller: 3)
image image_url (modeller: 529), start_image_url (modeller: 20), first_frame_url (modeller: 12), first_image_url (modeller: 7), source_image_url (modeller: 2)
images image_urls (modeller: 148), reference_image_urls (modeller: 31)
mask mask_url (modeller: 46)
num_outputs num_images (modeller: 337)
video video_url (modeller: 197)
videos video_urls (modeller: 13), reference_video_urls (modeller: 1)

Regler:

  • Skicka antingen det kanoniska namnet eller det ursprungliga namnet. Om du skickar båda med olika värden misslyckas anropet med 422 invalid_input för det kanoniska namnet.
  • En parameter som varken är ett ursprungligt eller kanoniskt namn för modellen avvisas med 422 invalid_input ("Unknown parameter"), tillsammans med det närmaste giltiga namnet som förslag. Stavfel slinker aldrig igenom obemärkt.
  • Varje modellsida visar båda namnen bredvid varandra.

Typkonvertering

Värden konverteras till den typ modellen förväntar sig, så allt detta fungerar:

Du skickar Modellen förväntar sig Blir
5, "5", "5s" duration som en sträng, till exempel "5" "5"
"8" ett heltal 8
"1080P", "4K" resolution, till exempel "1080p", "4k" den exakt tillåtna stavningen
"true", "false", 1, 0 ett booleskt värde true, false
"https://…/a.jpg" en lista med URL:er ["https://…/a.jpg"]
42 en sträng "42"

Tillåtna värden matchas först exakt, sedan utan hänsyn till skiftläge och därefter som tal (5 matchar värdena "5", "5s" och "5 s").

Standardvärden

Parametrar som du utelämnar använder modellens standardvärde, som listas i modellens parametertabell. Priset beräknas med samma standardvärden (till exempel prissätts en videomodell vars generate_audio har standardvärdet true med ljud om du inte skickar "generate_audio": false).

Filparametrar

Bild-, video- och ljudparametrar tar emot en offentlig URL, en data:-URI på upp till 10 MB eller file_url för en uppladdning. Se Files.