> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omniall.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Claude Messages 对话

> Omniall AI 转发的 Anthropic Messages 接口。支持视觉、文档、工具调用与扩展思考。



## OpenAPI

````yaml zh-CN/openapi/xgapi-public.yaml POST /v1/messages
openapi: 3.0.3
info:
  title: Omniall AI 公开 API
  description: >-
    Omniall AI 公开 API。网站：https://omniall.ai — API 主机：https://api.omniall.ai —
    模型广场：https://omniall.ai/pricing
  version: 1.1.0
servers:
  - url: https://api.omniall.ai
    description: 生产环境
security:
  - bearerAuth: []
tags:
  - name: Models
    description: 列出当前 API Key 可用的模型。
  - name: ChatGPT Chat Completions
    x-group: ChatGPT
    description: OpenAI Chat Completions 对话接口（`POST /v1/chat/completions`）。
  - name: Responses
    description: OpenAI Responses 接口（`POST /v1/responses`）。
  - name: Claude
    description: Anthropic Messages 消息接口（`POST /v1/messages`）。
  - name: Gemini
    description: Google Gemini 原生 generateContent / streamGenerateContent。
  - name: Images
    description: 图像生成（OpenAI Images）、各厂商说明与 Midjourney 代理接口。
  - name: Video
    description: 异步视频任务。
  - name: Audio
    description: 语音合成及相关音频接口。
  - name: Rerank
    description: 文档重排序。
paths:
  /v1/messages:
    post:
      tags:
        - Claude
      summary: Claude Messages 对话
      description: >
        Omniall AI 转发的 Anthropic Messages API。


        **路径：** `POST https://api.omniall.ai/v1/messages`


        请发送 `anthropic-version`（推荐 `2023-06-01`）。鉴权使用 `Authorization: Bearer
        sk-...` 或 `x-api-key`。


        ### 常见场景

        - **视觉理解**：image 内容块

        - **文档**：`document` 块（PDF）

        - **联网搜索**：模型/渠道启用时的服务端工具 `web_search_*`

        - **Agent**：Claude `tools` + `tool_choice`

        - **思考**：`thinking: { type: enabled, budget_tokens }`


        官方参考：https://docs.anthropic.com/en/api/messages
      operationId: createMessage
      parameters:
        - name: anthropic-version
          in: header
          required: true
          schema:
            type: string
            example: '2023-06-01'
          description: Anthropic API 版本请求头。
        - name: x-api-key
          in: header
          required: false
          schema:
            type: string
          description: 可选的 Anthropic 风格 Key（也可用 Bearer）。
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaudeRequest'
            examples:
              基础对话:
                summary: 基础对话
                value:
                  model: claude-sonnet-4
                  max_tokens: 1024
                  messages:
                    - role: user
                      content: 你好，Claude
              图像理解:
                summary: 图像理解
                value:
                  model: claude-sonnet-4
                  max_tokens: 1024
                  messages:
                    - role: user
                      content:
                        - type: image
                          source:
                            type: url
                            url: https://example.com/photo.jpg
                        - type: text
                          text: 描述这张图片
              PDF / 文档分析:
                summary: PDF / 文档分析
                value:
                  model: claude-sonnet-4
                  max_tokens: 2048
                  messages:
                    - role: user
                      content:
                        - type: document
                          source:
                            type: base64
                            media_type: application/pdf
                            data: JVBERi0xLjQ...
                        - type: text
                          text: 请总结这份文档
              联网搜索工具（服务端工具）:
                summary: 联网搜索工具（服务端工具）
                value:
                  model: claude-sonnet-4
                  max_tokens: 2048
                  tools:
                    - type: web_search_20250305
                      name: web_search
                      max_uses: 5
                  messages:
                    - role: user
                      content: 本周 AI 监管领域有哪些动态？
              Agent / 工具调用:
                summary: Agent / 工具调用
                value:
                  model: claude-sonnet-4
                  max_tokens: 1024
                  tools:
                    - name: get_stock_price
                      description: 查询股价
                      input_schema:
                        type: object
                        properties:
                          symbol:
                            type: string
                        required:
                          - symbol
                  messages:
                    - role: user
                      content: AAPL 的股价是多少？
              扩展思考:
                summary: 扩展思考
                value:
                  model: claude-sonnet-4
                  max_tokens: 16000
                  thinking:
                    type: enabled
                    budget_tokens: 10000
                  messages:
                    - role: user
                      content: 请逐步解答：...
      responses:
        '200':
          description: Claude 消息响应（或 SSE 流）。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaudeResponse'
        '400':
          description: 请求体无效，或该模型不支持的参数。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
        '401':
          description: 缺少或无效的 API Key。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
              example:
                error:
                  message: '无效的令牌 (request id: ...)'
                  type: new_api_error
                  code: ''
        '403':
          description: 无权限（用户封禁、IP 白名单或分组访问限制）。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
        '429':
          description: 触发速率限制。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
        '500':
          description: 上游或网关内部错误。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenAIErrorResponse'
