DOCS
Reference

API: Projects

Projects: List projects, Get a project, Create a project, Update a project, Archive a project.

List projects

GET/api/v1/projects

The projects in this workspace (a project groups the tests of one site or app).

MCP tool: list_projects. Works with any key.

Returns { projects: [{ id, name, description, createdAt }] }

Request
curl https://app.testsy.dev/api/v1/projects \
  -H "Authorization: Bearer $QA_AI_API_KEY"

Get a project

GET/api/v1/projects/{projectId}

One project.

MCP tool: get_project. Works with any key.

Path
projectIdstringrequired
Project id (p_…)

Returns { project: { id, name, description, createdAt } }

Request
curl https://app.testsy.dev/api/v1/projects/p_8f2k \
  -H "Authorization: Bearer $QA_AI_API_KEY"

Create a project

POST/api/v1/projects

Create a project, for example one per site or app.

MCP tool: create_project. Needs a key that can also create and edit tests.

Body (JSON)
namestringrequired
Project name (up to 80 characters)
descriptionstring
Optional description

Returns 201 { id }

Request
curl -X POST https://app.testsy.dev/api/v1/projects \
  -H "Authorization: Bearer $QA_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Checkout"}'

Update a project

PATCH/api/v1/projects/{projectId}

Rename a project or change its description.

MCP tool: update_project. Needs a key that can also create and edit tests.

Path
projectIdstringrequired
Project id (p_…)
Body (JSON)
namestring
New name
descriptionstring
New description ("" clears it)

Returns { ok: true }

Request
curl -X PATCH https://app.testsy.dev/api/v1/projects/p_8f2k \
  -H "Authorization: Bearer $QA_AI_API_KEY"

Archive a project

DELETE/api/v1/projects/{projectId}

Archive a project: its tests stop running; past runs stay in the run history.

MCP tool: delete_project. Needs a key that can also create and edit tests.

Path
projectIdstringrequired
Project id (p_…)

Returns { ok: true }

Request
curl -X DELETE https://app.testsy.dev/api/v1/projects/p_8f2k \
  -H "Authorization: Bearer $QA_AI_API_KEY"