Hoppa till huvudinnehåll
Flux Tasks API:s huvudfunktion är att genom att ange det uppdragets ID som genererats av Flux Images Generation API för att kontrollera statusen för det uppdraget. Detta dokument kommer att ge en detaljerad beskrivning av integrationen av Flux Tasks API, vilket hjälper dig att enkelt integrera och fullt utnyttja den kraftfulla funktionaliteten hos detta API. Genom Flux Tasks API kan du enkelt kontrollera statusen för uppdrag som utförs av Flux Images Generation API.

Ansökningsprocess

För att använda Flux Tasks API måste du först gå till ansökningssidan Flux Images Generation API för att ansöka om den aktuella tjänsten, och sedan kopiera uppdragets ID från Flux Images Generation API, som visas i bilden nedan:

Slutligen går du till Flux Tasks API-sidan Flux Tasks API för att ansöka om den aktuella tjänsten. När du kommer till sidan klickar du på knappen “Acquire”, som visas i bilden nedan. 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

Flux Tasks API kan användas för att kontrollera resultaten från Flux Images Generation API. För information om hur man använder Flux Images Generation API, se dokumentet Flux Images Generation API. Vi tar ett exempel med ett uppdragets ID som returnerats av Flux Images Generation API för att demonstrera hur man använder detta API. Anta att vi har ett uppdragets ID: 2db0168c-2373-4367-8d9a-9dc778802e8a, och vi visar hur man gör detta genom att ange ett uppdragets ID.

Uppdragsexempelbild

Ställ in begärningshuvuden och begärningskropp

Begärningshuvuden inkluderar:
  • accept: anger 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 uppdragets ID.
  • action: hur uppdraget ska hanteras.
Inställningen 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 nedan:

Några kodexempel är som följer:

CURL

curl -X POST 'https://api.acedata.cloud/flux/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "2c454ff3-4f8f-47f0-8147-acb29a84d1c2",
  "action": "retrieve"
}'

Python

import requests

url = "https://api.acedata.cloud/flux/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "id": "2c454ff3-4f8f-47f0-8147-acb29a84d1c2",
    "action": "retrieve"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Svarsexempel

När begäran lyckas kommer API:t att returnera detaljerad information om detta bilduppdrag. Till exempel:
{
  "_id": "677de81d550a4144a5f4cf62",
  "id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
  "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
  "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
  "created_at": 1736304669.779,
  "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
  "request": {
    "action": "generate",
    "size": "1024x1024",
    "prompt": "a white siamese cat"
  },
  "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
  "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
  "response": {
    "success": true,
    "task_id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
    "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
    "data": [
      {
        "prompt": "a white siamese cat",
        "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57d9ff7c-5a00-409e-9dcc-90f35b38d16e_0.png",
        "seed": 281520112,
        "timings": {
          "inference": 3.193
        }
      }
    ]
  }
}
Det returnerade resultatet innehåller flera fält, där request-fältet är begärningskroppen som skickades vid uppdragets start, medan response-fältet är svaret som returnerades efter att uppdraget slutfördes. Fälten beskrivs nedan.
  • id, ID:t för att generera detta bilduppdrag, används för att unikt identifiera detta bildgenereringsuppdrag.
  • request, information om begäran i bilduppdraget.
  • response, information om svaret i bilduppdraget.

Batchfrågeoperationer

Detta är för att fråga detaljer om bilduppdrag för flera uppdragets ID:n. Till skillnad från ovanstående måste action väljas som retrieve_batch. Begärningskropp inkluderar:
  • ids: en array av uppladdade uppdragets ID:n.
  • action: hur uppdraget ska hanteras.
Inställningen 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 nedan:

Några kodexempel är som följer:

Svarsexempel

När begäran lyckas kommer API:t att returnera detaljerad information om alla batchbilduppdrag. Till exempel:
{
  "items": [
    {
      "_id": "677de81d550a4144a5f4cf62",
      "id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
      "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
      "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
      "created_at": 1736304669.779,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generera",
        "size": "1024x1024",
        "prompt": "en vit siamesisk katt"
      },
      "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
        "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
        "data": [
          {
            "prompt": "en vit siamesisk katt",
            "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57d9ff7c-5a00-409e-9dcc-90f35b38d16e_0.png",
            "seed": 281520112,
            "timings": {
              "inference": 3.193
            }
          }
        ]
      }
    },
    {
      "_id": "677de950550a4144a5f52963",
      "id": "72bdd69d-290d-4710-a6d4-60c78968865a",
      "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
      "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
      "created_at": 1736304976.278,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generera",
        "size": "1024x1024",
        "prompt": "en vit siamesisk katt"
      },
      "trace_id": "1dca4b49-d31d-42e6-83d9-7f0c56f62d31",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "72bdd69d-290d-4710-a6d4-60c78968865a",
        "trace_id": "1dca4b49-d31d-42e6-83d9-7f0c56f62d31",
        "data": [
          {
            "prompt": "en vit siamesisk katt",
            "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57b5c7e5-3436-466d-86ed-583ede4a3d7c_0.png",
            "seed": 1437672535,
            "timings": {
              "inference": 3.175
            }
          }
        ]
      }
    }
  ],
  "count": 2
}

CURL

curl -X POST 'https://api.acedata.cloud/flux/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["2db0168c-2373-4367-8d9a-9dc778802e8a","72bdd69d-290d-4710-a6d4-60c78968865a"],
  "action": "hämta_batch"
}'

Python

import requests

url = "https://api.acedata.cloud/flux/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "ids": ["2db0168c-2373-4367-8d9a-9dc778802e8a","72bdd69d-290d-4710-a6d4-60c78968865a"],
    "action": "hämta_batch"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

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 man använder FLux Tasks API för att hämta alla specifika detaljer om enskilda eller batchbilduppgifter. 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.