Skip to main content

read_file

Read one file by path. Stored content wins; the template is the fallback — so you can inspect the stored file or inherited template. Dispatch may add runtime settings or generated bundle overlays.

Request​

GET /api/v1/ops/projects/{project}/files/content?path={path}
ParameterInTypeRequiredDescription
projectpathstringyesThe project's public id.
pathquerystringyesThe 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"

Response​

{
"path": "Configurations/Default.config.js",
"kind": "config",
"source": "template",
"content": "import { defineConfig } from '@playwright/test';\nexport default defineConfig({\n \"Name\": \"Default\",\n …\n});\n"
}
info

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

Errors​

HTTPWhen
400 invalid_requestMissing path, or a path containing ...
404 not_foundNo stored or template file at that path.