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

# Responses

> 统一的多模态响应接口，支持 JSON mode、工具序列与图文混合。

`POST /v1/responses` 是 OpenAI 新一代的统一接口，能在一次请求中混合文本、图像等类型的输入，并以结构化格式返回结果。

## 请求示例（cURL）

```bash theme={null}
curl -X POST "https://models.phanedge.cloud/v1/responses" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4.1",
    "input": [
      {
        "role": "user",
        "content": [
          {"type": "text", "text": "请总结附件要点"}
        ]
      }
    ],
    "response_format": {"type": "json_schema"}
  }'
```

## 流式与兼容

* 流式输出：设置 `stream: true` 可获得服务端事件（SSE）增量；
  * 需要兼容 Chat Completions 流格式时，可在 SSE 客户端侧做转换（PhanEdge 已内置向后兼容处理）。
* 工具事件：在流中会以 `response.output_item.added` 体现工具调用；结束时携带 `usage` 聚合令牌统计。

## 技巧与注意事项

* `input` 字段可以是字符串或复合数组，推荐使用数组以便在其中混合文本、图像、文件引用等内容。
* 对话历史可通过继续在 `input` 中添加多轮 `role`/`content` 分段。
* `response_format` 支持 `json_schema`、`text` 等选项；结合 PhanEdge 的流控策略，可实现结构化自动化处理。
* 若需要工具调用，请在 `tools` 中声明可选函数，返回结果将出现在 `output` 的 `tool_calls` 字段里。
* 费用提示：当启用 Web Search Preview、Code Interpreter、File Search 等工具时，PhanEdge 会在 `usage` 中附加额外计费元数据用于对账。


## OpenAPI

````yaml POST /v1/responses
openapi: 3.0.3
info:
  title: PhanEdge Core API
  version: '1.0'
  description: >-
    Core OpenAI-compatible and model-family endpoints used by the PhanEdge user
    docs.
servers:
  - url: https://models.phanedge.cloud
security:
  - BearerAuth: []
paths:
  /v1/responses:
    post:
      tags:
        - OpenAI
      summary: Responses API
      requestBody:
        $ref: '#/components/requestBodies/JsonObject'
      responses:
        '200':
          $ref: '#/components/responses/JsonObject'
components:
  requestBodies:
    JsonObject:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericObject'
  responses:
    JsonObject:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GenericObject'
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <token>'

````