数据模型

ErrorDetail

{
  "detail": null
}

属性

名称	类型	必选	约束	中文名	说明
detail	any	false	none		错误详情（字符串或对象）

ChatCompletionMessage

{
  "role": "system",
  "content": "string",
  "name": "string"
}

属性

名称	类型	必选	约束	说明
role	string	true	none	消息角色
content	string	true	none	消息内容
name	string	false	none	none

枚举值

属性	值
role	system
role	user
role	assistant

ChatCompletionRequest

{
  "model": "gpt-4",
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "stream": false,
  "temperature": 0.7,
  "max_tokens": 1024
}

属性

名称	类型	必选	约束	说明
model	string	true	none	模型 slug
messages	[ChatCompletionMessage]	true	none	none
temperature	number(float)	false	none	none
max_tokens	integer	false	none	none
stream	boolean	false	none	是否 SSE 流式
top_p	number	false	none	none
frequency_penalty	number	false	none	none
presence_penalty	number	false	none	none
stop	any	false	none	停止序列

oneOf

名称	类型	必选	约束	中文名	说明
» anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
» anonymous	[string]	false	none		none

continued

名称	类型	必选	约束	中文名	说明
n	integer	false	none		none

OpenAIChatCompletionResponse

{
  "id": "string",
  "object": "chat.completion",
  "created": 0,
  "model": "string",
  "choices": [
    {}
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0
  }
}

OpenAI Chat Completions 标准响应

属性

名称	类型	必选	约束	说明
id	string	false	none	none
object	string	false	none	none
created	integer	false	none	none
model	string	false	none	none
choices	[object]	false	none	none
usage	object	false	none	none
» prompt_tokens	integer	false	none	none
» completion_tokens	integer	false	none	none
» total_tokens	integer	false	none	none

ClaudeMessageRequest

{
  "model": "claude-3-5-sonnet-20241022",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Hello!"
    }
  ],
  "stream": false
}

属性

名称	类型	必选	约束	说明
model	string	true	none	none
max_tokens	integer	true	none	none
messages	[object]	true	none	Anthropic 消息数组
system	string	false	none	none
temperature	number	false	none	none
stream	boolean	false	none	none

GeminiGenerateContentRequest

{
  "contents": [
    {
      "role": "user",
      "parts": [
        {
          "text": "Hello!"
        }
      ]
    }
  ]
}

Gemini generateContent 请求体（支持额外字段）

属性

名称	类型	必选	约束	说明
contents	[object]	false	none	none
generationConfig	object	false	none	none
stream	boolean	false	none	none

EmbeddingRequest

{
  "model": "text-embedding-3-small",
  "input": "The food was delicious."
}

属性

名称	类型	必选	约束	说明
model	string	true	none	none
input	any	true	none	string 或 string 数组
encoding_format	string	false	none	none
dimensions	integer	false	none	none
user	string	false	none	none

ImageGenerationRequest

{
  "model": "dall-e-3",
  "prompt": "A cute cat on grass",
  "n": 1,
  "size": "1024x1024"
}

属性

名称	类型	必选	约束	说明
model	string	true	none	none
prompt	string	true	none	none
n	integer	false	none	none
size	string	false	none	none
quality	string	false	none	none
response_format	string	false	none	none
style	string	false	none	none
user	string	false	none	none

VideoGenerationRequest

{
  "model": "doubao-seedance-2-0-fast-260128",
  "prompt": "一只猫在草地上奔跑",
  "duration": 5
}

属性

名称	类型	必选	约束	说明
model	string	true	none	模型 slug，如 doubao-seedance-2-0-fast-260128
prompt	string	false	none	文本提示词（文生视频）
image	string	false	none	参考图 URL 或 base64（图生视频，视上游支持）
duration	integer	false	none	视频时长（秒），默认 5，影响预扣费
width	integer	false	none	none
height	integer	false	none	none
metadata	object	false	none	上游扩展参数（透传）

VideoGenerationCreateResponse

{
  "task_id": "string",
  "status": "queued",
  "_gateway": {}
}

属性

名称	类型	必选	约束	说明
task_id	string	false	none	none
status	string	false	none	none
_gateway	object	false	none	网关附加字段：request_id、cost、latency_ms

枚举值

属性	值
status	queued
status	in_progress
status	completed
status	failed

VideoGenerationTaskResponse

{
  "task_id": "string",
  "status": "queued",
  "video_url": "string",
  "error": {}
}

属性

名称	类型	必选	约束	说明
task_id	string	false	none	none
status	string	false	none	none
video_url	string	false	none	完成后的视频地址（字段名因上游而异）
error	object	false	none	none

枚举值

属性	值
status	queued
status	in_progress
status	completed
status	failed

SeedanceVideoTaskRequest

{
  "model": "doubao-seedance-2-0-fast-260128",
  "content": [
    {
      "type": "text",
      "text": "一只猫在草地上奔跑"
    }
  ],
  "duration": 5,
  "ratio": "16:9",
  "resolution": "720p"
}

属性

名称	类型	必选	约束	说明
model	string	true	none	Seedance 2.0 模型 ID
content	[object]	false	none	内容数组，如 [{"type":"text","text":"..."}] 或图片项
duration	integer	false	none	视频时长 4–15 秒
ratio	string	false	none	画幅比例，如 16:9
resolution	string	false	none	分辨率，如 720p、1080p
generate_audio	boolean	false	none	是否生成配套音频

枚举值

属性	值
model	doubao-seedance-2-0-260128
model	doubao-seedance-2-0-fast-260128

SeedanceVideoTaskResponse

{
  "id": "string",
  "status": "queued",
  "content": {
    "video_url": "string"
  },
  "error": {},
  "_gateway": {}
}

属性

名称	类型	必选	约束	说明
id	string	false	none	任务 ID
status	string	false	none	none
content	object	false	none	none
» video_url	string	false	none	none
error	object	false	none	none
_gateway	object	false	none	创建响应附加：request_id、cost、latency_ms

枚举值

属性	值
status	queued
status	running
status	succeeded
status	failed

On this page