Skip to main content
POST
/
api
/
v1
/
repos
/
grep
Grep
curl --request POST \
  --url https://api.{cluster}.code.storage/api/v1/repos/grep \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "context": {
    "after": 1,
    "before": 0
  },
  "pagination": {
    "limit": 50
  },
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "rev": "main"
}
'
{
  "has_more": true,
  "matches": [
    {
      "path": "app/blog/markdown/ephemeral-branches.md"
    }
  ],
  "query": {
    "case_sensitive": true,
    "pattern": "ephemeral branches"
  },
  "repo": {
    "commit": "b003fc78805954584e1ee364a4ad39d7c79e819a",
    "ref": "main"
  }
}

Documentation Index

Fetch the complete documentation index at: https://code.storage/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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.

query
object
required

Pattern configuration.

rev
string
required

Legacy ref field retained for backwards compatibility. Prefer the ref field for new callers.

Example:

"main"

context
object

Lines of context to include before and after each match.

ephemeral
boolean

Whether ref should be resolved from the ephemeral namespace.

file_filters
object

Optional include and exclude filters applied before matching.

limits
object

Maximum line and per-file match limits.

pagination
object

Cursor-based pagination controls for large result sets.

paths
string[]

Optional path prefixes used to narrow the search before pattern matching.

Repository-relative path used to scope the operation.

ref
string

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.

has_more
boolean
required

Whether additional matches remain.

Example:

true

matches
object[]
required

Files that matched the query, each with matching and context lines.

next_cursor
string | null
required

Opaque cursor for the next page, if any.

query
object
required

The effective query settings used by the server.

repo
object
required

Resolved repository ref and commit used for the search.