Hoppa till huvudinnehåll

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

SeeDream Tasks API:s huvudfunktion är att genom att ange det uppdrag-ID som genererats av SeeDream Images Generation API för att kontrollera statusen för det uppdraget. Detta dokument kommer att detaljerat beskriva integrationen av SeeDream Tasks API, för att hjälpa dig att enkelt integrera och fullt utnyttja den kraftfulla funktionen hos detta API. Genom SeeDream Tasks API kan du enkelt kontrollera statusen för uppdrag som utförs av SeeDream Images Generation API.

​
Ansökningsprocess

För att använda SeeDream Tasks API måste du först gå till ansökningssidan SeeDream Images Generation API för att ansöka om den tjänst som behövs, och sedan kopiera uppdrag-ID:t från SeeDream Images Generation API, som visas i bilden:

Slutligen går du till Tasks API-sidan SeeDream Tasks API för att ansöka om den tjänst som behövs, och när du kommer in på sidan klickar du på knappen “Acquire”, som visas i bilden: Ansökningssidan Om du inte har loggat in eller registrerat dig kommer du automatiskt att omdirigeras till inloggningssidan där du uppmanas att registrera dig och logga in. Efter att ha loggat in eller registrerat dig kommer du automatiskt att återvända till den aktuella sidan. Vid första ansökan kommer det att finnas en gratis kvot som ges, så att du kan använda detta API gratis.

​
Begärningsexempel

SeeDream Tasks API kan användas för att kontrollera resultaten från SeeDream Images Generation API. För information om hur man använder SeeDream Images Generation API, se dokumentet SeeDream Images Generation API. Vi tar ett exempel med ett uppdrag-ID som returnerats av SeeDream Images Generation API för att demonstrera hur man använder detta API. Anta att vi har ett uppdrag-ID: 20068983-0cc9-4c6a-aeb6-9c6a3c668be0, och vi visar hur man gör detta genom att ange ett uppdrag-ID.

​
Uppdragsexempelbild

​
Ställ in begärningshuvuden och begärningskropp

Begärningshuvuden inkluderar:
  • accept: specificera att du tar emot svar i JSON-format, här anges som application/json.
  • authorization: nyckeln för att anropa API:t, som kan väljas direkt efter ansökan.
Begärningskropp inkluderar:
  • id: det uppladdade uppdrag-ID:t.
  • action: sättet att utföra åtgärden på uppdraget.
Inställningarna visas i bilden nedan:

​
Kodexempel

Det kan noteras att olika språkets kod redan har genererats automatiskt på höger sida av sidan, som visas i bilden:

Några kodexempel visas nedan:

​
CURL

curl -X POST 'https://api.xhuoapi.ai/v1/seedream/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "a6e0d456-189b-4c78-9232-2fe72166ab39",
  "action": "retrieve"
}'

​
Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om detta uppdrag. Till exempel: 
{
  "success": true,
  "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
  "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
  "data": [
    {
      "prompt": "a white siamese cat",
      "size": "2048x2048",
      "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
    }
  ]
}
Det returnerade resultatet innehåller flera fält, som beskrivs nedan:
  • success, statusen för videoproduktionsuppdraget.
  • task_id, videoproduktionsuppdragets ID.
  • trace_id, videoproduktionsspårnings-ID.
  • data, listan över resultaten från bildproduktionsuppdraget.
    • image_url, länken till bildproduktionsuppdraget.
    • prompt, promptord.
    • size: pixelstorleken på den genererade bilden.

​
Batchfrågeoperation

Detta är för att fråga detaljer om flera uppdrag-ID:n, och till skillnad från ovan måste åtgärden väljas som retrieve_batch. Begärningskropp inkluderar:
  • ids: array av uppladdade uppdrag-ID:n.
  • action: sättet att utföra åtgärden på uppdraget.
Inställningarna visas i bilden nedan:

​
Kodexempel

Några kodexempel visas nedan:

​
Svarsexempel

Vid en lyckad begäran kommer API:t att returnera detaljerad information om alla batchuppdrag. Till exempel: 
{
  "items": [
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "generera",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "en vit siamesisk katt"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "bilder",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "en vit siamesisk katt",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    },
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "generera",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "en vit siamesisk katt"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "bilder",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "en vit siamesisk katt",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    }
  ],
  "count": 2
}
返回结果一共有多个字段，其中items是包含了批量任务的具体详情信息，每个任务的具体信息与上文的字段一样，字段信息如下。
  • items，批量uppgiftens alla specifika detaljer. Det är en array, varje element i arrayen har samma format som resultatet av att fråga enskilda uppgifter ovan.
  • count，detta är antalet batchfrågeuppgifter.

​
CURL

curl -X POST 'https://api.xhuoapi.ai/v1/seedance/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["84d1544a-9043-4dde-a98b-e889dacd75f6","84d1544a-9043-4dde-a98b-e889dacd75f6"],
  "action": "hämta_batch"
}'

​
Felhantering

Vid anrop av API:et, om ett fel uppstår, kommer API:et att returnera motsvarande felkod och information. Till exempel:
  • 400 token_mismatched：Felaktig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 400 api_not_implemented：Felaktig begäran, möjligtvis på grund av saknade eller ogiltiga parametrar.
  • 401 invalid_token：Obehörig, ogiltig eller saknad auktoriseringstoken.
  • 429 too_many_requests：För många begärningar, du har överskridit hastighetsgränsen.
  • 500 api_error：Intern serverfel, något gick fel på servern.

​
Felrespons Exempel

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "hämtning misslyckades"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Slutsats

Genom detta dokument har du fått en förståelse för hur du använder SeeDream Tasks API för att fråga enskilda eller batchuppgifters alla specifika detaljer. Vi hoppas att detta dokument kan hjälpa dig att bättre integrera och använda API:et. Om du har några frågor, tveka inte att kontakta vårt tekniska supportteam.