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

# 提交反馈

> 告诉我们 API 哪里出错了。不消耗积分。

当结果错误、不完整、缓慢、失败或与文档不符时，请使用此端点。它既可以由代理调用，也可以由人调用：当你的流程检测到不良结果时，请报告它所来自对象的 `id`，我们可以追溯到确切的请求。

提交反馈是免费的，即使你的团队积分已用尽也可以使用。

## 发送内容

| 字段 | 必需 | 备注 |
| - | - | - |
| `category` | 是 | 其中之一：`output_quality`、`reliability`、`performance`、`documentation`、`api_usability`、`feature_gap`、`other` |
| `note` | 是 | 出错的地方以及你期望的结果，最多 4,000 个字符 |
| `issues` | 否 | 最多 20 个 `snake_case` 症状代码，例如 `missing_content` 或 `timeout`。文档中列出了代码；接受任何相同格式的其他代码 |
| `affected_endpoint` | 否 | `METHOD /path`，例如 `POST /v1/scrapes` |
| `related_object_id` | 否 | 反馈所涉及的抓取、批次、爬取、答案或其他对象的 `id`，或调用失败时的 `error_…` id |
| `url` | 否 | 反馈所涉及的页面，例如被抓取的 URL |

## 示例

```bash cURL theme={null}
curl -X POST https://api.olostep.com/v1/feedbacks \
  -H "Authorization: Bearer <your_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "output_quality",
    "issues": ["missing_content", "broken_formatting"],
    "note": "Markdown 丢失了价格比较表；期望所有 4 行。",
    "affected_endpoint": "POST /v1/scrapes",
    "related_object_id": "scrape_abc1234567",
    "url": "https://example.com/pricing"
  }'
```

响应是存储的 `feedback` 对象及其 `id` 和 `created_at`。目前还没有列表或获取端点；反馈在我们这边读取。


## OpenAPI

````yaml zh/openapi/feedbacks.json POST /v1/feedbacks
openapi: 3.0.3
info:
  title: Feedbacks API
  version: 1.0.0
  description: 报告 Olostep API 的问题：错误或不完整的输出、失败、文档不匹配或缺少功能。不消耗积分。
servers:
  - url: https://api.olostep.com
security:
  - Authorization: []
paths:
  /v1/feedbacks:
    post:
      summary: 提交反馈
      description: 报告 API 的问题。如果有，请包含反馈所涉及对象的 id。不消耗积分。
      operationId: createFeedback
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeedbackCreateRequest'
      responses:
        '200':
          description: 存储的反馈。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Feedback'
        '400':
          description: 正文无效。
        '401':
          description: API 密钥缺失或无效。
components:
  schemas:
    FeedbackCreateRequest:
      type: object
      required:
        - category
        - note
      properties:
        category:
          type: string
          enum:
            - output_quality
            - reliability
            - performance
            - documentation
            - api_usability
            - feature_gap
            - other
          description: 反馈的主要原因。
        note:
          type: string
          minLength: 1
          maxLength: 4000
          description: 出现了什么问题，以及你期望的结果。
          example: >-
            The markdown drops the pricing comparison table; expected all 4
            rows.
        issues:
          type: array
          maxItems: 20
          items:
            type: string
            pattern: ^[a-z0-9](?:[a-z0-9_]{0,78}[a-z0-9])?$
          description: >-
            具体症状，以小写蛇形命名法代码表示。已记录的代码：missing_content, incorrect_content,
            incomplete_content, broken_formatting, irrelevant_results,
            duplicate_results, stale_content, request_failed, timeout,
            slow_response, inconsistent_result, docs_mismatch, broken_example,
            confusing_schema, confusing_error, unsupported_website,
            unsupported_format。接受任何其他相同格式的代码。
          example:
            - missing_content
            - broken_formatting
        affected_endpoint:
          type: string
          minLength: 1
          maxLength: 200
          description: 反馈所涉及的端点，以 `METHOD /path` 形式表示，使用规范的复数路径。
          example: POST /v1/scrapes
        related_object_id:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            API 返回的对象的 id，反馈所涉及的对象：如 scrape_…，batch_… 或类似资源 id，或调用失败时的错误对象
            id（error_…）。
          example: scrape_abc1234567
        url:
          type: string
          format: uri
          maxLength: 2048
          description: 反馈所涉及的页面，例如被抓取的 URL。
          example: https://example.com/pricing
    Feedback:
      type: object
      required:
        - object
        - id
        - category
        - issues
        - note
        - created_at
      properties:
        object:
          type: string
          enum:
            - feedback
        id:
          type: string
          example: feedback_019e70f9-214a-74fc-a1ae-26fd3318be3e
        category:
          type: string
        issues:
          type: array
          items:
            type: string
        note:
          type: string
        affected_endpoint:
          type: string
        related_object_id:
          type: string
        url:
          type: string
        created_at:
          type: string
          format: date-time
          example: '2026-10-23T00:00:00.000Z'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Bearer认证头格式为Bearer <token>，其中<token>是你的认证令牌。

````

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