Flux Tasks API の接続と使用

Flux Tasks API の主な機能は、Flux Images Generation API によって生成されたタスクIDを入力することで、そのタスクの実行状況を照会することです。この文書では、Flux Tasks API の接続説明を詳しく紹介し、簡単に統合し、この API の強力な機能を十分に活用できるようにします。Flux Tasks API を使用することで、Flux Images Generation API のタスク実行状況を簡単に照会できます。

申請プロセス

Flux Images Generation API を使用するには、まず Ace Data Cloud コンソールで API トークンを取得し、保管してください。

まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。完了後、現在のページに自動的に戻ります。 1つの API トークンでプラットフォームのすべてのサービスを呼び出すことができ、各サービスごとに個別に申請する必要はありません。 初回申請時には無料のクレジットが付与され、無料で体験できます。クレジットが不足した場合は、コンソールで一般残高をチャージできます。

📘 完全な文書：Flux Images Generation API →

リクエスト例

Flux Tasks API は、Flux Images Generation API の結果を照会するために使用できます。Flux Images Generation API の使用方法については、文書 Flux Images Generation API を参照してください。 Flux Images Generation API サービスから返されたタスクIDの例を用いて、この API の使用方法を示します。タスクID：2db0168c-2373-4367-8d9a-9dc778802e8a があると仮定し、次にタスクIDを渡す方法を示します。

タスク例の画像

リクエストヘッダーとリクエストボディの設定

Request Headers には以下が含まれます：

accept：JSON形式のレスポンス結果を受け取ることを指定し、ここでは application/json を記入します。
authorization：APIを呼び出すためのキーで、申請後に直接ドロップダウンから選択できます。

Request Body には以下が含まれます：

id：アップロードされたタスクID。
action：タスクの操作方法。

設定は以下の図のようになります：

コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

一部のコード例は以下の通りです：

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)

レスポンス例

リクエストが成功すると、API はこの画像タスクの詳細情報を返します。例えば：

{
  "_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,
  "started_at": 1736304669.839,
  "finished_at": 1736304679.439,
  "elapsed": 9.6,
  "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://cdn.acedata.cloud/e724d7f13d.png",
        "seed": 281520112,
        "timings": {
          "inference": 3.193
        }
      }
    ]
  }
}

返された結果には複数のフィールドがあり、request フィールドはタスクを開始したときの request body であり、response フィールドはタスク完了後に返される response body です。フィールドの説明は以下の通りです。

id：この画像タスクを生成するための ID で、今回の画像生成タスクを一意に識別します。
request：画像タスク内のリクエスト情報を照会します。
response：画像タスク内の返却情報を照会します。
created_at：タスク作成時間、Unix タイムスタンプ（秒、浮動小数点）。
started_at：タスク開始実行時間、Unix タイムスタンプ（秒、浮動小数点）。
finished_at：タスク完了時間、Unix タイムスタンプ（秒、浮動小数点）。タスクが未完了の場合はこのフィールドは返されません。
elapsed：タスク実行にかかった時間、単位は秒（浮動小数点、3 桁の小数点以下を保持）。タスクが未完了の場合はこのフィールドは返されません。

バッチ照会操作

これは複数のタスクIDに対して画像タスクの詳細を照会するもので、上記とは異なり、action を retrieve_batch に設定する必要があります。 Request Body には以下が含まれます：

ids：アップロードされたタスクIDの配列。
action：タスクの操作方法。

設定は以下の図のようになります：

コード例

ページの右側には、さまざまな言語のコードが自動生成されていることがわかります。以下の図のように：

一部のコード例は以下の通りです：

レスポンス例

リクエストが成功すると、API は今回のすべてのバッチ画像タスクの具体的な詳細情報を返します。例えば：

{
  "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,
      "started_at": 1736304669.839,
      "finished_at": 1736304679.439,
      "elapsed": 9.6,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generate",
        "size": "1024x1024",
        "prompt": "白いシャム猫"
      },
      "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": "白いシャム猫",
            "image_url": "https://cdn.acedata.cloud/e724d7f13d.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,
      "started_at": 1736304976.338,
      "finished_at": 1736304985.938,
      "elapsed": 9.6,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generate",
        "size": "1024x1024",
        "prompt": "白いシャム猫"
      },
      "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": "白いシャム猫",
            "image_url": "https://cdn.acedata.cloud/e724d7f13d.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": "retrieve_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": "retrieve_batch"
}

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

エラー処理

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：

400 token_mismatched：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
400 api_not_implemented：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
401 invalid_token：認証されていない、無効または不足している認証トークン。
429 too_many_requests：リクエストが多すぎます、レート制限を超えました。
500 api_error：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

エラー応答の例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "取得に失敗しました"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

結論

本ドキュメントを通じて、FLux Tasks APIを使用して単一またはバッチ画像タスクのすべての具体的な詳細情報を照会する方法を理解しました。このドキュメントがAPIの接続と使用に役立つことを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。

はじめに

AIチャット

AI画像

AI動画

AIオーディオ

ウェブ＆データ

CAPTCHA

アイデンティティ

プロキシ

上級

Coding

Flux Tasks API の接続と使用

申請プロセス

リクエスト例

タスク例の画像

リクエストヘッダーとリクエストボディの設定

コード例

CURL

Python

レスポンス例

バッチ照会操作

コード例

レスポンス例

CURL

Python

エラー処理

エラー応答の例

結論

​申請プロセス

​リクエスト例

​タスク例の画像

​リクエストヘッダーとリクエストボディの設定

​コード例

​CURL

​Python

​レスポンス例

​バッチ照会操作

​コード例

​レスポンス例

​CURL

​Python

​エラー処理

​エラー応答の例

​結論

申請プロセス

リクエスト例

タスク例の画像

リクエストヘッダーとリクエストボディの設定

コード例

CURL

Python

レスポンス例

バッチ照会操作

コード例

レスポンス例

CURL

Python

エラー処理

エラー応答の例

結論