> ## 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.

# Busca na documentação

> Responda a perguntas sobre a documentação do Firecrawl usando o corpus público da documentação.

O endpoint `/support/docs-search` responde a perguntas com base na documentação pública do Firecrawl. Requer sua chave de API do Firecrawl. Retorna uma resposta concisa, baseada na documentação, com citações das páginas relevantes da documentação.

<div id="use-cases">
  ## Casos de uso
</div>

* **Agentes de IA** que precisam consultar o uso, os parâmetros ou as melhores práticas da API do Firecrawl
* **Bots de suporte** que respondem a perguntas de clientes com base na documentação
* **Ferramentas para desenvolvedores** que exibem documentação relevante de forma integrada

<div id="example">
  ## Exemplo
</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">
  ### Resposta
</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">
  ## Campos da resposta
</div>

| Campo        | Tipo    | Descrição                                                        |
| ------------ | ------- | ---------------------------------------------------------------- |
| `answer`     | string  | Resposta concisa fundamentada na documentação do Firecrawl       |
| `evidence`   | array   | Páginas da documentação consultadas, com `pathOrUrl` e `reason`  |
| `usage`      | object  | Consumo de tokens (`inputTokens`, `outputTokens`, `totalTokens`) |
| `durationMs` | integer | Tempo total de execução em milissegundos                         |

Para ver o guia completo da funcionalidade, consulte a [documentação da funcionalidade Ask](/pt-BR/features/ask).

> Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte [firecrawl.dev/agent-onboarding/SKILL.md](https://www.firecrawl.dev/agent-onboarding/SKILL.md) para obter instruções de integração automatizada.


## OpenAPI

````yaml pt-BR/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: >-
    API para interagir com os serviços do Firecrawl e executar tarefas de web
    scraping e crawling.
  title: Firecrawl API
  version: v2
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /support/docs-search:
    post:
      tags:
        - Support
      summary: Pesquisar na documentação do Firecrawl com citações
      description: >-
        Responda a perguntas sobre a documentação do Firecrawl usando o corpus
        público da documentação.
      operationId: searchSupportDocs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SupportDocsSearchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportDocsSearchResponse'
          description: Resposta fundamentada na documentação
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: Solicitação inválida
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: Token Bearer ausente ou inválido
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: Agente de suporte indisponível
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupportProxyErrorResponse'
          description: Tempo limite do agente de suporte
      security:
        - bearerAuth: []
components:
  schemas:
    SupportDocsSearchRequest:
      properties:
        question:
          description: Pergunta sobre a documentação a ser respondida.
          type: string
      required:
        - question
      type: object
    SupportDocsSearchResponse:
      properties:
        answer:
          description: Resposta concisa com base na documentação do Firecrawl.
          type: string
        durationMs:
          description: Tempo total de execução da busca na documentação, em milissegundos.
          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: Código de erro do proxy de suporte ou do upstream.
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````