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

# 创建响应

> 使用 Responses API 创建响应。

## 服务器工具

`/v1/responses` 支持常规函数工具，以及以下由 Gateway 管理的服务器工具：

* `gateway:datetime`
* `phaseo:web_search`
* `phaseo:web_fetch`
* `phaseo:advisor`
* `phaseo:image_generation`
* `phaseo:apply_patch`

### 日期和时间示例

```bash theme={null}
curl https://api.phaseo.app/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-5-nano",
    "stream": false,
    "input": [
      { "role": "user", "content": "Give me the current datetime in Asia/Tokyo." }
    ],
    "tools": [
      {
        "type": "gateway:datetime",
        "parameters": { "timezone": "Asia/Tokyo" }
      }
    ],
    "tool_choice": "auto"
  }'
```

使用服务器工具时，usage 中会包含相应的 `usage.server_tool_use.*` 计数器。

* `gateway:datetime` -> `datetime_requests`
* `phaseo:web_search` -> `web_search_requests`, `web_search_results`, `web_search_extra_results`
* `phaseo:web_fetch` -> `web_fetch_requests`
* `phaseo:advisor` -> `advisor_requests`
* `phaseo:image_generation` -> `image_generation_requests`
* `phaseo:apply_patch` -> `apply_patch_requests`

## 流式传输说明

同样支持 `stream: true`。对于 Gateway 管理的服务器工具，Phaseo 可能会先处理上游工具调用轮次、继续循环，再重新发出合成流。


## OpenAPI

````yaml zh-Hans/openapi/v1/openapi.localized.yaml POST /responses
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: 通过兼容 OpenAI 的端点访问各种 AI 模型的网关 API。
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: 全球路由
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /responses:
    post:
      tags:
        - Gateway
      summary: 创建响应
      description: 使用 Responses API 创建响应。
      operationId: createResponse
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResponsesRequest'
            examples:
              datetimeServerTool:
                summary: Built-in datetime server tool
                value:
                  model: openai/gpt-5-nano
                  stream: false
                  input:
                    - role: user
                      content: Give me the current datetime in Asia/Tokyo.
                  tools:
                    - type: gateway:datetime
                      parameters:
                        timezone: Asia/Tokyo
                  tool_choice: auto
      responses:
        '200':
          description: 响应
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesResponse'
        '429':
          $ref: '#/components/responses/UpstreamRateLimited'
      servers:
        - url: https://api.phaseo.app/v1
          description: 全球路由
        - url: https://eu.api.phaseo.app/v1
          description: 欧盟区域提供商路由（仅文本）
        - url: https://us.api.phaseo.app/v1
          description: 美国区域提供商路由（仅文本）
