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

get_project

One project's details — base URL, execution target, and test site URLs.

Read one project's detail document: identity, base URL, execution target, and the configured test site URLs.

Request

GET /api/v1/ops/projects/{project}
Parameter
In
Type
Required
Description

project

path

string

yes

The project's public id.

curl -H "Authorization: Bearer $TESTVIBE_API_KEY" \
  "$TESTVIBE_SERVER/api/v1/ops/projects/$PROJECT"
testvibe project

Tool get_project — optional project.

Response

{
  "id": "a1b2c3d4-…",
  "name": "Demo Shop",
  "baseUrl": "https://demo.example",
  "executionTarget": "sandbox",
  "testSiteUrls": [
    { "url": "https://demo.example", "isDefault": true },
    { "url": "https://staging.demo.example", "isDefault": false }
  ]
}

testSiteUrls are the candidate targets for the siteUrl override on run_feature, run_suite, and generate_feature; the default one is used when no override is given.

Errors

HTTP
When

404 not_found

No such project in this workspace.

Last updated

Was this helpful?