StarMagicStarMagic
简体中文
简体中文简繁體中文繁EnglishEN日本語日EspañolES한국어KO
集成向导
Claude - Messages API
StarMagicStarMagic
简体中文
简体中文简繁體中文繁EnglishEN日本語日EspañolES한국어KO
文本系列ClaudeClaude

Claude - 完整参数文档

  • 发送包含文本或文本+图像内容的结构化输入消息列表,模型将生成对话中的下一条消息。
  • Messages API 可用于单次查询或无状态多轮对话。
<Note> **BaseURL 说明**:默认 BaseURL 为 `https://api.starmagic.ai`,对文本模型支持更好,支持长连接;`https://api.starmagic.ai` 是多模态主力地址,对文本模型作为备用地址使用。 </Note>

授权

Authorizationstringheader必填

##所有接口均需要使用Bearer Token进行认证## **获取 API Key:** 访问 [API Key 管理页面](https://starmagic.ai/app/api-keys) 获取您的 API Key **使用时在请求头中添加:** ``` Authorization: Bearer YOUR_API_KEY ```

Authorization: Bearer YOUR_API_KEY

请求体

application/json
modelenum<claude-haiku-4-5-20251001 | claude-sonnet-4-5-20250929 | claude-opus-4-1-20250805 | claude-sonnet-4-20250514 | claude-opus-4-5-20251101 | claude-opus-4-6 | claude-opus-4-8 | claude-opus-4-7 | claude-sonnet-4-6>必填

将完成你的提示的模型。

"claude-haiku-4-5-20251001"
messagesobject[]必填

输入消息。 可以处理交替的 `user` 和 `assistant` 对话回合。创建新的 `Message` 时,需要通过 `messages` 参数指定之前的对话回合,然后模型会生成对话中的下一条 `Message`。请求中连续的 `user` 或 `assistant` 回合将被合并为一个回合。 每条输入消息必须是一个包含 `role` 和 `content` 的对象。可以指定单个 `user` 角色消息,也可以包含多个 `user` 和 `assistant` 消息。

[
  {
    "content": null,
    "role": "user"
  }
]
max_tokensinteger必填

停止前生成的最大令牌数。 请注意,我们的模型可能会在达到此最大值之前停止。此参数仅指定要生成的绝对最大令牌数。

0
inference_geostring

指定推理处理的地理区域。如果未指定,将使用工作区的 `default_inference_geo`。

"string"
containerobject

跨请求重用的容器标识符。

context_managementobject

上下文管理配置。

mcp_serversobject[]

此请求中要使用的 MCP 服务器

[
  {
    "authorization_token": null,
    "name": "string",
    "tool_configuration": null,
    "type": "string",
    "url": "string"
  }
]
metadataobject
{
  "user_id": null
}
output_configobject
{
  "effort": "low",
  "format": {
    "schema": {},
    "type": "string"
  },
  "task_budget": {
    "remaining": 0,
    "total": 0,
    "type": "string"
  }
}
service_tierenum<auto | standard_only>

确定此请求是使用优先容量(如果可用)还是标准容量。

"auto"
stop_sequencesstring[]

会导致模型停止生成的自定义文本序列。

[
  "string"
]
streamboolean

是否使用服务器发送事件增量流式传输响应。

true
systemobject

系统提示。

temperaturenumber

注入响应中的随机性程度。 默认为 `1.0`。范围从 `0.0` 到 `1.0`。

0
thinkingobject

启用 Claude 扩展思考的配置。 `type: "enabled"` 时,需要提供 `budget_tokens`,且预算至少为 1,024,并会计入 `max_tokens` 上限。可通过 `display` 控制思考内容的展示方式。 `type: "adaptive"` 时,Claude 会根据请求复杂度动态决定是否以及如何使用扩展思考;同样可通过 `display` 控制思考内容的展示方式。 `type: "disabled"` 时,不启用扩展思考。

tool_choiceobject

模型应如何使用提供的工具。

toolsobject[]

模型可能使用的工具定义。

[
  null
]
top_kinteger

对于每个后续令牌,仅从前 K 个选项中采样。

0
top_pnumber

使用核采样。

0

响应

application/json
成功

响应体

idstring必填

唯一对象标识符。 ID 的格式和长度可能随时间变化。

"string"
typestring必填

对象类型。 对于 Messages,这始终是 `"message"`。

"string"
rolestring必填

生成消息的对话角色。 这始终是 `"assistant"`。

"string"
contentobject[]必填

模型生成的内容。 这是一个内容块数组,每个块都有一个决定其结构的 `type`。

[
  null
]
modelenum<claude-haiku-4-5-20251001 | claude-sonnet-4-5-20250929 | claude-opus-4-1-20250805 | claude-sonnet-4-20250514 | claude-opus-4-5-20251101 | claude-opus-4-6 | claude-opus-4-8 | claude-opus-4-7 | claude-sonnet-4-6>必填

处理请求的模型。

"claude-haiku-4-5-20251001"
stop_reasonenum<end_turn | max_tokens | stop_sequence | tool_use | pause_turn | refusal | model_context_window_exceeded>必填

我们停止的原因。

"end_turn"
stop_sequencestring必填

生成的自定义停止序列(如果有)。

"string"
usageobject必填
{
  "cache_creation": null,
  "cache_creation_input_tokens": null,
  "cache_read_input_tokens": null,
  "input_tokens": 0,
  "output_tokens": 0,
  "server_tool_use": null,
  "service_tier": null
}
context_managementobject

上下文管理响应。

containerobject

此请求中使用的容器信息。

POST/v1/messages
curl --request POST \
  --url https://api.starmagic.ai/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "claude-sonnet-4-5-20250929",
  "max_tokens": 1024,
  "messages": [
    {
      "role": "user",
      "content": "Hello, world"
    }
  ]
}'
响应: 成功
{
  "model": "claude-haiku-4-5-20251001",
  "id": "msg_bdrk_017XLrAa77zWvfBGQ6ESvrxz",
  "type": "message",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": "# Hey there! 👋\n\nHow's it going? What can I help you with today?"
    }
  ],
  "stop_reason": "end_turn",
  "stop_sequence": null,
  "usage": {
    "input_tokens": 8,
    "cache_creation_input_tokens": 0,
    "cache_read_input_tokens": 0,
    "output_tokens": 24
  }
}