# 获取基础模型信息

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

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

获取基础模型详细信息。

> **说明：注意**
>
> 本接口仅返回基础模型自身的元数据，不包含具体版本配置；如需查询版本列表请使用 ListFoundationModelVersions。

## 鉴权

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

* Access Key 鉴权，请在 [Access Key 管理](https://console.volcengine.com/iam/keymanage) 页面，获取 Access Key。本接口仅支持 Access Key 鉴权。

---

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

### Body 参数

**Name** `string` `必选` | 基础模型名称

待查询的基础模型名称，作为唯一标识。

## 响应参数

**AccessType** `string` | 可见性

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

- `Public`：公开模型，所有租户可访问。
- `Private`：非公开模型，仅授权租户可访问。

**CreateTime** `string` | 创建时间

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

**Description** `string` | 内部描述

基础模型的内部描述，面向运营和管理场景。

**DisplayDescription** `string` | 展示描述

控制台展示用的简介描述。

**DisplayName** `string` | 展示名称

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

**FeaturedImage** `object` | 展示图片

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

**BucketName** `string` | 存储桶名称

`FeaturedImage.BucketName`

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

**ObjectKey** `string` | 对象路径

`FeaturedImage.ObjectKey`

TOS 对象的存储路径。

**FoundationModelTag** `object` | 能力标签

基础模型的能力分类标签，包含语言、任务类型、领域等维度。

**Domains** `string[]` | 能力领域

`FoundationModelTag.Domains`

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

- `LLM`：大语言模型
- `Audio`：语音大模型
- `ComputerVision`：视觉大模型
- `MultiModal`：多模态
- `Embedding`：向量模型
- `VLM`：视觉语言模型

**Languages** `string[]` | 支持语言

`FoundationModelTag.Languages`

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

**TaskTypes** `string[]` | 支持任务类型

`FoundationModelTag.TaskTypes`

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

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

**UsedLibraries** `string[]` | 依赖库

`FoundationModelTag.UsedLibraries`

基础模型依赖的库列表。

**Introduction** `string` | 用户介绍

面向用户展示的基础模型介绍文本。

**Name** `string` | 模型名称

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

**PrimaryVersion** `string` | 主版本号

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

**ProjectName** `string` | 所属项目

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

**RegionWhiteList** `string[]` | 可用地域

基础模型可用的地域白名单列表。

**ResourceOrigin** `string` | 资源来源

基础模型资源的来源标识。

**ShortName** `string` | 简短名称

基础模型的简短名称，用于紧凑展示。

**Tags** `object[]` | 自定义标签

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

**Key** `string` | 键名

`Tags.Key`

标签的键名。

**Value** `string` | 取值

`Tags.Value`

标签的取值。

**UpdateTime** `string` | 更新时间

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

**VendorName** `string` | 提供方

基础模型的提供方名称。


## 代码示例

## 默认

### cURL

#### Request

```bash
curl 'https://ark.cn-beijing.volcengineapi.com/?Action=GetFoundationModel&Version=2024-01-01' \
  -H 'Content-Type: application/json' \
  -H 'X-Date: <X-Date>' \
  -H 'X-Content-Sha256: <X-Content-Sha256>' \
  -H 'Authorization: HMAC-SHA256 Credential=<AK>/<X-Date>/cn-beijing/ark/request, SignedHeaders=content-type;host;x-content-sha256;x-date, Signature=<Signature>' \
  -d '{
  "Name": "doubao-seed-2-0-pro"
}
'
```

#### Response

```
{
  "ResponseMetadata": {
    "RequestId": "20240514205945172013199191467134",
    "Action": "GetFoundationModel",
    "Version": "2024-01-01",
    "Service": "ark",
    "Region": "cn-beijing"
  },
  "Result": {
    "Name": "doubao-seed-2-0-pro",
    "Description": "一条样例描述",
    "Introduction": "一条模型介绍",
    "VendorName": "字节跳动",
    "DisplayName": "Doubao-Seed-2.0-pro",
    "FeaturedImage": {
      "ObjectKey": "images/models/doubao-seed-2-0-pro.png",
      "BucketName": "ark-model-assets-cn-beijing"
    },
    "PrimaryVersion": "260215",
    "AccessType": "Public",
    "FoundationModelTag": {
      "Languages": [
        "zh",
        "en"
      ],
      "TaskTypes": [
        "TextGeneration"
      ],
      "Domains": [
        "LLM"
      ],
      "UsedLibraries": [
        "PyTorch",
        "Transformers"
      ]
    },
    "Tags": [
      {
        "Key": "owner",
        "Value": "team-a"
      }
    ],
    "ProjectName": "default",
    "CreateTime": "2024-04-01T11:54:41Z",
    "UpdateTime": "2024-05-14T20:59:45Z"
  }
}
```