API参考
API参考
  1. 开发平台
  • 文档说明
  • 鉴权方式说明
  • 模型(Models)
    • 列出模型
      • 原生OpenAI格式
      • 原生Gemini格式
  • 聊天(Chat)
    • OpenAI端点
      • ChatCompletions格式
      • Responses格式 (新一代)
    • Google端点
      • Gemini文本聊天
      • Gemini媒体识别
    • Anthropic端点
      • 原生Claude格式
  • 图像(Images)
    • 原生OpenAI格式
      • 生成图像
      • 编辑图像
    • 通义千问格式
      • 生成图像
      • 编辑图像
    • Nano Banana
      • OpenAI聊天格式
      • Gemini原生格式
    • 自有协议V1生图
      • 提交生图任务
      • 查询生图任务
  • 视频(Videos)
    • 火山引擎端点
      • 真人认证
        • 创建真人认证会话
        • 查询真人认证结果 / 领取 GroupId
      • 素材库接口
        • 创建素材
        • 查询素材
        • 创建素材组
        • 查询素材组
        • 素材组列表
        • 素材列表
        • 删除素材
        • 删除素材组
      • 创建视频生成任务。
      • 查询视频生成任务状态与结果。
    • 自有协议生视频V1
      • 自定义音色(TK)
        • 创建 Kling 自定义音色
        • 查询自定义音色任务
      • 提交生视频任务
      • 查询生视频任务
  • 嵌入(Embeddings)
    • 原生OpenAI格式
      POST
    • 原生Gemini格式
      POST
  • 补全(Completions)
    • 原生OpenAI格式
      POST
  • 音频(Audio)
    • 原生OpenAI格式
      • 音频转录
      • 音频翻译
      • 文本转语音
    • 讯飞音频转文字
      • URL 音频异步转写
      • 文件流异步转写
      • 查询转写结果
    • 原生Gemini格式
      POST
  • 实时语音(Realtime)
    • 原生OpenAI格式
  • 重排序(Rerank)
    • 文档重排序
  • 审查(Moderations)
    • 原生OpenAI格式
  • 火山引擎
  • 开发平台
    • 鉴权方式说明
    • 凭证管理
      • 查询凭证列表
      • 生成/重新生成凭证
      • console登录
    • 账单明细
      • 账单明细分页
      • 账单明细导出
      • 单笔明细复算
    • 账单统计
      • 汇总概览
      • 统计明细导出
      • 统计明细单笔复算
      • 统计明细分页
      • 按维度分组
      • 按模型排行
      • 时序趋势
  • 数据模型
    • Schemas
      • User
      • Log
      • Model
      • Token
      • PageInfo
      • Channel
      • Redemption
      • ApiResponse
      • ModelsResponse
      • Message
      • MessageContent
      • Tool
      • ToolCall
      • GeminiModelsResponse
      • ChatCompletionResponse
      • ChatCompletionRequest
      • ChatCompletionStreamResponse
      • CompletionRequest
      • CompletionResponse
      • ResponseFormat
      • ResponsesRequest
      • ResponsesResponse
      • ResponsesStreamResponse
      • ClaudeRequest
      • ClaudeMessage
      • ClaudeResponse
      • EmbeddingRequest
      • EmbeddingResponse
      • ImageGenerationRequest
      • ImageEditRequest
      • ImageResponse
      • AudioTranscriptionRequest
      • AudioTranslationRequest
      • AudioTranscriptionResponse
      • SpeechRequest
      • RerankRequest
      • RerankResponse
      • VideoRequest
      • ModerationRequest
      • VideoResponse
      • ModerationResponse
      • VideoTaskResponse
      • GeminiRequest
      • VideoTaskMetadata
      • VideoTaskError
      • GeminiResponse
      • OpenAIVideo
      • OpenAIVideoError
    • Schemas
      • ApiResponse
      • PageInfo
      • User
      • Channel
      • Token
      • Redemption
      • Log
    • key
    • CreateVideoTaskRequest
    • ResponseEntityTencentTkCustomVoiceOrderResponse
    • OpenAiImageDataItem
    • ResponseEntityTencentTkCustomVoiceTaskQueryResponse
    • ResponseEntityArkCreateContentsGenerationsTasksResponse
    • ConfirmAigcEventsRequest
    • AigcEventOutputFileDto
    • CreateVisualValidateSessionRequest
    • ResponseEntity?
    • ResponseEntityTkVideoOrderResponse
    • GptprotoMessageDto
    • TableDataInfo
    • IflyUrlProcessRequest
    • ResponseEntityTkCustomVoiceOrderResponse
    • ResponseEntityTkCustomVoiceTaskQueryResponse
    • ArkContentsGenerationsTaskError
    • GeminiContentPartDto
    • ModelMap
    • VideoContentPart
    • ChatInputAudioDto
    • TencentTkCustomVoiceOrderRequest
    • OpenAiImageUsageTokenDetails
    • AigcTaskDetailDto
    • AigcEventItemDto
    • CreateVisualValidateSessionResponse
    • TkVideoFileInfo
    • ResponseEntityTkVideoTaskQueryResponse
    • AjaxResult
    • IflyAudioMeta
    • TkCustomVoiceOrderRequest
    • ArkContentsGenerationsTaskContent
    • GeminiContentDto
    • MediaUrl
    • ChatPartDto
    • OpenAiImageUsage
    • GoogleGeminiPartDto
    • GetVisualValidateResultRequest
    • TkVideoSubjectInfo
    • GptprotoImageGenerateRequest
    • ManageAiModelSaveRequest
    • IflyProperty
    • ArkContentsGenerationsTaskUsage
    • key
    • CreateVideoTaskResponse
    • ChatFunctionCallDto
    • TencentTkVoiceRef
    • ResponseEntityOpenAiImagesResponse
    • ArkVideoTool
    • GoogleGeminiContentDto
    • GetVisualValidateResultResponse
    • TkVoiceRef
    • ManageAiSupplierSaveRequest
    • IflyFileProcessRequest
    • ResponseEntityArkGetContentsGenerationsTaskResponse
    • GetVideoTaskResponse
    • ChatToolCallDto
    • GptprotoViduPredictionResponse
    • OpenAiImageInputReference
    • TkVideoOrderRequest
    • OpenAiImageGenerationRequest
    • GptprotoChatRequest
    • ManageWalletRechargeRequest
    • GoogleGeminiEmbedContentRequest
    • IflyResultQueryRequest
    • TencentTkVideoOutputConfigDto
    • TencentTkVideoSubjectInfo
    • AiVideoOrderResponse
    • AigcVideoTaskInputFileInfoDto
    • AigcVideoOutputConfigDto
    • AiVideoOrderRequest
    • OutputItem
    • GeminiUsageMetadataDto
    • GeminiCandidateDto
    • GeminiGenerateContentResponse
    • GeminiThinkingConfigDto
    • HttpStatusCode
    • CreateAigcImageResponse
    • AigcImageTaskInputFileInfoDto
    • AigcImageOutputConfigDto
    • CreateAigcImageRequest
    • TaskContent
    • CreateAssetRequest
    • CitationItem
    • ContentBlock
    • ServerToolUse
    • Usage
    • ClaudeWebSearchResponse
    • MessageItem
    • UserLocation
    • WebSearchToolItem
    • ClaudeWebSearchRequest
    • ChatMessageDto
    • CreateAigcApiTokenResponse
    • CreateAigcApiTokenRequest
    • ClaudeFileAnalysisResponse
    • CacheControl
    • DocumentSourceWrapper
    • ErrorResponse
    • CitationsConfig
    • ContentBlock
    • ClaudeFileAnalysisRequest
    • Container
    • ClaudeTextToTextResponse
    • ToolItem
    • ClaudeTextToTextRequest
    • ArkMediaUrl
    • ArkVideoContentPart
    • ArkCreateContentsGenerationsTasksRequest
    • PredictionData
    • GptprotoViduImageToVideoRequest
    • OpenAiImageEditRequest
    • GoogleGeminiInlineBlobDto
    • GoogleGeminiFileDataDto
    • GoogleGeminiGenerationConfigDto
    • GoogleGeminiGenerateContentRequest
    • DescribeTaskDetailResponse
    • DescribeTaskDetailRequest
    • PullAigcEventsResponse
    • GoogleGeminiFunctionCallDto
    • GoogleGeminiFunctionResponseDto
    • GoogleGeminiExecutableCodeDto
    • GoogleGeminiCodeExecutionResultDto
    • GoogleGeminiFunctionCallingConfigDto
    • GoogleGeminiLatLngDto
    • GoogleGeminiRetrievalConfigDto
    • GoogleGeminiToolConfigDto
    • GoogleGeminiThinkingConfigDto
    • CreateAssetResponse
    • GoogleGeminiSafetySettingDto
    • AiImageOrderResponse
    • AiImageOrderRequest
    • GptprotoChoiceDto
    • GptprotoUsageDto
    • GptprotoChatResponse
    • CacheControlEphemeral
    • JsonSchemaFormat
    • OutputConfig
    • ToolChoice
    • ImageDataItem
    • AiTextOrderResponse
    • GptprotoImageGenerateResponse
    • MapObject
    • MessageParam
    • AiTextOrderRequest
    • Metadata
    • ThinkingConfig
    • InputSchema
    • CitationsConfigParam
    • ToolDefinition
    • ManageAiModelPriceSaveRequest
    • AnthropicMessagesCreateRequest
    • IflyPlatformSubmitResponse
    • GatewayErrorResponse
    • CreateAigcVideoResponse
    • CreateAigcVideoRequest
    • MapString
    • ResponseEntityTencentTkVideoOrderResponse
    • TencentTkVideoFileInfo
    • TencentTkVideoOrderRequest
    • ResponseEntityTencentTkVideoTaskQueryResponse
    • GeminiGenerationConfigDto
    • TaskUsage
    • CreateContentsGenerationsAssetRequest
    • GetAssetRequest
    • ManageAiModelVendorSaveRequest
    • IflyPlatformQueryResponse
    • GeminiGenerateContentRequest
    • TaskError
    • VolcengineGetAssetRequest
    • GoogleGeminiSystemInstructionDto
    • GetAssetResponse
    • ContentBlockParam
    • ManageAiCustomerTokenSaveRequest
    • IflyTaskResultData
    • key
    • CreateAssetGroupRequest
    • StringOrContentBlocks
    • ManageAiModelSupplierRouteSaveRequest
    • IflyAsrcSegment
    • IdRequest
    • key
    • ListQueryRequest
    • key
    • AssetGroupResponse
    • ResponseEntityStreamingResponseBody
    • TextCitationParam
    • AssetItem
    • TextBlockParam
    • key
    • ListAssetGroupsResponse
    • StringOrTextBlocks
    • ListAssetsResponse
    • ArkErrorEnvelope
    • ResponseEntityTencentTkImageOrderResponse
    • GoogleGeminiCodeExecutionToolDto
    • TencentTkImageFileInfo
    • MapJsonNode
    • TencentTkImageOrderRequest
    • GoogleGeminiToolDto
    • ResponseEntityTencentTkImageTaskQueryResponse
    • VolcengineMediaUrl
    • VolcengineVideoContentPart
    • VolcengineVideoTool
    • VolcengineCreateVideoTaskRequest
    • ConversationModelOption
    • ConversationSessionItem
    • ConversationMessageItem
    • ConversationSendRequest
    • Handler
    • MediaType
    • DataWithMediaType
    • Throwable
    • StackTraceElement
    • Runnable
    • DefaultCallback
    • ErrorCallback
    • SseEmitter
    • ConversationImageOrderRequest
    • ConversationVideoOrderRequest
    • CitationItem
    • Usage
    • MessageItem
    • key
    • key
    • CitationItem
    • ContentBlock
    • Usage
    • ContentBlock
    • MessageItem
    • GoogleGeminiGenerateContentPayloadDto
    • GoogleGeminiCountTokensRequest
    • GoogleGeminiCreateCachedContentRequest
    • GoogleGeminiPatchCachedContentRequest
    • AccountAiCustomerTokenCreateRequest
    • ResponseEntityMapObject
  1. 开发平台

