Skip to main content
POST
/
projects
/
{project_reference}
/
files
/
search
Search Project Files (Text)
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/files/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "pattern": "<string>",
  "is_regex": true,
  "case_sensitive": true,
  "context_lines": 123,
  "max_results": 123
}
'
{
  "results": [
    {
      "path": "<string>",
      "matches": [
        {
          "line": 123,
          "content": "<string>"
        }
      ],
      "id": "<string>",
      "content": "<string>"
    }
  ],
  "total_files": 123
}

Authorizations

Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

project_reference
string
required

Project ID or slug

Body

application/json
query
string
required

Search query (text or regex pattern)

pattern
string

File path pattern filter (e.g., *.tsx)

is_regex
boolean

Treat query as regex (default: false)

case_sensitive
boolean

Case sensitive search (default: false)

context_lines
number

Number of context lines (default: 1)

max_results
number

Maximum results (default: 50)

Response

Search results

results
object[]
required
total_files
number
required