POST https://ark.cn-beijing.volcengineapi.com/?Action=CreateEndpoint&Version=2024-01-01
创建一个推理接入点(Endpoint),用于调用模型服务。接入点是调用模型的入口资源,绑定模型后即可通过接入点 ID 发起推理请求。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。
请求参数#
Body 参数#
ModelReference object 必选 | 接入模型配置
接入点接入的模型引用。二选一指定:基础模型(FoundationModel)或定制模型(CustomModelId)。
CustomModelId string | 定制模型 ID
ModelReference.CustomModelId
定制模型 ID,以 cm- 开头,与 FoundationModel 二选一。
FoundationModel object | 基础模型引用
ModelReference.FoundationModel
基础模型引用,与 CustomModelId 二选一。指定基础模型时必填该字段。
ModelVersion string 必选 | 基础模型版本
ModelReference.FoundationModel.ModelVersion
基础模型版本号,可通过 ListFoundationModels 接口查询。
Name string 必选 | 基础模型名称
ModelReference.FoundationModel.Name
基础模型名称,可通过 ListFoundationModels 接口查询。
ConfigurationId string | 模型配置 ID
ModelReference.FoundationModel.ConfigurationId
模型配置 ID。默认为空,使用模型默认配置。
Name string 必选 | 接入点名称
接入点名称,用于在控制台与列表接口中标识该接入点。建议在名称中体现模型与用途,便于识别。
AllowDataCollected boolean | 允许数据采集
是否允许采集调用数据用于模型训练或数据回流
BatchOnly boolean 默认值 false | 仅批量推理
是否为批量推理。取值 true 表示接入点为批量推理 ep;false 表示实时推理。
ContentGeneration object | 生图/生视频配置
生图 / 生视频模型的特化配置,用于设置并发与每分钟任务数上限。
AudioConcurrentRequests integer | 音频并发请求数
ContentGeneration.AudioConcurrentRequests
AudioRpm integer | 音频请求 RPM 限流
ContentGeneration.AudioRpm
ConcurrentRequests number | 并发请求数
ContentGeneration.ConcurrentRequests
ConcurrentRequestsFor4K integer | 4K 并发请求数
ContentGeneration.ConcurrentRequestsFor4K
CreateTaskRpm number | 每分钟任务数
ContentGeneration.CreateTaskRpm
CreateTaskRpmFor4K integer | 4K 每分钟任务数
ContentGeneration.CreateTaskRpmFor4K
DataDelivery boolean 默认值 false | 数据回流
是否开启推理数据回流。取值 true 表示开启,接入点的请求与响应可被回流用于数据采集;false 表示关闭。
DedicatedToPTU boolean 默认值 false | 独占模型单元
是否将该接入点专用于绑定的模型单元(PTU)。取值 true 表示接入点流量将独占绑定的模型单元;false 表示接入点与模型单元非独占。
Description string | 接入点描述
接入点的描述信息,便于在控制台或列表中区分用途。默认为空。
DryRun boolean 默认值 false | 预检模式
是否仅进行预检。取值 true 表示仅校验请求合法性,不实际创建接入点;false 表示正式执行创建。
InferenceDefaultParam object | 推理默认参数
Detail object | 细节参数
InferenceDefaultParam.Detail
Value string | 值
InferenceDefaultParam.Detail.Value
ReasoningEffort object | 推理努力程度
InferenceDefaultParam.ReasoningEffort
Value string | 值
InferenceDefaultParam.ReasoningEffort.Value
ServiceTier object | 服务档位
InferenceDefaultParam.ServiceTier
Value string | 值
InferenceDefaultParam.ServiceTier.Value
ThinkingConfig object | 深度思考配置
InferenceDefaultParam.ThinkingConfig
IsSupported boolean | 是否支持
InferenceDefaultParam.ThinkingConfig.IsSupported
Value string | 值
InferenceDefaultParam.ThinkingConfig.Value
IntelligentRouter object | 智能路由
智能路由配置,用于在多个候选模型间按策略分发请求
Mode string 必选 | 路由模式
IntelligentRouter.Mode
路由模式。取值 Automatic(自动)、CandidateSet(候选集合)、Ordered(按顺序)
Strategy string 必选 | 路由策略
IntelligentRouter.Strategy
路由策略。取值 EffectFirst(效果优先)、CostFirst(成本优先)、Balanced(均衡)
BaselineModel object | 基准模型
IntelligentRouter.BaselineModel
CustomModelId string | 定制模型 ID
IntelligentRouter.BaselineModel.CustomModelId
定制模型 ID,以 cm- 开头,与 FoundationModel 二选一。
FoundationModel object | 基础模型引用
IntelligentRouter.BaselineModel.FoundationModel
基础模型引用,与 CustomModelId 二选一。指定基础模型时必填该字段。
ModelVersion string 必选 | 基础模型版本
IntelligentRouter.BaselineModel.FoundationModel.ModelVersion
基础模型版本号,可通过 ListFoundationModels 接口查询。
Name string 必选 | 基础模型名称
IntelligentRouter.BaselineModel.FoundationModel.Name
基础模型名称,可通过 ListFoundationModels 接口查询。
ConfigurationId string | 模型配置 ID
IntelligentRouter.BaselineModel.FoundationModel.ConfigurationId
模型配置 ID。默认为空,使用模型默认配置。
CandidateModels object[] | 候选模型列表。
IntelligentRouter.CandidateModels
CustomModelId string | 定制模型 ID
IntelligentRouter.CandidateModels.CustomModelId
定制模型 ID,以 cm- 开头,与 FoundationModel 二选一。
FoundationModel object | 基础模型引用
IntelligentRouter.CandidateModels.FoundationModel
基础模型引用,与 CustomModelId 二选一。指定基础模型时必填该字段。
ModelVersion string 必选 | 基础模型版本
IntelligentRouter.CandidateModels.FoundationModel.ModelVersion
基础模型版本号,可通过 ListFoundationModels 接口查询。
Name string 必选 | 基础模型名称
IntelligentRouter.CandidateModels.FoundationModel.Name
基础模型名称,可通过 ListFoundationModels 接口查询。
ConfigurationId string | 模型配置 ID
IntelligentRouter.CandidateModels.FoundationModel.ConfigurationId
模型配置 ID。默认为空,使用模型默认配置。
IsIntelligent boolean | 启用智能路由
是否启用智能路由能力
Moderation object | 内容安全护栏
内容护栏方案。Strategy 必填;仅当 Strategy 为 Customized 时填写 CustomizedModerationInfos。
Strategy string 必选 | 内容安全护栏方案
Moderation.Strategy
内容安全护栏方案。取值:
Default(默认): 更低延迟,广泛覆盖内容安全通用需求Basic:基本方案(公测中)。支持在接口响应中提供命中的风险分类,暂时只包含严重违规和激进行为两类风险。Skip:跳过内容审核。Customized:自定义内容审核。
CustomizedModerationInfos object[] | 自定义审核配置
Moderation.CustomizedModerationInfos
AppID integer 必选 | 应用 ID
Moderation.CustomizedModerationInfos.AppID
BizType string 必选 | 业务类型
Moderation.CustomizedModerationInfos.BizType
RiskType string 必选 | 风险类型
Moderation.CustomizedModerationInfos.RiskType
Scene string 必选 | 审核场景
Moderation.CustomizedModerationInfos.Scene
NeedWatermark boolean | 启用水印
生成内容是否需要添加水印。启用后需同时填写 WatermarkInfo 提供水印主体信息
ProjectName string 默认值 default | 项目名称
资源所属的项目名称。若资源不在默认项目(default)中,需填写实际项目名称。
RateLimit object | 限流配置
接入点限流配置,为空时使用模型默认限流。其中 Rpm 与 Tpm 必填,Ipm 与 FastTpm 按需填写。
Rpm integer 必选 | 每分钟请求数
RateLimit.Rpm
每分钟请求数上限(Requests Per Minute)。
Tpm integer 必选 | 每分钟请求 token 数
RateLimit.Tpm
每分钟 token 数上限(Tokens Per Minute)。
FastTpm integer | 低延迟 TPM 限流
RateLimit.FastTpm
FlexTpm integer | Flex TPM 限流
RateLimit.FlexTpm
Ipm integer | 每分钟生成图片数
RateLimit.Ipm
每分钟生成图片数上限(Images Per Minute)。仅生图模型有效。
OffPeakFlexTpm integer | 闲时 Flex TPM 限流
RateLimit.OffPeakFlexTpm
Tags object[] | 标签列表
接入点绑定的标签列表,用于资源分类与检索。每个标签由 Key(必填)与 Value(可选)组成。
Key string 必选 | 标签键
Tags.Key
标签键,长度 1~64 字符。
Value string 必选 | 标签值
Tags.Value
标签值,长度不超过 256 字符。
UsageLimit object | 用量限制
Enabled boolean 必选 | 是否启用
UsageLimit.Enabled
Limit integer | 限制额度
UsageLimit.Limit
WatermarkInfo object | 水印主体信息
水印主体信息。当 NeedWatermark 为 true 时填写
SocialUnifiedCreditCode string 必选 | 统一社会信用代码。
WatermarkInfo.SocialUnifiedCreditCode
SubjectName string 必选 | 水印主体名称。
WatermarkInfo.SubjectName
IsContentDissemination number | 是否允许内容传播。
WatermarkInfo.IsContentDissemination
响应参数#
Id string | 接入点 ID
创建成功的推理接入点 ID,以 ep- 开头。可用于后续 GetEndpoint、UpdateEndpoint、DeleteEndpoint 等接口的 Id 入参。