> ## 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. # Flux Tasks API 的对接和使用 > Flux Image Generation 集成指南 - XHuoAPI Flux Tasks API 的主要功能是通过输入 Flux Images Generation API 生成的任务ID来查询该任务的执行情况。 本文档将详细介绍 Flux Tasks API 的对接说明，帮助您轻松集成并充分利用该 API 的强大功能。通过 Flux Tasks API ，您可以轻松实现查询 Flux Images Generation API 的任务执行情况。 ## 申请流程 要使用 Flux Tasks API，需要先到 申请页面 [Flux Images Generation API ](https://api.xhuoapi.ai/documents/6b9197c5-7a3f-4878-a43f-7f94e7e66394)申请相应的服务，然后复制 Flux Images Generation API的任务ID，如图所示：

最后进入Flux Tasks API页面 [Flux Tasks API ](https://api.xhuoapi.ai/documents/39b38bbe-60f3-40da-b2b6-5ce1e091852b)申请相应的服务，进入页面之后，点击「Acquire」按钮，如图所示 ![申请页面](https://cdn.xhuoapi.ai/rci31i.png) 如果您尚未登录或注册，会自动跳转到[登录页面](https://api.xhuoapi.ai)邀请您来注册和登录，登录注册之后会自动返回当前页面。 首次申请时会有免费额度赠送，可以免费使用该 API。 ## 请求示例 Flux Tasks API 可以用于查询 Flux Images Generation API 的结果。关于怎样使用 Flux Images Generation API，请参考文档 [Flux Images Generation API ](https://api.xhuoapi.ai/documents/flux-images-integration)。 我们以 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 ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/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 ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/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 将返回此处图片任务的详情信息。例如： ```json theme={null} { "_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 } } ] } } ``` 返回结果一共有多个字段，request 字段就是发起任务时的 request body，同时response 字段是任务完成后返回的response body。字段介绍如下。 * `id`，生成此图片任务的 ID，用于唯一标识此次图片生成任务。 * `request`，查询图片任务中的请求信息。 * `response`，查询图片任务中的返回信息。 ## 批量查询操作 这是是针对多个任务ID来进行查询图片任务详情，与上面不同的是需要将action选中为retrieve\_batch **Request Body** 包括： * `ids`：上传的任务ID数组。 * `action`：对任务的操作方式。 设置如下图所示：

### 代码示例 可以发现，在页面右侧已经自动生成了各种语言的代码，如图所示：

部分代码示例如下： #### CURL ```bash theme={null} curl -X POST 'https://api.xhuoapi.ai/v1/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 ```python theme={null} import requests url = "https://api.xhuoapi.ai/v1/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 将返回此次所有批量图片任务的具体详情信息。例如： ```json theme={null} { "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": "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 } } ] } }, { "_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": "generate", "size": "1024x1024", "prompt": "a white siamese cat" }, "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": "a white siamese cat", "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 } ``` 返回结果一共有多个字段，其中items是包含了批量图片任务的具体详情信息，每个图片任务的具体信息与上文的字段一样，字段信息如下。 * `items`，批量图片任务的所有具体详情信息。它是一个数组，每个数组的元素和上文查询单个任务的返回结果格式是一样的。 * `count`，此处批量查询图片任务的个数。 ## 错误处理 在调用 API 时，如果遇到错误，API 会返回相应的错误代码和信息。例如： * `400 token_mismatched`：Bad request, possibly due to missing or invalid parameters. * `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters. * `401 invalid_token`：Unauthorized, invalid or missing authorization token. * `429 too_many_requests`：Too many requests, you have exceeded the rate limit. * `500 api_error`：Internal server error, something went wrong on the server. ### 错误响应示例 ```json theme={null} { "success": false, "error": { "code": "api_error", "message": "fetch failed" }, "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89" } ``` ## 结论 通过本文档，您已经了解了如何使用 FLux Tasks API 进行查询单个或批量图片任务的所有具体详情信息。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。