Skip to main content

​
Dreamina Tasks API:s integration och användning

Dreamina Tasks API används för att fråga om resultaten av digitala videouppgifter skapade av Dreamina Video Generation API. När du skickar callback_url eller async: true i genereringsgränssnittet kommer API:t omedelbart att returnera ett task_id, som du kan använda för att pollera uppgiftsstatus och den slutliga videoadressen via detta API med task_id eller trace_id. Detta API är gratis.

​
Ansökningsprocess

För att använda Dreamina-serien av API:er, börja med att hämta din API-token från Ace Data Cloud-konsolen för framtida bruk. Om du inte är inloggad eller registrerad kommer du automatiskt att omdirigeras till inloggningssidan för att registrera dig och logga in, och efter att ha slutfört detta kommer du automatiskt att återvända till den aktuella sidan. En API-token räcker för att anropa alla tjänster på plattformen, du behöver inte ansöka separat för varje tjänst. Första ansökan ger en gratis kvot för att prova; om kvoten är otillräcklig kan du ladda på allmän balans i konsolen.

​
Begärningsparametrar

Begärningshuvuden
  • accept: specificera att du tar emot svar i JSON-format, skriv application/json.
  • authorization: nyckeln för att anropa API:t, formatet är Bearer {token}.
  • content-type: skriv application/json.
Begärningskropp
Vid fråga om en enskild uppgift, ange antingen id eller trace_id.

​
Fråga en enskild uppgift

​
CURL

​
Python

​
Exempel på svar

När begäran lyckas returnerar API:t detaljer om uppgiften. request är begärningskroppen vid skapandet av uppgiften, response är svaret efter att uppgiften har slutförts, där data.video_url är adressen till den genererade digitala videon:
Fältbeskrivning:
  • id: Det unika ID:t för denna videogenereringsuppgift.
  • trace_id: Spårnings-ID:t för denna begäran, används för felsökning.
  • request: Innehållet i begäran som skickades vid skapandet av uppgiften.
  • response: Innehållet i svaret som returneras efter att uppgiften har slutförts. När response.data.status är done, är response.data.video_url den slutliga videoadressen.
  • created_at: Tiden då uppgiften skapades, Unix-tidsstämpel (sekunder, flyttal).
  • started_at: Tiden då uppgiften började utföras, Unix-tidsstämpel (sekunder, flyttal).
  • finished_at: Tiden då uppgiften slutfördes, Unix-tidsstämpel (sekunder, flyttal). Detta fält returneras inte om uppgiften inte är slutförd.
  • elapsed: Tiden som uppgiften tog att utföra, i sekunder (flyttal, med 3 decimaler). Detta fält returneras inte om uppgiften inte är slutförd.
Om uppgiften ännu inte är slutförd kan status vara ett annat än done; om uppgiften inte finns eller resultatet ännu inte har genererats, kommer API:t att returnera ett tomt objekt {}, vänligen försök igen senare.

​
Batchfråga uppgifter

Ställ in action till retrieve_batch och skicka in en ids-array:
I det returnerade resultatet är items en array med detaljer om batchuppgifterna (varje element har samma format som en enskild fråga), count är antalet uppgifter som returnerades denna gång.

​
Felhantering

När API:t anropas och ett fel uppstår, returneras motsvarande felkod och meddelande:
  • 400 bad_request: Begäran är felaktig, det kan saknas nödvändiga parametrar som id / trace_id.
  • 401 invalid_token: Ej auktoriserad, auktoriseringstoken är ogiltig eller saknas.
  • 429 too_many_requests: För många begärningar, har överskridit hastighetsgränsen.
  • 500 api_error: Intern serverfel.

​
Exempel på felrespons

​
Slutsats

Genom detta dokument har du lärt dig hur man använder Dreamina Tasks API för att fråga om resultatet av enskilda eller batch digitala videouppgifter. Tillsammans med genereringsgränssnittets callback_url / async asynkrona läge kan du uppnå stabil polling. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.