# Models API

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

`GET https://ark.cn-beijing.volces.com/api/v3/models`

查询当前账号可见的基础模型版本及其能力、模态、Token 限制、推理强度和支持的 API。返回全部可见模型版本，按创建时间降序排列。

## 鉴权

本接口支持鉴权方式如下，详情请参见 [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>
## 请求参数

## 响应参数

**data** `object[]` | 模型版本列表

当前账号可见的模型版本列表。无可见模型版本时返回空数组。

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

`data.created`

模型版本创建时间，Unix 时间戳，单位为秒。

**domain** `string` | 模型领域

`data.domain`

模型所属领域，包括 `LLM`、`VLM`、`ImageGeneration`、`VideoGeneration`、`3DGeneration`、`Audio` 和 `Embedding`。

该模型不支持领域信息时返回空字符串。

**features** `object` | 模型能力

`data.features`

模型支持的能力。

**batch** `object` | 批量推理能力

`data.features.batch`

**batch_chat** `boolean` | Batch Chat

`data.features.batch.batch_chat`

是否支持 Batch Chat。该模型不支持 Batch Chat 时返回 `false`。

**batch_job** `boolean` | Batch Job

`data.features.batch.batch_job`

是否支持 Batch Job。该模型不支持 Batch Job 时返回 `false`。

**cache** `object` | 缓存能力

`data.features.cache`

**prefix_cache** `boolean` | 前缀缓存

`data.features.cache.prefix_cache`

是否支持前缀缓存。该模型不支持前缀缓存时返回 `false`。

**session_cache** `boolean` | 会话缓存

`data.features.cache.session_cache`

是否支持会话缓存。该模型不支持会话缓存时返回 `false`。

**structured_outputs** `object` | 结构化输出能力

`data.features.structured_outputs`

**json_object** `boolean` | JSON 对象输出

`data.features.structured_outputs.json_object`

是否支持 JSON 对象输出。该模型不支持 JSON 对象输出时返回 `false`。

**json_schema** `boolean` | JSON Schema 输出

`data.features.structured_outputs.json_schema`

是否支持 JSON Schema 输出。该模型不支持 JSON Schema 输出时返回 `false`。

**thinking** `object` | 思考能力

`data.features.thinking`

**type** `string` | 思考类型

`data.features.thinking.type`

是否支持深度思考能力。`enabled` 表示支持，`disabled` 表示不支持。

**tools** `object` | 工具能力

`data.features.tools`

工具调用能力。

**function_calling** `boolean` | 函数调用

`data.features.tools.function_calling`

是否支持函数调用。该模型不支持函数调用时返回 `false`。

**web_search** `boolean` | 联网搜索

`data.features.tools.web_search`

是否支持联网搜索。该模型不支持联网搜索时返回 `false`。

**id** `string` | 模型版本 ID

`data.id`

**name** `string` | 基础模型名称

`data.name`

**object** `string` | 对象类型

`data.object`

对象类型，固定为 `model`。

**version** `string` | 模型版本

`data.version`

**api_supported** `object` | 支持的 API

`data.api_supported`

模型支持的 API 及其启用状态。

**context_window** `integer` | 上下文窗口

`data.context_window`

最大上下文长度，单位为 Token。

**最小值**：`0`

**effort** `object` | 推理强度

`data.effort`

模型支持的推理强度等级和默认等级。

**supported_levels** `string[]` | 支持的推理强度等级

`data.effort.supported_levels`

**default_level** `string` | 默认推理强度等级

`data.effort.default_level`

模型默认使用的推理强度等级。

**max_output_tokens** `integer` | 最大输出 Token 数

`data.max_output_tokens`

最大输出长度，单位为 Token。

**最小值**：`0`

**modalities** `object` | 模态

`data.modalities`

模型支持的输入和输出模态。

**input_modalities** `string[]` | 输入模态

`data.modalities.input_modalities`

模型支持的输入模态，包括 `text`、`image`、`video` 和 `audio`。

**output_modalities** `string[]` | 输出模态

`data.modalities.output_modalities`

模型支持的输出模态，包括 `text`、`image`、`video`、`audio`、`3D` 和 `embedding`。

**status** `string` | 生命周期状态

`data.status`

模型版本的生命周期状态。`Published` 表示模型已上线，可正常调用；`Retiring` 表示模型处于计划下线状态，当前仍可调用，后续将停止服务。

**task_type** `string[]` | 任务类型

`data.task_type`

模型支持的任务类型。

**token_limits** `object` | Token 限制

`data.token_limits`

模型 Token 限制。

**context_window** `integer` | 上下文窗口

`data.token_limits.context_window`

最大上下文长度，单位为 Token。

**最小值**：`0`

**max_input_token_length** `integer` | 最大输入 Token 数

`data.token_limits.max_input_token_length`

最大输入长度，单位为 Token。

**最小值**：`0`

**max_output_token_length** `integer` | 最大输出 Token 数

`data.token_limits.max_output_token_length`

最大输出长度，单位为 Token。

**最小值**：`0`

**max_reasoning_token_length** `integer` | 最大推理 Token 数

`data.token_limits.max_reasoning_token_length`

最大推理长度，单位为 Token。

**最小值**：`0`

**object** `string` | 对象类型

响应对象类型，固定为 `list`。


## 代码示例

## 默认

### Curl


#### Request

```bash
curl "https://ark.cn-beijing.volces.com/api/v3/models" \
  -H "Authorization: Bearer $ARK_API_KEY"
```

#### Response

```
{
  "object": "list",
  "data": [
    {
      "id": "doubao-seed-2-1-pro-260915",
      "object": "model",
      "name": "doubao-seed-2-1-pro",
      "version": "260915",
      "created": 1789472816,
      "domain": "VLM",
      "task_type": [
        "VisualQuestionAnswering",
        "TextGeneration"
      ],
      "token_limits": {
        "context_window": 1048576,
        "max_output_token_length": 262144,
        "max_input_token_length": 1048576,
        "max_reasoning_token_length": 262144
      },
      "modalities": {
        "input_modalities": [
          "text",
          "image",
          "video"
        ],
        "output_modalities": [
          "text"
        ]
      },
      "features": {
        "tools": {
          "function_calling": true
        },
        "structured_outputs": {
          "json_object": true,
          "json_schema": true
        },
        "cache": {
          "prefix_cache": false,
          "session_cache": false
        },
        "batch": {
          "batch_job": false,
          "batch_chat": false
        }
      },
      "max_output_tokens": 262144
    }
  ]
}
```