components:
  schemas:
    ClaudeRequest:
      type: object
      required:
        - model
        - messages
        - max_tokens
      description: >-
        Anthropic Messages 请求体（POST /v1/messages）。必须提供
        model、messages、max_tokens。
      properties:
        model:
          type: string
          example: claude-sonnet-4
          description: 模型广场中的 Claude 模型 ID。
        messages:
          type: array
          description: 角色为 user / assistant 的对话轮次。内容可为字符串或内容块（text、
          items:
            type: object
            required:
              - role
              - content
            properties:
              role:
                type: string
                enum:
                  - user
                  - assistant
              content:
                oneOf:
                  - type: string
                  - type: array
                    items:
                      type: object
                      additionalProperties: true
        system:
          description: 系统提示（字符串或内容块），设定整体行为。
          oneOf:
            - type: string
            - type: array
              items:
                type: object
                additionalProperties: true
        max_tokens:
          type: integer
          minimum: 1
          description: Claude 最多可生成的 token。Anthropic 必填；也用于控制成本/延迟。
        temperature:
          type: number
          minimum: 0
          maximum: 1
          description: 随机性（Claude 为 0–1）。
        top_p:
          type: number
          description: 核采样。
        top_k:
          type: integer
          description: Top-K 采样。
        stream:
          type: boolean
          description: 为 true 时流式返回 SSE 事件。
        stop_sequences:
          type: array
          items:
            type: string
          description: 自定义停止字符串。
        tools:
          description: Claude 工具：自定义工具，和/或模型/渠道启用时的服务端工具（如 web_search）。
          type: array
          items:
            type: object
            additionalProperties: true
        tool_choice:
          type: object
          properties:
            type:
              type: string
              enum:
                - auto
                - any
                - tool
                - none
              description: 工具选择：auto / any / tool / none。
            name:
              type: string
              description: 当 type 为 tool 时的工具名。
            disable_parallel_tool_use:
              type: boolean
              description: 为 true 时禁止并行工具调用。
          description: 工具选择策略。
        thinking:
          type: object
          properties:
            type:
              type: string
              enum:
                - enabled
                - disabled
              description: 取值：enabled 或 disabled。
            budget_tokens:
              type: integer
              description: 启用思考时预留的最大 token（须小于 `max_tokens`）。
          description: 扩展思考控制。
        mcp_servers:
          type: array
          items:
            type: object
            additionalProperties: true
          description: 使用 Claude MCP 功能时的 MCP 服务器定义。
        metadata:
          type: object
          additionalProperties: true
          description: 请求元数据透传。
        context_management:
          type: object
          additionalProperties: true
          description: 上下文管理选项（厂商相关）。
        output_config:
          type: object
          additionalProperties: true
          description: 支持时的输出配置（如 effort）。
        output_format:
          type: object
          additionalProperties: true
          description: 结构化输出格式控制。
        cache_control:
          type: object
          additionalProperties: true
          description: 支持时的提示缓存控制。
    ClaudeResponse:
      type: object
      properties:
        id:
          type: string
          description: 消息 ID。
        type:
          type: string
          example: message
          description: 通常为 message。
        role:
          type: string
          example: assistant
          description: 通常为 assistant。
        model:
          type: string
          description: 所用模型。
        content:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              text:
                type: string
              name:
                type: string
              input:
                type: object
                additionalProperties: true
          description: 内容块（`text`、`tool_use` 等）。拼接 text 块得到可见回答。
        stop_reason:
          type: string
          enum:
            - end_turn
            - max_tokens
            - stop_sequence
            - tool_use
          description: Claude 停止原因：end_turn、max_tokens、stop_sequence、tool_use 等。
        usage:
          type: object
          properties:
            input_tokens:
              type: integer
              description: 输入 token。
            output_tokens:
              type: integer
              description: 输出 token。
          description: Token 用量。
      description: Anthropic Messages 响应。
    OpenAIErrorResponse:
      type: object
      description: 鉴权或请求失败时返回的 OpenAI 风格错误包络。
      required:
        - error
      properties:
        error:
          type: object
          required:
            - message
            - type
          properties:
            message:
              type: string
              description: 人类可读错误信息。网关可能附加 request id 便于排查。
            type:
              type: string
              description: 错误类型，常见为 `new_api_error`。
              example: new_api_error
            code:
              type: string
              description: 可选机器可读错误码（如 `access_denied`），可能为空字符串。
          description: 错误对象。
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: '使用来自 https://omniall.ai/dashboard 的 Authorization: Bearer sk-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.