Which API should I use?

Check the address you use to sign in to Katalon:

https://<tenant>.katalon.io (your own subdomain): use the v2 API.
https://testops.katalon.io: use the v1 API.

In these guides, the tenant host is your own https://<tenant>.katalon.io
address. The shared host is https://testops.katalon.io.

API	Host and paths	When to use it
True Platform API (v2)	Tenant host, `/v2/...` paths	New integrations for scheduling, test assets, reports, ALM, manual execution, and stored metadata. See Authenticate with the v2 API.
True Platform API (v1)	Shared host, `/api/v1/...` paths	Existing integrations on the shared host. Use the v1 reference's authentication and IDs; do not mix in v2 hosts or IDs.

If you already use the v1 schedule trigger, read
Migrate from the v1 API.
The IDs and response bodies differ; changing the URL alone is not a migration.

Operations that keep v1 paths

Some operations on the tenant host keep their v1 paths. TestCloud
session-output reads use /v1/tc/ees/.... The tenant-host Files and Visual
Checkpoints API uses /api/v1/... paths. For these operations, use your tenant
host and the v1 path shown in the reference.

Choose a guide by task

Task	Guide
Authenticate and find your project ID	Authenticate with the v2 API
Start tests from CI and gate on the result	Run tests from CI
Move a v1 schedule trigger to v2	Migrate from the v1 API
Create and update test cases and suites	Manage test cases and suites
Manage AUTs, environments and custom fields	Manage AUT environments and custom fields
List stored artifact and document metadata	List stored artifact and document metadata
Read manual run evidence	Read manual execution evidence
Find TestCloud environments and session outputs	Find shared TestCloud environments
Get report metadata and quality insights	Get started with reports and quality insights
Read ALM issues and add comments	Read ALM issues and add comments
Use legacy files and visual checkpoints	Legacy Files and Visual Checkpoints API (v1)