For the complete documentation index, see llms.txt. This page is also available as Markdown.

read_file

Read one project file by path — stored content first, template fallback.

Read one file by path. Stored content wins; the template is the fallback — so the response is always what the next run or generation will actually use.

Request

GET /api/v1/ops/projects/{project}/files/content?path={path}
Parameter
In
Type
Required
Description

project

path

string

yes

The project's public id.

path

query

string

yes

The file path, e.g. Configurations/Default.config.js.

curl -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT/files/content?path=Configurations/Default.config.js"
testvibe files get Configurations/Default.config.js

Tool read_file{ "path": "Configurations/Default.config.js" }.

Response

{
  "path": "Configurations/Default.config.js",
  "kind": "config",
  "source": "template",
  "content": "module.exports = {\n  use: { browserName: 'chromium', viewport: { width: 1280, height: 720 } },\n  …\n};\n"
}

Writing a new configuration? Read Configurations/Default.config.js first and use it as the reference shape.

Errors

HTTP
When

400 invalid_request

Missing path.

404 not_found

No stored or template file at that path.

Last updated

Was this helpful?