Grep
Search a repository without cloning it. Results are paginated and can include surrounding context lines so downstream tools only fetch the relevant slices.
JWT claims
Required scopes: git:read
Requires per repo scope: Yes
Deprecated: Use /api/repos/{repo_name}/grep instead.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Search repository contents by pattern. Optional file filters, context lines, and pagination let you retrieve only the relevant slices for agents and tools.
Grep request describing the pattern, ref, filters, limits, and pagination for a repository content search.
Pattern configuration.
Legacy ref field retained for backwards compatibility. Prefer the ref field for new callers.
"main"
Lines of context to include before and after each match.
Whether ref should be resolved from the ephemeral namespace.
Optional include and exclude filters applied before matching.
Maximum line and per-file match limits.
Cursor-based pagination controls for large result sets.
Optional path prefixes used to narrow the search before pattern matching.
Repository-relative path used to scope the operation.
Preferred branch, tag, or commit to search.
Response
Search results for the requested pattern.
Grep results grouped per file, including the resolved ref and pagination state.
Whether additional matches remain.
true
True when the result set is incomplete because the server-side output cap was reached. Matches beyond the cap exist in the repo but cannot be retrieved by paging: narrow the query (pattern, paths, file filters) or raise max_lines if it was set below the maximum. next_cursor still pages through everything collected below the cap.
false
Files that matched the query, each with matching and context lines.
Opaque cursor for the next page, if any.
The effective query settings used by the server.
Resolved repository ref and commit used for the search.