文档中心
简体
文档
控制台
登录
免费开始使用
火山方舟
文档指南
订阅 [Agent/Coding Plan]
API参考
资源
火山方舟
火山方舟
API参考
请输入
准备工作
获取 API Key 并配置
安装及升级 SDK
Base URL及鉴权
对话(Chat) API
对话(Chat) API
Responses API
创建模型响应
查询模型响应
获取响应上下文
删除模型响应
The response object
流式响应
Files API
上传文件
检索文件
查询文件列表
删除文件
The file object
视频生成 API
创建视频生成任务 API
查询视频生成任务 API
查询视频生成任务列表
取消或删除视频生成任务
图片生成 API
图片生成 API
流式响应
3D生成 API
Seed3D API
创建3D生成任务 API
查询3D生成任务 API
查询3D生成任务列表
取消或删除3D生成任务
影眸 API
创建3D生成任务
查询3D生成任务
查询3D生成任务列表
取消或删除3D生成任务
数美 API
创建3D生成任务
查询3D生成任务
查询3D生成任务列表
取消或删除3D生成任务
向量化 API
向量化 API
上下文缓存 API
创建上下文缓存 API
上下文缓存对话 API
应用(Bot) API
应用(bot) API
联网插件 数据结构
知识库插件 数据结构
批量推理 API
批量(Job) API
CreateBatchInferenceJob - 创建批量推理任务
ListBatchInferenceJobs - 获取批量推理任务列表
GetBatchInferenceJob - 获取批量推理任务
UpdateBatchInferenceJob - 更新批量推理任务
DeleteBatchInferenceJob - 删除批量推理任务
StopBatchInferenceJob - 停止批量推理任务
ResumeBatchInferenceJob - 重启批量推理任务
批量(Chat) API
其他说明
兼容 OpenAI SDK
错误码
SDK 常见使用示例
分词 API
分词 API
Agent Plan / Coding Plan API
CreatePersonalPlan - 创建个人版套餐
RenewPersonalPlan - 续费个人版套餐
GetPersonalPlan - 查询个人版套餐
Agent Plan API
ListArkAgentPlanModel - 查询 Agent Plan 支持的模型列表
RegeneratePersonalApiKey - 轮换个人版 API Key
GetUsageDetails - 获取套餐用量详情
GetAFPUsage - 获取套餐 AFP 额度
Coding Plan API
ListArkCodingPlanModel - 查询 Coding Plan 支持的模型列表
管控面 API
管理推理接入点（Endpoint）
StartEndpoint - 开启推理接入点
StopEndpoint - 停止推理接入点
ListEndpoints - 获取推理接入点列表
GetEndpoint - 获取推理接入点
DeleteEndpoint - 删除推理接入点
UpdateEndpoint - 更新推理接入点
CreateEndpoint - 创建推理接入点
GetEndpointCertificate - 获取接入点推理应用层加密证书
InnerDescribeModelEndpoints - 查询模型预置接入点列表
管理API Key
GetApiKey - 获取临时API Key
管理模型调优任务
TerminateModelCustomizationJob - 停止模型调优任务
GetModelCustomizationJob - 获取模型调优任务信息
CreateModelCustomizationJob - 创建模型调优任务
ListModelCustomizationJobs - 获取模型调优任务列表
UpdateModelCustomizationJob - 更新模型调优任务
DeleteModelCustomizationJob - 删除模型调优任务
ResumeModelCustomizationJob - 重试模型调优任务
GetModelCustomizationJobMetricData - 查询精调效果指标详细数据
GetModelCustomizationJobMetrics - 查询精调效果指标
管理定制模型
DeleteCustomModel - 删除定制模型
GetCustomModel - 获取定制模型信息
UpdateCustomModel - 更新定制模型
ListCustomModels - 获取定制模型列表
管理基础模型
ListFoundationModelVersions - 获取基础模型版本列表
GetFoundationModelVersion - 获取基础模型版本信息
ListFoundationModels - 获取基础模型列表
GetFoundationModelVersionConfiguration - 获取基础模型版本配置信息(不推荐)
GetFoundationModel - 获取基础模型信息
管理模型评测任务
TerminateEvaluationJob - 停止评测任务
GetEvaluationJob - 获取评测任务
ListEvaluationJobs - 获取评测任务列表
CreateEvaluationJob - 创建评测任务
UpdateEvaluationJob - 更新评测任务
ListEvaluationResults - 获取评测任务结果列表
DeleteEvaluationJob - 删除评测任务
GetEvaluationResult - 获取评测任务结果
安全审计
ListAuditLogs - 获取安全审计日志
查询用量
GetUsage - 查询推理服务调用量（待弃用）
GetInferenceUsage - 查询推理用量
CreateRecordExportTask - 创建用量明细导出任务
GetRecordExportTask - 查询用量明细导出任务状态
效果上报
方舟 Seedance 2.0 Badcase 上报 API
文档首页
火山方舟
管控面 API
管理API Key
管控面 API
管理API Key
GetApiKey - 获取临时API Key
