面向 AI 助手：本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/list-foundation-models-api.md，全部文档索引见 https://ark.volcengine.com/llms.txt。

获取基础模型列表

POST https://ark.cn-beijing.volcengineapi.com/?Action=ListFoundationModels&Version=2024-01-01

列出基础模型。

鉴权#

本接口支持鉴权方式如下，详情请参见 Base URL 及鉴权。

  • Access Key 鉴权，请在 Access Key 管理 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

Filter object  |  筛选条件

基础模型列表筛选条件。

AccessTypes string[]  |  访问模式

Filter.AccessTypes

按基础模型访问模式列表精准匹配。可指定值：Public、Private。

Description string  |  描述匹配

Filter.Description

按基础模型描述模糊匹配。

DisplayName string  |  展示名匹配

Filter.DisplayName

按基础模型展示名模糊匹配。

FoundationModelTag object  |  能力标签

Filter.FoundationModelTag

按基础模型的能力标签筛选。

Domains string[]  |  能力领域

Filter.FoundationModelTag.Domains

基础模型覆盖的能力领域列表。可指定值：

  • LLM：大语言模型
  • Audio：语音大模型
  • ComputerVision：视觉大模型
  • MultiModal：多模态
  • Embedding：向量模型
  • VLM：视觉语言模型
Languages string[]  |  支持语言

Filter.FoundationModelTag.Languages

基础模型支持的自然语言列表。

TaskTypes string[]  |  支持任务类型

Filter.FoundationModelTag.TaskTypes

基础模型支持的任务类型列表。可指定值：

  • TextGeneration：文本生成
  • VisualQuestionAnswering：图片内容理解
  • TextToImage：文生图
  • ImageToImage：图生图
  • TextToVideo：文生视频
  • ImageToVideo：图生视频
  • TextTo3D：文生 3D
  • ImageTo3D：图生 3D
  • VoiceClone：声音复刻
  • TextToSpeech：文本转语音
  • SpeechToText：语音转文本
  • SpeechToSpeech：同声传译
  • TextEmbedding：文本向量化
  • ImageEmbedding：图像向量化
  • MultimodalEmbedding：多模态向量化
UsedLibraries string[]  |  依赖库

Filter.FoundationModelTag.UsedLibraries

基础模型依赖的库列表。

Introduction string  |  介绍匹配

Filter.Introduction

按基础模型介绍模糊匹配。

Name string  |  名称匹配

Filter.Name

按基础模型名称模糊匹配。

Names string[]  |  名称列表

Filter.Names

按基础模型名称列表精准匹配。

SupportedCustomizationTypes string[]  |  精调类型

Filter.SupportedCustomizationTypes

按基础模型支持的精调类型精准匹配。可指定值：Sft、Lora、ContinuePretrain、FinetuneSft、FinetuneLoRA、DPOLoRA、Pretrain。

PageNumber integer 默认值 1  |  起始页码

分页查询起始页码，从 1 开始。

PageSize integer 默认值 10  |  每页记录数

分页查询每页返回的记录数。

取值范围：[1, 100]

ProjectName string  |  项目名称

资源所属的项目名称，默认值为 default。

SortBy string 默认值 CreateTime  |  排序字段

排序字段。可指定值：

  • CreateTime：按创建时间排序
  • UpdateTime：按更新时间排序。
SortOrder string 默认值 Desc  |  排序方向

排序方向。可指定值：

  • Asc：升序排列
  • Desc：降序排列。
TagFilters object[]  |  标签筛选

基于绑定标签的筛选条件列表。

Key string 必选  |  键名

TagFilters.Key

用于筛选的标签键名。

Values string[]  |  取值列表

TagFilters.Values

用于筛选的标签值列表。

响应参数#

Items object[]  |  模型列表

当前页的基础模型列表。

CreateTime string  |  创建时间

Items.CreateTime

基础模型创建时间，RFC3339 格式。

Name string  |  模型名称

Items.Name

基础模型名称，全局唯一标识一个基础模型。

UpdateTime string  |  更新时间

Items.UpdateTime

基础模型最近更新时间，RFC3339 格式。

VendorName string  |  提供方

Items.VendorName

基础模型的提供方名称。

AccessType string  |  可见性

Items.AccessType

基础模型的可见性。可指定值：

  • Public：公开模型
  • Private：非公开模型
Description string  |  内部描述

Items.Description

基础模型的内部描述。

DisplayName string  |  展示名称

Items.DisplayName

控制台展示用的基础模型名称。

FeaturedImage object  |  展示图片

Items.FeaturedImage

基础模型在控制台上的展示图片，存储于 TOS。

BucketName string  |  存储桶名称

Items.FeaturedImage.BucketName

TOS 存储桶名称。当前火山方舟仅支持华北 2-北京地域（cn-beijing）的存储桶。

ObjectKey string  |  对象路径

Items.FeaturedImage.ObjectKey

TOS 对象的存储路径。

FoundationModelTag object  |  能力标签

Items.FoundationModelTag

基础模型的能力分类标签。

Domains string[]  |  能力领域

Items.FoundationModelTag.Domains

基础模型覆盖的能力领域列表。可指定值：

  • LLM：大语言模型
  • Audio：语音大模型
  • ComputerVision：视觉大模型
  • MultiModal：多模态
  • Embedding：向量模型
  • VLM：视觉语言模型
Languages string[]  |  支持语言

Items.FoundationModelTag.Languages

基础模型支持的自然语言列表。

TaskTypes string[]  |  支持任务类型

Items.FoundationModelTag.TaskTypes

基础模型支持的任务类型列表。可指定值：

  • TextGeneration：文本生成
  • VisualQuestionAnswering：图片内容理解
  • TextToImage：文生图
  • ImageToImage：图生图
  • TextToVideo：文生视频
  • ImageToVideo：图生视频
  • TextTo3D：文生 3D
  • ImageTo3D：图生 3D
  • VoiceClone：声音复刻
  • TextToSpeech：文本转语音
  • SpeechToText：语音转文本
  • SpeechToSpeech：同声传译
  • TextEmbedding：文本向量化
  • ImageEmbedding：图像向量化
  • MultimodalEmbedding：多模态向量化
UsedLibraries string[]  |  依赖库

Items.FoundationModelTag.UsedLibraries

基础模型依赖的库列表。

Introduction string  |  用户介绍

Items.Introduction

基础模型的介绍文本。由于返回值尺寸原因，本字段在 ListFoundationModels 接口中不返回。

PrimaryVersion string  |  主版本号

Items.PrimaryVersion

基础模型当前主推的版本号。

ProjectName string  |  所属项目

Items.ProjectName

基础模型所属的项目名称。

Tags object[]  |  自定义标签

Items.Tags

用户自定义绑定到基础模型的键值标签列表。

Key string  |  键名

Items.Tags.Key

标签的键名。

Value string  |  取值

Items.Tags.Value

标签的取值。

PageNumber integer  |  当前页码

当前返回的页码。

PageSize integer  |  每页记录数

当前返回的每页记录数。

TotalCount integer  |  总数

命中筛选条件的基础模型总数。