Search app code

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Finds the lines in the app’s source files that contain some text, the way the app editor’s search does.

The text is matched literally, not as a pattern, and the match ignores case unless you set case_sensitive. Each result lists the matching lines of one file with their line numbers and up to 300 characters of the line around the match.

Search covers the files List app code files returns for the same branch_id. Files over 5 MB and files that aren’t text are skipped and counted in skipped_files. A search stops after 500 matching lines or 10 seconds, and truncated is then true, so narrow the text if you need every match.

Reads come from the app’s live sandbox, the same files the app editor shows, including changes that haven’t been published yet. If no sandbox is running, the call starts one, so the first call after a quiet period takes noticeably longer than later ones.

Set branch_id to read a branch’s files instead of main’s. Each branch has its own sandbox, so the first read of a branch also takes longer. A merged branch can’t be read: the call returns a 409. On an app imported from GitHub, reading a merged branch can instead return the files as they were when the branch was created, so don’t rely on it there.

This is limited to 60 requests per minute per app for each workspace’s personal API keys, so every key in a workspace shares one allowance. Some workspaces have a different limit.

This endpoint accepts a personal API key belonging to a user with editor access to the app. A read-only key is refused even though this endpoint only reads, and workspace API keys are not accepted.

POST /api/apps/{app_id}/code/search

Search app code

cURL

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/code/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "useState(",
  "case_sensitive": false
}
'

200

{
  "files": [
    {
      "matches": [
        {
          "line_number": 12,
          "preview": "  const [count, setCount] = useState(0);"
        }
      ],
      "path": "src/pages/Home.jsx"
    }
  ],
  "truncated": false,
  "skipped_files": 0
}

Authorizations

Authorization · string · header · required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id · string · required

ID of the app whose code to read.

Query Parameters

branch_id · string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Body

application/json

The text to find.

query · string · required

Text to find, 2 to 200 characters on a single line. It's matched literally.

Required string length: 2 - 200

Example:

"useState("

case_sensitive · boolean · default: false

Whether the match respects case.

Example:

false

Response

200

application/json

The matching lines, grouped by file.

The files that contain the text.

files · SearchFileResult · object[] · required

Each file with at least one match.

Show child attributes

Example:

[
  {
    "matches": [
      {
        "line_number": 12,
        "preview": "  const [count, setCount] = useState(0);"
      }
    ],
    "path": "src/pages/Home.jsx"
  }
]

truncated · boolean · required

true when the search stopped at 500 matching lines or 10 seconds, so there can be more matches.

Example:

false

skipped_files · integer · required

Number of files left out of the search because they're over 5 MB or aren't text.

Example:

0