# 查询3D生成任务列表

> 全部文档的索引见 [llms.txt](https://ark.volcengine.com/llms.txt)；在任一文档页面地址后追加 `.md` 可获取该页的 Markdown 版本。

`GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks`

通过筛选参数查询符合条件的影眸 3D 生成任务。

> **说明**
>
> 仅支持查询最近 7 天的历史数据。时间计算统一采用 UTC 时间戳，返回的 7 天历史数据范围以用户实际发起批量查询请求的时刻为基准（精确到秒），时间戳区间为 `[T-7 天, T)`。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [Base URL 及鉴权](/docs/base-url-and-authentication)。

* API Key 鉴权，请在 [API Key 管理](https://ark.volcengine.com/region:cn-beijing/apiKey) 页面，获取长效 API Key。

---

<span id="request-parameters"></span>
## 请求参数

### Query 参数

> 在 URL Query String 中传入。

**filter** `object` | 筛选条件

用于筛选任务的参数。

**model** `string` | 推理接入点 ID 筛选

`filter.model`

任务使用的推理接入点（Endpoint）ID，精确搜索。可在控制台 [在线推理] → [自定义推理接入点] 页面复制推理接入点 ID (格式为 `ep-` 开头的字符串), 或通过创建推理接入点接口获取。

**status** `string` | 任务状态筛选

`filter.status`

过滤参数，查询某个任务状态。任务状态，以及相关的信息：

* `queued`：排队中。
* `running`：任务运行中。
* `cancelled`：取消任务，取消状态 24h 自动删除（只支持 `queued` 状态的任务被取消）。
* `succeeded`：任务成功。
* `failed`：任务失败。

**task_ids** `string[]` | 任务 ID 筛选

`filter.task_ids`

影眸 3D 生成任务 ID，精确搜索，支持同时搜索多个任务 ID。需通过重复参数名的方式传递，示例：`filter.task_ids=id1&filter.task_ids=id2`

**page_num** `integer` `默认值 1` | 页码

返回结果的页码。

**取值范围**：`[1, 500]`

**page_size** `integer` `默认值 20` | 每页数量

每页显示的结果数量。

**取值范围**：`[1, 500]`

## 响应参数

**items** `object[]` | 任务列表

查询到的影眸 3D 生成任务列表

**id** `string` | 任务 ID

`items.id`

影眸 3D 生成任务 ID

**model** `string` | 模型名称与版本

`items.model`

任务使用的模型名称和版本，格式为 `模型名称-版本`

**status** `string` | 任务状态

`items.status`

任务状态，以及相关的信息：

* `queued`：排队中。
* `running`：任务运行中。
* `cancelled`：取消任务，取消状态 24h 自动删除（只支持 `queued` 状态的任务被取消）。
* `succeeded`：任务成功。
* `failed`：任务失败。

**content** `object` | 输出内容

`items.content`

影眸 3D 生成任务完成时返回的输出内容，包含生成文件的下载 URL

**file_url** `string` | 文件 URL

`items.content.file_url`

生成的 3D 文件的 URL。为保障信息安全，生成的 3D 模型文件会在 24 小时后被清理，请及时转存。

> **说明**
>
> * 模型会自动将生成的 3D 模型文件打包为 .zip 格式以供下载，压缩包内文件的格式与您创建任务时所指定的格式一致。
> * 推荐配置火山引擎 TOS 提供的数据订阅功能，将您的模型推理产物自动转存到自己的 TOS 桶中，便于长期备份或二次加工。详细介绍请参见 [TOS 数据订阅](https://docs.volcengine.com/docs/6349/2280949?lang=zh)。

**created_at** `integer` | 创建时间

`items.created_at`

任务创建时间的 Unix 时间戳（秒）

**error** `object` | 错误信息

`items.error`

错误提示信息。任务成功时返回 `null`，任务失败时返回错误数据，错误信息具体参见 [错误处理](https://ark.volcengine.com/region:cn-beijing/docs/error-codes)

**code** `string` | 错误码

`items.error.code`

**message** `string` | 错误提示信息

`items.error.message`

**updated_at** `integer` | 更新时间

`items.updated_at`

任务当前状态更新时间的 Unix 时间戳（秒）

**usage** `object` | token 用量

`items.usage`

本次请求的 token 用量

**completion_tokens** `integer` | 生成 3D 内容消耗的 token 数

`items.usage.completion_tokens`

模型生成 3D 内容消耗的 token 数量，可作为计费对账依据。

**total_tokens** `integer` | 总 token 数

`items.usage.total_tokens`

本次请求消耗的总 token 数量。3D 生成模型不统计输入 token，输入 token 为 0，故 `total_tokens` = `completion_tokens`

**total** `integer` | 任务总数

符合筛选条件的任务数量


## 代码示例

## 默认

### cURL


#### Request

```bash
curl -X GET "https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks?page_num=2&filter.status=succeeded" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ARK_API_KEY"
```
#### Response

```
{
   "items": [
       {
          "id":"cgt-2026****-**",
          "model":"hyper3d-gen2-260112",
          "status":"succeeded",
          "content":{
            "file_url":"https://xxx",
          },
          "usage":{
               "completion_tokens":30000,
               "total_tokens":30000,
          } ,
          "created_at":1718049470,
          "updated_at":1718049470
        },
        {
          "id":"cgt-2026****-**",
          "model":"hyper3d-gen2-260112",
          "status":"succeeded",
          "content":{
            "file_url":"https://xxx",
          },
          "usage":{
               "completion_tokens":30000,
               "total_tokens":30000,
          },
          "created_at":1718049470,
          "updated_at":1718049470
        },
     ],
   "total":2
}
```