components:
  schemas:
    ResponsesRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
        input:
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ResponsesInputItem'
            - type: object
        background:
          type: boolean
        include:
          type: array
          items:
            type: string
        instructions:
          type: string
        max_output_tokens:
          type: integer
          minimum: 1
        metadata:
          type: object
          additionalProperties:
            type: string
        session_id:
          type: string
          maxLength: 256
          description: 用于可观测性统计的唯一标识符，可将相关请求（例如对话或代理工作流）归为一组。
        parallel_tool_calls:
          type: boolean
        previous_response_id:
          type: string
        reasoning:
          $ref: '#/components/schemas/OpenAIReasoningConfig'
        service_tier:
          type: string
          enum:
            - standard
            - default
            - fast
            - ultrafast
            - priority
            - flex
            - batch
        store:
          type: boolean
        stream:
          type: boolean
        temperature:
          type: number
          minimum: 0
          maximum: 2
        text:
          type: object
        tool_choice:
          $ref: '#/components/schemas/TextToolChoice'
        tools:
          type: array
          description: >-
            用于模型函数调用和网关服务器工具的工具定义。网关内置服务器工具为
            `gateway:datetime`、`gateway:web_search` 和 `gateway:web_fetch`。
          items:
            $ref: '#/components/schemas/TextGenerateTool'
        top_p:
          type: number
          minimum: 0
          maximum: 1
        truncation:
          type: string
          enum:
            - auto
            - disabled
        user:
          type: string
        prompt_cache_key:
          type: string
          nullable: true
        safety_identifier:
          type: string
          nullable: true
        modalities:
          type: array
          items:
            type: string
            enum:
              - text
              - image
              - audio
        image_config:
          $ref: '#/components/schemas/ImageConfig'
        provider_options:
          $ref: '#/components/schemas/ProviderOptions'
        usage:
          type: boolean
        meta:
          type: boolean
        echo_upstream_request:
          type: boolean
        debug:
          $ref: '#/components/schemas/DebugOptions'
        provider:
          $ref: '#/components/schemas/ProviderRoutingOptions'
    ResponsesResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        created:
          type: integer
        model:
          type: string
        provider:
          type: string
        provider_id:
          type: string
        nativeResponseId:
          type: string
          nullable: true
        status:
          type: string
          enum:
            - completed
            - failed
            - incomplete
        finish_reason:
          type: string
          nullable: true
        meta:
          type: object
          additionalProperties: true
        cost_nanos:
          type: number
        cost_cents:
          type: integer
        currency:
          type: string
        pricing_lines:
          type: array
          items:
            type: object
            additionalProperties: true
        output:
          type: array
          items:
            $ref: '#/components/schemas/ResponsesOutputItem'
        output_items:
          type: array
          items:
            $ref: '#/components/schemas/ResponsesOutputItem'
        content:
          type: array
          items:
            type: object
        role:
          type: string
        stop_reason:
          type: string
        type:
          type: string
        usage:
          $ref: '#/components/schemas/Usage'
    ResponsesInputItem:
      type: object
      description: Responses API 输入项。
      properties:
        type:
          type: string
        role:
          type: string
          enum:
            - user
            - assistant
            - system
            - developer
        content:
          oneOf:
            - type: string
            - type: array
              items:
                type: object
            - type: object
    OpenAIReasoningConfig:
      type: object
      properties:
        effort:
          type: string
          enum:
            - none
            - instant
            - minimal
            - low
            - medium
            - high
            - xhigh
            - max
          default: medium
        mode:
          type: string
          enum:
            - standard
            - pro
        summary:
          type: string
          enum:
            - auto
            - concise
            - detailed
          default: auto
        enabled:
          type: boolean
        max_tokens:
          type: integer
          minimum: 0
    TextToolChoice:
      description: 工具选择策略。接受 Phaseo 服务器工具类型，并将其改写为上游函数或工具目标。
      oneOf:
        - type: string
          enum:
            - auto
            - none
            - required
            - phaseo:datetime
            - phaseo:web_search
            - phaseo:web_fetch
            - phaseo:subagent
            - phaseo:fusion
            - phaseo:search_models
            - gateway:datetime
            - gateway:web_search
            - gateway:web_fetch
        - type: object
    TextGenerateTool:
      oneOf:
        - $ref: '#/components/schemas/FunctionToolDefinition'
        - $ref: '#/components/schemas/GatewayDatetimeToolDefinition'
        - $ref: '#/components/schemas/GatewayWebSearchToolDefinition'
        - $ref: '#/components/schemas/GatewayWebFetchToolDefinition'
        - $ref: '#/components/schemas/SubagentToolDefinition'
        - $ref: '#/components/schemas/FusionToolDefinition'
        - $ref: '#/components/schemas/SearchModelsToolDefinition'
    ImageConfig:
      type: object
      properties:
        aspect_ratio:
          type: string
        image_size:
          type: string
          enum:
            - 0.5K
            - 1K
            - 2K
            - 4K
        include_rai_reason:
          type: boolean
        font_inputs:
          type: array
          items:
            type: object
            properties:
              font_url:
                type: string
                format: uri
              text:
                type: string
        super_resolution_references:
          type: array
          items:
            type: string
        reference_images:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    ProviderOptions:
      type: object
      description: 可选的提供商专用选项。
      properties:
        openai:
          type: object
          properties:
            context_management:
              type: object
              description: 可选的 OpenAI 上下文管理配置。
              properties:
                type:
                  type: string
                  enum:
                    - compaction
                compact_threshold:
                  type: number
              required:
                - type
            prompt_cache_retention:
              type: string
        anthropic:
          type: object
          properties:
            cache_control:
              $ref: '#/components/schemas/CacheControl'
        google:
          type: object
          properties:
            cache_control:
              $ref: '#/components/schemas/CacheControl'
            cached_content:
              type: string
            cache_ttl:
              type: string
    DebugOptions:
      type: object
      description: 网关调试控制项。这些标志绝不会转发给提供商。
      properties:
        enabled:
          type: boolean
        return_upstream_request:
          type: boolean
        return_upstream_response:
          type: boolean
        trace:
          type: boolean
        trace_level:
          type: string
          enum:
            - summary
            - full
    ProviderRoutingOptions:
      type: object
      description: 用于网关选择的提供商路由偏好设置。
      properties:
        order:
          type: array
          items:
            type: string
        only:
          type: array
          items:
            type: string
        ignore:
          type: array
          items:
            type: string
        include_alpha:
          type: boolean
          description: 在路由中包含 alpha 提供商（默认关闭）。
        allow_fallbacks:
          type: boolean
          nullable: true
          description: 失败后允许回退到其他符合条件的提供商。
        require_parameters:
          type: boolean
          nullable: true
          description: 路由前要求提供商支持所请求的参数。
        required_execution_region:
          type: string
          nullable: true
          description: 将路由限制为具有所需执行区域的提供商。
        required_data_region:
          type: string
          nullable: true
          description: 将路由限制为具有所需数据区域的提供商。
        require_zero_data_retention:
          type: boolean
          nullable: true
          description: 将路由限制为支持零数据保留的提供商。
        data_collection:
          type: string
          nullable: true
          enum:
            - allow
            - deny
        zdr:
          type: boolean
          nullable: true
        enforce_distillable_text:
          type: boolean
          nullable: true
        quantizations:
          type: array
          nullable: true
          items:
            type: string
        sort:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: 为此请求排列提供商，例如按价格、延迟或吞吐量排序。
        max_price:
          type: object
          properties:
            prompt:
              oneOf:
                - type: number
                - type: string
            completion:
              oneOf:
                - type: number
                - type: string
            image:
              oneOf:
                - type: number
                - type: string
            audio:
              oneOf:
                - type: number
                - type: string
            request:
              oneOf:
                - type: number
                - type: string
        preferred_min_throughput:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
        preferred_max_latency:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
    ResponsesOutputItem:
      type: object
      description: Responses API 输出项。
      properties:
        type:
          type: string
        role:
          type: string
        content:
          type: array
          items:
            $ref: '#/components/schemas/ResponsesOutputContentPart'
        call_id:
          type: string
        name:
          type: string
        arguments:
          type: string
    Usage:
      type: object
      properties:
        prompt_tokens:
          type: integer
        completion_tokens:
          type: integer
        total_tokens:
          type: integer
        server_tool_use:
          $ref: '#/components/schemas/ServerToolUsage'
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        ok:
          type: boolean
          example: false
        error:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          example: error_type
        message:
          type: string
          example: Human-readable error message
        description:
          type: string
          example: Additional error details.
        generation_id:
          type: string
          example: G-abc123
        status_code:
          type: integer
          example: 502
        error_type:
          type: string
          enum:
            - user
            - system
          example: system
        error_origin:
          type: string
          enum:
            - user
            - gateway
            - upstream
          example: upstream
        reason:
          type: string
          example: all_candidates_failed
        attempt_count:
          type: integer
          example: 2
        failed_providers:
          type: array
          items:
            type: string
          example:
            - google-ai-studio
            - openai
        failed_statuses:
          type: array
          items:
            type: integer
          example:
            - 403
            - 429
        upstream_error:
          $ref: '#/components/schemas/ErrorUpstreamError'
        failure_sample:
          type: array
          items:
            $ref: '#/components/schemas/ErrorFailureSampleItem'
        provider_failure_diagnostics:
          $ref: '#/components/schemas/ErrorProviderFailureDiagnostics'
        routing_diagnostics:
          $ref: '#/components/schemas/ErrorRoutingDiagnostics'
        provider_candidate_diagnostics:
          $ref: '#/components/schemas/ErrorProviderCandidateDiagnostics'
        provider_enablement:
          $ref: '#/components/schemas/ErrorProviderEnablementDiagnostics'
        missing_pricing_providers:
          type: array
          items:
            type: string
        provider_payment_required_provider:
          type: string
          example: openai
        provider_payment_required_support_notice:
          type: string
          example: >-
            Our upstream provider billing appears to be unavailable. If this
            persists, contact support.
        details:
          type: array
          items:
            type: object
            additionalProperties: true
      additionalProperties: true
    FunctionToolDefinition:
      type: object
      required:
        - type
        - function
      properties:
        type:
          type: string
          enum:
            - function
        async:
          type: boolean
          description: 允许受支持的 OpenAI 模型在调用方执行此工具时继续处理。所有文本 API 均接受此设置，其他提供商会忽略它。
        function:
          type: object
          required:
            - name
            - parameters
          properties:
            name:
              type: string
            description:
              type: string
            parameters:
              type: object
      additionalProperties: true
    GatewayDatetimeToolDefinition:
      type: object
      description: 由网关管理的服务器工具。网关会查询日期时间，并将结果注入模型工具循环。
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:datetime
            - gateway:datetime
        parameters:
          type: object
          properties:
            timezone:
              type: string
              description: IANA 时区名称（例如 Europe/London）。
          additionalProperties: false
        timezone:
          type: string
          description: 用于指定默认时区（IANA）的旧版快捷字段。
      additionalProperties: false
    GatewayWebSearchToolDefinition:
      type: object
      description: 由网关管理的服务器工具。网关会执行网页搜索，并将标准化的搜索结果注入模型工具循环。
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:web_search
            - gateway:web_search
        parameters:
          type: object
          properties:
            engine:
              type: string
              enum:
                - auto
                - native
                - exa
                - firecrawl
                - parallel
                - perplexity
                - tinyfish
            max_results:
              type: integer
              minimum: 1
              maximum: 25
            language:
              type: string
            page:
              type: integer
              minimum: 0
              maximum: 10
            include_text:
              type: boolean
            include_highlights:
              type: boolean
          additionalProperties: false
        max_results:
          type: integer
          minimum: 1
          maximum: 25
        engine:
          type: string
          enum:
            - auto
            - native
            - exa
            - firecrawl
            - parallel
            - perplexity
            - tinyfish
        language:
          type: string
        page:
          type: integer
          minimum: 0
          maximum: 10
        include_text:
          type: boolean
        include_highlights:
          type: boolean
      additionalProperties: false
    GatewayWebFetchToolDefinition:
      type: object
      description: 由网关管理的服务器工具。网关会抓取一个 HTTP(S) 页面，将其压缩为限定长度的文本，并把结果注入模型工具循环。
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:web_fetch
            - gateway:web_fetch
        parameters:
          type: object
          properties:
            max_chars:
              type: integer
              minimum: 1
              maximum: 100000
          additionalProperties: false
        max_chars:
          type: integer
          minimum: 1
          maximum: 100000
      additionalProperties: false
    SubagentToolDefinition:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:subagent
        parameters:
          type: object
          additionalProperties: true
    FusionToolDefinition:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:fusion
        parameters:
          type: object
          required:
            - analysis_models
          properties:
            analysis_models:
              type: array
              minItems: 2
              maxItems: 8
              items:
                type: string
            model:
              type: string
          additionalProperties: true
    SearchModelsToolDefinition:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - phaseo:search_models
        parameters:
          type: object
          properties:
            max_results:
              type: integer
              minimum: 1
              maximum: 20
    CacheControl:
      type: object
      properties:
        type:
          type: string
        ttl:
          type: string
        scope:
          type: string
      additionalProperties: true
    ResponsesOutputContentPart:
      oneOf:
        - $ref: '#/components/schemas/ResponsesOutputTextPart'
        - $ref: '#/components/schemas/ResponsesOutputImagePart'
        - $ref: '#/components/schemas/ResponsesOutputAudioPart'
    ServerToolUsage:
      type: object
      properties:
        datetime_requests:
          type: integer
          minimum: 0
        web_search_requests:
          type: integer
          minimum: 0
        subagent_requests:
          type: integer
          minimum: 0
        fusion_requests:
          type: integer
          minimum: 0
        search_models_requests:
          type: integer
          minimum: 0
        web_fetch_requests:
          type: integer
          minimum: 0
        advisor_requests:
          type: integer
          minimum: 0
        image_generation_requests:
          type: integer
          minimum: 0
        apply_patch_requests:
          type: integer
          minimum: 0
      additionalProperties: false
    ErrorUpstreamError:
      type: object
      properties:
        code:
          type: string
          nullable: true
          example: PERMISSION_DENIED
        message:
          type: string
          nullable: true
          example: The caller does not have permission.
        description:
          type: string
          nullable: true
        param:
          type: string
          nullable: true
    ErrorFailureSampleItem:
      type: object
      properties:
        provider:
          type: string
          nullable: true
        type:
          type: string
          nullable: true
        status:
          type: integer
          nullable: true
        upstream_error_code:
          type: string
          nullable: true
        upstream_error_message:
          type: string
          nullable: true
        upstream_error_description:
          type: string
          nullable: true
        upstream_error_param:
          type: string
          nullable: true
        upstream_payload_preview:
          type: string
          nullable: true
        retryable:
          type: boolean
          nullable: true
      additionalProperties: true
    ErrorProviderFailureDiagnostics:
      type: object
      properties:
        category:
          type: string
          enum:
            - credentials_not_configured
            - credentials_invalid_or_forbidden
            - provider_access_missing
            - region_or_project_restriction
            - model_unavailable_for_endpoint
            - rate_limited
            - server_error
        hint:
          type: string
        provider:
          type: string
          nullable: true
    ErrorRoutingDiagnostics:
      type: object
      properties:
        filterStages:
          type: array
          items:
            type: object
            properties:
              stage:
                type: string
              beforeCount:
                type: integer
              afterCount:
                type: integer
              droppedProviders:
                type: array
                items:
                  type: object
                  properties:
                    providerId:
                      type: string
                      nullable: true
                    reason:
                      type: string
                      nullable: true
                  additionalProperties: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderCandidateDiagnostics:
      type: object
      properties:
        totalProviders:
          type: integer
        supportsEndpointCount:
          type: integer
        candidateCount:
          type: integer
        droppedUnsupportedEndpoint:
          type: array
          items:
            type: string
        droppedMissingAdapter:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              endpoint:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ErrorProviderEnablementDiagnostics:
      type: object
      properties:
        capability:
          type: string
        providersBefore:
          type: array
          items:
            type: string
        providersAfter:
          type: array
          items:
            type: string
        dropped:
          type: array
          items:
            type: object
            properties:
              providerId:
                type: string
                nullable: true
              reason:
                type: string
                nullable: true
            additionalProperties: true
      additionalProperties: true
    ResponsesOutputTextPart:
      type: object
      required:
        - type
        - text
      properties:
        type:
          type: string
          enum:
            - output_text
        text:
          type: string
        annotations:
          type: array
          items:
            type: object
    ResponsesOutputImagePart:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - output_image
        b64_json:
          type: string
        image_url:
          type: object
          properties:
            url:
              type: string
        mime_type:
          type: string
      anyOf:
        - required:
            - b64_json
        - required:
            - image_url
    ResponsesOutputAudioPart:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum:
            - output_audio
        b64_json:
          type: string
        audio_url:
          type: object
          properties:
            url:
              type: string
        mime_type:
          type: string
        format:
          type: string
          enum:
            - wav
            - mp3
            - flac
            - m4a
            - ogg
            - pcm16
            - pcm24
      anyOf:
        - required:
            - b64_json
        - required:
            - audio_url
  responses:
    UpstreamRateLimited:
      description: 所选上游提供商对该请求进行了速率限制。
      headers:
        Retry-After:
          description: 提供商验证过的重试等待秒数。
          schema:
            type: integer
            minimum: 0
            maximum: 86400
        X-Phaseo-Upstream-RateLimit-Limit:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Remaining:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Reset:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Limit-Requests:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Remaining-Requests:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Reset-Requests:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Limit-Tokens:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Remaining-Tokens:
          $ref: '#/components/headers/UpstreamRateLimitValue'
        X-Phaseo-Upstream-RateLimit-Reset-Tokens:
          $ref: '#/components/headers/UpstreamRateLimitValue'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  headers:
    UpstreamRateLimitValue:
      description: 仅适用于 BYOK 的提供商配额元数据。使用托管提供商的请求不会返回此字段。
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer 令牌身份验证

````

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