调用 GetMediaEntity 接口根据查询条件(视频 ID、实体类型等)获取某个 AI 生成媒资实体的详细信息。
该接口能够直接返回实体的核心语义数据(以 JSON 字符串形式封装在 EntityBaseRawInfo 等字段中),以及其实体文件(如音频、字幕)的公网访问地址,为大模型应用和二次开发提供即时可用的结构化数据和媒资文件。
请求地址:https://vod.volcengineapi.com?Action=GetMediaEntity&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | GetMediaEntity | 接口名称。当前 API 的名称为 GetMediaEntity。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01。 |
Vid | String | 是 | v0dc24g10***s1v0ipljnh4h0 | 视频 ID。音视频上传后,获取的方式如下所示。
|
EntityType | String | 是 | ocr | 实体类型。指定要查询的实体具体类型,支持的取值如下:
|
EntityVersion | String | 是 | default | 实体标识。当前仅支持 default。 |
NeedPublicUrl | Boolean | 否 | true | 是否返回公网访问地址。
|
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
PublicUrlInfo | Object | - | 媒资实体的公网访问地址信息。仅当请求参数 NeedPublicUrl 为 true 时返回。 |
CdnUrl | String | https://cdn.example.com/subtitle.srt?auth_key=... | |
OriginUrl | String | https://tos.example.com/bucket/subtitle.srt?auth_key=... | 存储地址。访问存储地址会产生存储流出费用。 |
BaseEntityInfo | Object | - | 基础通用的媒资实体结构 |
Id | String | entity-12345 | 实体的唯一标识 ID。 |
Vid | String | v0c2dfg7007***eq0bnog65linio2jvg | 所属视频 ID。 |
Source | String | translation | 实体的来源。 |
FileName | String | subtitle.srt | 实体的文件路径。 |
StoreUri | String | tos-boe-v-febf3a/subtitle.srt | 实体在对象存储中的 URI。 |
CreatedAt | String | 2025-11-21T02:00:00Z | 创建时间,UTC 格式。 |
SpaceName | String | vod-test | 所属空间名称。 |
UpdatedAt | String | 2025-11-21T02:00:00Z | 更新时间,UTC 格式。 |
EntityType | String | ocr | 实体类型。 |
EntityVersion | String | default | 实体标识。 |
EntityBaseRawInfo | String | {"vid":"v0c2dfg***7ad5eq0bnog65linio2jvg","entity_type":"ocr","entity_version":"default","space_name":"vod-test","store_uri":"tos-boe-v-febf3a/subtitle.srt","file_name":"subtitle.srt","source":"translation","created_at":1767928529,"updated_at":1767928529} | 基础语义数据的 JSON 字符串。该字段是对实体核心属性(如 vid, file_name, store_uri 等)的序列化封装。您将其反序列化后,可得到一个与外层 BaseEntityInfo 结构基本一致的对象,可用于直接投喂给大模型或下游分析系统。 |
EntityExtraRawInfo | String | {} | 扩展语义数据的 JSON 字符串。包含特定实体类型独有的补充信息。 |
https://vod.volcengineapi.com?Action=GetMediaEntity&Version=2023-07-01&Vid=v0dc24g10***s1v0ipljnh4h0&EntityType=ocr&EntityVersion=default&NeedPublicUrl=true
{ "Result": { "PublicUrlInfo": { "CdnUrl": "https://cdn.example.com/subtitle.srt?auth_key=...", "OriginUrl": "https://tos.example.com/bucket/subtitle.srt?auth_key=..." }, "BaseEntityInfo": { "Id": "entity-12345", "Vid": "v0c2dfg7007***eq0bnog65linio2jvg", "Source": "translation", "FileName": "subtitle.srt", "StoreUri": "tos-boe-v-febf3a/subtitle.srt", "CreatedAt": "2025-11-21T02:00:00Z", "SpaceName": "vod-test", "UpdatedAt": "2025-11-21T02:00:00Z", "EntityType": "ocr", "EntityVersion": "default", "EntityBaseRawInfo": "{\"vid\":\"v0c2dfg***7ad5eq0bnog65linio2jvg\",\"entity_type\":\"ocr\",\"entity_version\":\"default\",\"space_name\":\"vod-test\",\"store_uri\":\"tos-boe-v-febf3a/subtitle.srt\",\"file_name\":\"subtitle.srt\",\"source\":\"translation\",\"created_at\":1767928529,\"updated_at\":1767928529}" }, "EntityExtraRawInfo": "{}" }, "ResponseMetadata": { "Action": "GetMediaEntity", "Region": "cn-north-1", "Service": "vod", "Version": "2023-07-01", "RequestId": "20230604110420****100232280022D31" } }
本接口无特有的错误码。更多信息请见公共错误码。