Skip to main content
POST
Search app files

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the app whose sandbox to operate on.

Body

application/json
pattern
string
required

Search pattern.

path
string | null

Subtree to search, relative to the app root. Default: whole app.

is_regex
boolean
default:true

Treat the pattern as a regex (default) or a literal string.

case_sensitive
boolean
default:false

Case-sensitive match. Default false.

glob
string | null

Optional file glob filter, e.g. "*.tsx".

max_results
integer
default:200

Maximum number of match lines to return.

Required range: 1 <= x <= 1000

Response

The matching lines, empty when nothing matched.

The matches, and whether you got all of them.

matches
GrepMatch · object[]
required

Matching lines, capped at max_results.

Example:
truncated
boolean
required

true when there was more to return: either more matches than max_results, or output that hit the 1 MB cap. One very long line can set this with few matches.

Example:

false

returned_matches
integer
required

How many entries matches holds.

Example:

1