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

# 文档搜索

> 使用公开文档语料库回答与 Firecrawl 文档相关的问题。

`/support/docs-search` 端点使用 Firecrawl 的公开文档回答问题。需要你的 Firecrawl API 密钥。返回简洁、基于文档的答案，并附带相关文档页面的引用。

<div id="use-cases">
  ## 使用场景
</div>

* **AI 代理**，需要查阅 Firecrawl API 的使用方式、参数或最佳实践
* **支持机器人**，根据文档回答客户问题
* **开发者工具**，内嵌显示相关文档

<div id="example">
  ## 示例
</div>

```bash theme={null}
curl -X POST https://api.firecrawl.dev/v2/support/docs-search \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "what header carries the webhook signature, and how do I verify it?"
  }'
```

<div id="response">
  ### 响应
</div>

```json theme={null}
{
  "requestId": "req_...",
  "answer": "The signature is sent in the X-Firecrawl-Signature header...",
  "evidence": [
    {
      "pathOrUrl": "webhooks/security.mdx#L1-L52",
      "reason": "Documents webhook signature verification"
    }
  ],
  "usage": { "inputTokens": 4356, "outputTokens": 688, "totalTokens": 5044 },
  "durationMs": 11252
}
```

<div id="response-fields">
  ## 响应字段
</div>

| 字段           | 类型      | 描述                                                    |
| ------------ | ------- | ----------------------------------------------------- |
| `answer`     | string  | 基于 Firecrawl 文档的简洁答案                                  |
| `evidence`   | array   | 引用的文档页面，包含 `pathOrUrl` 和 `reason`                     |
| `usage`      | object  | Token 用量 (`inputTokens`、`outputTokens`、`totalTokens`) |
| `durationMs` | integer | 总执行时间 (毫秒)                                            |

如需查看完整功能指南，请参见 [Ask 功能文档](/zh/features/ask)。

> 你是需要 Firecrawl API 密钥的 AI 代理吗？请参见 [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) 了解自动化接入说明。


## OpenAPI

````yaml zh/api-reference/v2-openapi.json POST /support/docs-search
openapi: 3.0.0
info:
  contact:
    email: support@firecrawl.dev
    name: Firecrawl Support
    url: https://firecrawl.dev/support
  description: 用于与 Firecrawl 服务交互，执行网页抓取和爬取任务的 API。
  title: Firecrawl API
  version: v2
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /support/docs-search:
    post:
      tags:
        - Support
      summary: 搜索带引用的 Firecrawl 文档
      description: 使用公开文档语料库回答与 Firecrawl 文档相关的问题。
      operationId: searchSupportDocs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupportDocsSearchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportDocsSearchResponse'
          description: 基于文档的答案
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: 请求无效
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: Bearer token 缺失或无效
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: 支持代理不可用
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: 支持代理超时
      security:
        - bearerAuth: []
components:
  schemas:
    SupportDocsSearchRequest:
      properties:
        question:
          description: 需要解答的文档相关问题。
          type: string
      required:
        - question
      type: object
    SupportDocsSearchResponse:
      properties:
        answer:
          description: 基于 Firecrawl 文档的简明答案。
          type: string
        durationMs:
          description: 文档搜索的总执行时间（毫秒）。
          type: integer
        evidence:
          items:
            properties:
              pathOrUrl:
                type: string
              reason:
                type: string
            type: object
          type: array
        requestId:
          type: string
        usage:
          properties:
            inputTokens:
              type: integer
            outputTokens:
              type: integer
            totalTokens:
              type: integer
          type: object
      type: object
    SupportProxyErrorResponse:
      properties:
        error:
          description: 支持代理或上游返回的错误代码。
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````