> ## Documentation Index
> Fetch the complete documentation index at: https://firecrawl-noaa-mar-989-create-firecrawl-codex-plugins.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Busca na 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:
  title: Firecrawl API
  version: v2
  description: >-
    API para interagir com os serviços do Firecrawl e executar tarefas de web
    scraping e crawling.
  contact:
    name: Firecrawl Support
    url: https://firecrawl.dev/support
    email: support@firecrawl.dev
servers:
  - url: https://api.firecrawl.dev/v2
security:
  - bearerAuth: []
paths:
  /support/docs-search:
    post:
      tags:
        - Support
      summary: Pesquise na documentação do Firecrawl usando IA
      operationId: supportDocsSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - question
              properties:
                question:
                  type: string
                  minLength: 1
                  maxLength: 8000
                  description: >-
                    A pergunta a ser respondida com base na documentação pública
                    do Firecrawl.
      responses:
        '200':
          description: Resposta baseada na documentação retornada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocsSearchResponse'
        '400':
          description: JSON inválido ou violação de schema
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
      security:
        - bearerAuth: []
components:
  schemas:
    DocsSearchResponse:
      type: object
      properties:
        requestId:
          type: string
          description: Identificador único desta solicitação.
        answer:
          type: string
          description: Resposta concisa baseada na documentação pública do Firecrawl.
        evidence:
          type: array
          description: Páginas da documentação referenciadas na resposta.
          items:
            type: object
            properties:
              pathOrUrl:
                type: string
              reason:
                type: string
        usage:
          type: object
          properties:
            inputTokens:
              type: integer
            outputTokens:
              type: integer
            totalTokens:
              type: integer
        durationMs:
          type: integer
          description: Tempo total de execução em milissegundos.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````