- Version 1 (klassiskt läge): Stöder parametrarna
duration(10/15/25 sekunder),orientation(landskap/porträtt),size(small/large upplösning), referensbilderimage_urls, karaktärs-###character_urlmed flera. - Version 2 (partnerläge): Stöder
seconds(4/8/12 sekunder), pixelupplösningsize(t.ex. 1280x720), referensbildinput_referencemed flera.
Ansökningsprocess
För att använda API:et måste du först ansöka om tjänsten på Sora Videos Generation API. När du kommer till sidan klickar du på knappen “Acquire”, som visas nedan:
Om du inte är inloggad eller registrerad omdirigeras du automatiskt till inloggningssidan för att registrera och logga in. Efter inloggning återvänder du automatiskt till den aktuella sidan.
Vid första ansökan får du en gratis kvot som gör att du kan använda API:et kostnadsfritt.
Grundläggande användning (Version 1)
Först bör du förstå grundläggande användning av Version 1, där du matar in promptprompt, en array med referensbildlänkar image_urls samt modellen model för att få ett bearbetat resultat. Detaljer visas nedan:

accept: önskat format för svar, härapplication/json(JSON-format).authorization: API-nyckeln för anrop, som kan väljas direkt efter ansökan.
model: modellen för videoproduktion, stödersora-2(standardläge) ochsora-2-pro(HD-läge).sora-2-prostödjerdurationpå 25 sekunder, medansora-2endast stödjer 10 och 15 sekunder (endast Version 1).size: videoupplösning,smallför standard ochlargeför HD (endast Version 1).duration: videolängd, stöder 10, 15 och 25 sekunder, där 25 sekunder endast stöds avsora-2-pro(endast Version 1).orientation: bildformat, stöderlandscape(landskap) ochportrait(porträtt) (endast Version 1).image_urls: array med referensbildlänkar för bild-till-video (endast Version 1).character_url: karaktärs-###-länk, videon får inte innehålla verkliga personer (endast Version 1).character_start/character_end: start- och stopptid för karaktärens närvaro i sekunder, skillnad 1-3 sekunder (endast Version 1).prompt: prompttext (obligatorisk).callback_url: URL för asynkron callback.version: API-version,"1.0"(standard) eller"2.0".

success: status för videoproduktionsuppgiften.task_id: ID för videoproduktionsuppgiften.trace_id: spårnings-ID för uppgiften.data: lista med resultat för videoproduktionsuppgiften.id: video-ID för uppgiften.video_url: videolänk för uppgiften.state: status för uppgiften.
data för att hämta den genererade Sora-videon.
Om du vill generera motsvarande integrationskod kan du kopiera den som genereras, till exempel CURL-koden nedan:
Bild-till-video-uppgifter (Version 1)
För att utföra bild-till-video-uppgifter måste parameternimage_urls innehålla referensbildlänkar, vilket specificerar följande:
image_urls: array med referensbildlänkar som används för bild-till-video-uppgiften. Observera att verkliga porträttbilder inte får användas, då detta kan leda till att uppgiften misslyckas.


Karaktärsgenererad video (Version 1)
För att skapa karaktärsgenererad video måste parameterncharacter_url innehålla en videolänk som används för att skapa karaktären. Observera att videon inte får innehålla verkliga personer, annars misslyckas uppgiften. Följande gäller:
character_url: videolänk för karaktärsskapande, videon får inte innehålla verkliga personer för att undvika fel.


Version 2.0-läge
Utöver Version 1.0-läget stöder API:et även Version 2.0-läget, som aktiveras genom att sätta parameternversion till "2.0". Version 2.0 stöder kortare videolängder och pixelnivåupplösningskontroll.
Version 2.0 parameterbeskrivning
| Parameter | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
version | string | Ja | Sätt till "2.0" |
prompt | string | Ja | Prompt för videoproduktion |
model | string | Nej | sora-2 (standard) eller sora-2-pro |
duration | integer | Nej | Videolängd: 4 (standard), 8, 12 sekunder |
size | string | Nej | Upplösning: 720x1280 (standard), 1280x720, 1024x1792, 1792x1024 |
image_urls | array | Nej | Array med referensbild-URL: endast första bilden används, bildstorlek måste matcha size |
callback_url | string | Nej | URL för asynkron callback |
Grundläggande exempel
Använda referensbilder (Version 2.0)
I Version 2.0 kan du använda parameternimage_urls för att skicka in referensbilder som styr videoproduktionen (endast första bilden används):
Observera: Referensbildens storlek bör matchasize-parametern, t.ex. omsizeär1280x720bör referensbilden vara 1280×720 pixlar.
Jämförelse av parametrar mellan Version 1.0 och Version 2.0
| Parameter | Version 1.0 | Version 2.0 |
|---|---|---|
version | 1.0 (standard) | 2.0 |
prompt | ✅ | ✅ |
model | ✅ sora-2 / sora-2-pro | ✅ sora-2 / sora-2-pro |
duration | ✅ 10/15/25 sekunder | ✅ 4/8/12 sekunder |
orientation | ✅ landscape/portrait | ❌ |
size | ✅ small/large | ✅ 720x1280/1280x720/1024x1792/1792x1024 |
image_urls | ✅ flera referensbilder | ✅ endast första används |
character_url | ✅ | ❌ |
callback_url | ✅ | ✅ |
Asynkron callback
Eftersom Sora Videos Generation API kan ta 1-2 minuter att generera video, och långa HTTP-förfrågningar kan belasta systemresurser, stöder API:et asynkron callback. Processen är: klienten skickar en förfrågan medcallback_url-fältet. API:et svarar omedelbart med ett resultat som innehåller task_id. När uppgiften är klar skickas resultatet via POST JSON till klientens angivna callback_url, inklusive task_id för att koppla ihop uppgiften.
Nedan visas ett exempel på hur detta fungerar.
Webhook-callback är en tjänst som kan ta emot HTTP-förfrågningar. Utvecklare bör ersätta med sin egen HTTP-server-URL. För demonstration används den publika webhook-sidan https://webhook.site/, där du får en webhook-URL som visas nedan:
Kopiera denna URL, t.ex. https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa, och använd som webhook.
Sätt sedan callback_url till denna webhook-URL och fyll i övriga parametrar, enligt nedan:

https://webhook.site/eb238c4f-da3b-47a5-a922-a93aa5405daa, enligt nedan:
Innehållet är:
task_id och övriga fält som ovan, vilket möjliggör koppling av uppgiften via ID.
Felhantering
Vid API-anrop som resulterar i fel returnerar API:et motsvarande felkod och meddelande, exempelvis:400 token_mismatched: Felaktig förfrågan, troligen saknade eller ogiltiga parametrar.400 api_not_implemented: Felaktig förfrågan, troligen saknade eller ogiltiga parametrar.401 invalid_token: Obefogad, ogiltig eller saknad auktoriseringstoken.429 too_many_requests: För många förfrågningar, du har överskridit gränsen.500 api_error: Intern serverfel, något gick fel på servern.

