{"openapi":"3.1.0","info":{"title":"Katalon Test Ops (BYOK) API","version":"0.1.0","description":"Katalon Test Ops (BYOK) lets an AI assistant read your own Katalon Test Ops data through the Katalon Test Ops API with a key you supply (the email address (username) of your Katalon account). Read-only: 7 tools (list_projects, get_project, get_test_run, get_test_result, get_test_case, get_test_suite, get_agent). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-katalon-testops.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-katalon-testops/docs"},"termsOfService":"https://connectorbay.com/byok-katalon-testops/terms"},"servers":[{"url":"https://byok-katalon-testops.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-katalon-testops/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List Katalon TestOps projects (optionally for one team) with name, team, timezone and status. Paged. Use for \"Which proj","description":"List Katalon TestOps projects (optionally for one team) with name, team, timezone and status. Paged. Use for \"Which projects do I have in Katalon TestOps\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"anyOf":[{"minimum":1,"type":"integer"},{"type":"null"}],"default":null,"description":"Only projects of this team ID.","title":"Team Id"},"page":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number, starting at 0.","title":"Page"},"size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"Page size.","title":"Size"}},"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_project":{"post":{"operationId":"get_project","summary":"Get one project by id: name, team, timezone and status. Use for \"Show Katalon project 255858\".","description":"Get one project by id: name, team, timezone and status. Use for \"Show Katalon project 255858\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project ID.","minimum":1,"title":"Project Id","type":"integer"}},"required":["project_id"],"title":"get_projectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_test_run":{"post":{"operationId":"get_test_run","summary":"Get one test run by project id and run order number: status, stage, timing and pass, fail, error and skip counts. Use fo","description":"Get one test run by project id and run order number: status, stage, timing and pass, fail, error and skip counts. Use for \"How did Katalon test run 12 of project 255858 go\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Project ID that contains the run.","minimum":1,"title":"Project Id","type":"integer"},"order":{"description":"Run order number (shown in Reports).","minimum":1,"title":"Order","type":"integer"}},"required":["project_id","order"],"title":"get_test_runArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_test_result":{"post":{"operationId":"get_test_result","summary":"Get one test result by id: status, timing, error message, failure category, retry flag and a link. Use for \"Show Katalon","description":"Get one test result by id: status, timing, error message, failure category, retry flag and a link. Use for \"Show Katalon test result 5001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_result_id":{"description":"Test result ID.","minimum":1,"title":"Test Result Id","type":"integer"}},"required":["test_result_id"],"title":"get_test_resultArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_test_case":{"post":{"operationId":"get_test_case","summary":"Get one test case by id: name, path, type, description, duration statistics and flakiness score. Use for \"Show Katalon t","description":"Get one test case by id: name, path, type, description, duration statistics and flakiness score. Use for \"Show Katalon test case 3468915\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_case_id":{"description":"Test case ID.","minimum":1,"title":"Test Case Id","type":"integer"}},"required":["test_case_id"],"title":"get_test_caseArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_test_suite":{"post":{"operationId":"get_test_suite","summary":"Get one test suite by id: name, path and alias. Use for \"Show Katalon test suite 1120266\".","description":"Get one test suite by id: name, path and alias. Use for \"Show Katalon test suite 1120266\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"test_suite_id":{"description":"Test suite ID.","minimum":1,"title":"Test Suite Id","type":"integer"}},"required":["test_suite_id"],"title":"get_test_suiteArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_agent":{"post":{"operationId":"get_agent","summary":"Get one local agent by id: name, host name, operating system, version, active flag, last ping and job counts (IP address","description":"Get one local agent by id: name, host name, operating system, version, active flag, last ping and job counts (IP address is not returned). Use for \"Is Katalon agent 12014256 active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"agent_id":{"description":"Agent ID.","minimum":1,"title":"Agent Id","type":"integer"}},"required":["agent_id"],"title":"get_agentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}