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

# Find text in files

> Find every line that contains a text or a regular expression, in all files under a sandbox directory.



## OpenAPI

````yaml openapi/boat-v1.yaml GET /sandboxes/{sandboxId}/files/find
openapi: 3.1.0
info:
  title: Boat Public API v1
  version: 1.0.0
  description: >
    Public JSON API for creating, operating, prompting, observing, and exposing
    sandboxes from backend services, CI jobs, hosted workers, and Boat
    automation products.


    The v1 reference intentionally documents the developer integration surface
    only. Dashboard billing actions are not part of v1.
servers:
  - url: https://boat.dev/api/v1
security:
  - BoatBearerAuth: []
tags:
  - name: Boat
    description: >-
      Unified Boat account, setup, lifecycle, prompting, event history, desktop
      access, and SSH operations.
paths:
  /sandboxes/{sandboxId}/files/find:
    get:
      tags:
        - Boat
      summary: Find text in sandbox files
      description: >-
        Every line under `path` that contains `pattern`. `pattern` is plain
        text; with `regex=true` it is an extended regular expression. Binary
        files are skipped and symlinks are not followed. Needs `file.read`.
      operationId: findInFiles
      parameters:
        - $ref: '#/components/parameters/SandboxId'
        - name: path
          in: query
          schema:
            type: string
            default: /home/user
        - name: pattern
          in: query
          required: true
          schema:
            type: string
        - name: regex
          in: query
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Matching lines.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileFindResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
components:
  parameters:
    SandboxId:
      name: sandboxId
      in: path
      required: true
      schema:
        type: string
        pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$
      description: Public Sandbox id returned by create/list/get sandbox calls.
  schemas:
    FileFindResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - matches
            - truncated
          properties:
            type:
              type: string
              const: file.find
            success:
              type: boolean
            matches:
              type: array
              description: At most 1,000 matches. Each line is cut at 500 characters.
              items:
                type: object
                required:
                  - file
                  - line
                  - content
                properties:
                  file:
                    type: string
                  line:
                    type: integer
                  content:
                    type: string
            truncated:
              type: boolean
            errors:
              type: array
              items:
                type: string
              description: >-
                Present only when part of the tree could not be searched. The
                matches are then incomplete. An invalid regular expression is an
                error response.
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    ErrorEnvelope:
      type: object
      required:
        - ok
        - type
        - status
        - code
        - message
        - error
        - requestId
      properties:
        ok:
          type: boolean
          examples:
            - false
        type:
          type: string
          examples:
            - sandbox.error
        status:
          type: integer
          examples:
            - 409
        code:
          type: string
          examples:
            - provider_not_configured
        message:
          type: string
          examples:
            - Prompting is locked until Codex is configured on the Agents page.
        requestId:
          type: string
          examples:
            - req_01HX...
        error:
          type: object
          required:
            - code
            - message
            - status
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
  responses:
    BadRequest:
      description: Invalid request body or parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            invalid:
              value:
                ok: false
                type: sandbox.error
                status: 400
                code: invalid_json
                message: Request body must be valid JSON.
                error:
                  code: invalid_json
                  message: Request body must be valid JSON.
                  status: 400
                requestId: req_01HX...
  securitySchemes:
    BoatBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sandbox_api_key
      description: >-
        Boat bearer token in the form `boat_...`. Service API keys authenticate
        sandbox operations.

````

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