鉴权方式说明

TokenProto 开放平台(账单)鉴权说明#

1. 服务与路径前缀#

项说明
完整调用示例https://{console-host}/api/account/order/list
鉴权范围开放平台账单类接口统一走 开放平台凭证 或 控制台 JWT 鉴权
适用接口/api/account/bill/stats/*、/api/account/order/*
开放平台接口与 Gateway 模型调用接口(/v1/*,API Key 鉴权)完全独立,凭证不互通。

2. 认证方式(二选一)#

开放平台支持两种鉴权方式,二者取其一即可,均解析为同一 sys_user,权限判定一致。

方式 A:开放平台凭证(x-user-code + x-user-token)#

两个请求头 必须同时携带,缺一不可。
在控制台登录后,于 账单明细 或 账单统计 页「开放平台凭证」卡片中生成。
Code 与 Token 各 32 位(数字 + 大小写字母)。

方式 B:控制台 JWT#

与网页登录态相同,适合控制台前端内部调用或调试。
以 Bearer 开头,后跟 JWT 明文。

解析优先级#

若同时携带 凭证头与 JWT,优先使用凭证头(x-user-code + x-user-token)。

3. 凭证与平台用户#

凭证(x-user-code / x-user-token)解析到生成它的 控制台用户(sys_user)。
接口仅返回 该用户自己的账单数据,凭证 不提升权限。
若该用户角色未分配账单菜单权限(account:bill:order:query / account:bill:stats:query),即使凭证有效也会收到 403。
重新生成凭证后,旧凭证 立即失效。

4. 未授权与禁止访问响应#

401(凭证无效或过期)#

{
  "code": 401,
  "msg": "凭证无效或已过期"
}
HTTP 状态码场景
401未携带 x-user-code / x-user-token 或 JWT
401凭证已被重新生成(旧凭证失效)
401JWT 过期

403(角色无权限)#

{
  "code": 403,
  "msg": "当前用户无该接口权限"
}
HTTP 状态码场景
403用户角色未分配对应账单菜单权限(account:bill:*)

5. 凭证生成(仅控制台登录态)#

凭证 不对接方开放生成接口,请在控制台生成:
1.
登录用户控制台
2.
进入 账单明细 或 账单统计 页面
3.
展开顶部 开放平台凭证 卡片
4.
点击 生成凭证 或 重新生成
后端接口(仅 JWT 可调用,不对接方开放):
方法路径说明
GET/api/account/token查询当前用户凭证列表
POST/api/account/token/generate首次生成或重新生成

6. curl 示例#

凭证方式#

JWT 方式#


7. 安全建议#

凭证等同于账号密码片段,勿 提交到公开仓库或前端代码
泄露后立即在控制台 重新生成,旧凭证即时失效
凭证仅用于账单只读查询,不具备 模型调用能力

8. 与 Gateway 鉴权的区别#

项开放平台凭证Gateway API Key
用途查询账单(console 后台)调用 AI 模型 /v1/*
请求头x-user-code + x-user-tokenAuthorization: Bearer 或 x-api-key
管理入口控制台账单页「开放平台凭证」模型 → API Key
权限角色菜单 account:bill:*模型调用配额/分组
数据范围仅当前用户自己的账单按租户/分组配额
修改于 2026-07-21 02:59:12
上一页
原生OpenAI格式
下一页
查询凭证列表
Built with