DOCS
Reference

API: Endpoints

Endpoints: List endpoints, Add an endpoint, Delete an endpoint.

List endpoints

GET/api/v1/projects/{projectId}/endpoints

Calls into your own systems the tester may make during a run (for example "create a voucher"). Headers are never returned.

MCP tool: list_endpoints. Works with any key.

Path
projectIdstringrequired
Project id (p_…)

Returns { endpoints: [{ id, name, description, method, url, created_at, last_used_at }] }

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

Add an endpoint

POST/api/v1/projects/{projectId}/endpoints

Add a call the tester may make into your system. It sees only the name, the description and what the call returned. Using endpoints in a run needs a paid plan. bodyTemplate may contain {{param}} placeholders the tester fills in. Headers (for example Authorization) are encrypted and never returned.

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

Path
projectIdstringrequired
Project id (p_…)
Body (JSON)
namestringrequired
Short name (up to 40 characters), for example create_voucher
descriptionstringrequired
What it does and when to use it (up to 600 characters)
methodPOST | GET | PUT | PATCH | DELETE
HTTP method (default POST)
urlstringrequired
https://… address
headersobject
Request headers, up to 20 (write-only)
bodyTemplatestring
Request body with {{param}} placeholders, optional

Returns 201 { id }

Request
curl -X POST https://app.testsy.dev/api/v1/projects/p_8f2k/endpoints \
  -H "Authorization: Bearer $QA_AI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Checkout","description":"Add a shirt to the cart and check the total matches its price.","url":"https://shop.example.com"}'

Delete an endpoint

DELETE/api/v1/endpoints/{endpointId}

Delete an endpoint.

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

Path
endpointIdstringrequired
Endpoint id (ep_…)

Returns { ok: true }

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