# Testim (Tricentis)

> Testim is an AI-powered functional UI and mobile test automation platform,
> now part of Tricentis. Its public REST API and CLI let teams manage test
> branches, look up and execute tests/suites/labels/test-plans remotely, read
> execution and step-level results, and manage mobile app binaries. This file
> was generated by the API Evangelist enrichment pipeline from the provider's
> published OpenAPI spec and docs (no llms.txt is published by the provider).

## API

- [Testim Public API (OpenAPI 3.0)](https://raw.githubusercontent.com/testimio/public-openapi/main/api.yaml): The verbatim public OpenAPI spec. Base URLs https://api.testim.io (US) and https://api.eu.testim.io (EU).
- [API access docs](https://docs.tricentis.com/testim/content/administration/api-access.htm): How to generate an API key and authenticate. Requires a Pro-tier project.
- Authentication: static Bearer key — `Authorization: Bearer PAK-<key>`. Manage keys in the app under Settings > API.

## Capabilities (by tag)

- Branches: list, create (fork), merge, delete — GET/POST /branches, PUT /branches/merge, DELETE /branches/{branch}
- Tests: list by branch, get by id, search by name, change status, list TMS test cases, execute — /tests, /tests/{testId}, /tests/search, /tests/run/{testId}
- Suites: search by name, execute — /suites/search, /suites/run/{suiteId}
- Test plans: search by name, execute — /test-plans/search, /test-plans/run/{planId}
- Labels: execute all tests with a label — /labels/run/{label}
- Executions: list and read execution results and per-test/step results — /runs/executions, /v2/runs/executions/{executionId}, /runs/tests/{testResultId}
- Mobile Applications: upload, list, get, delete app binaries — /mobile/applications

## Conventions

- Pagination: page-number (page/pageSize) on execution listings.
- Request tracing: every response carries metaData.requestId.
- Errors: custom JSON envelope { requestId, error: { message, status } } (not RFC 9457).
- Rate limiting: HTTP 429 per project and per API key.
- No OAuth2 / no webhooks / no idempotency-key header.

## Tooling

- [Testim CLI (@testim/testim-cli)](https://www.npmjs.com/package/@testim/testim-cli): Official npm CLI to run tests from CI/CD. `npm install -g @testim/testim-cli`.
- [CLI docs](https://docs.tricentis.com/testim/content/ci-cd-integrations/the-command-line-cli.htm)

## Operations & Status

- [Changelog](https://help.testim.io/changelog)
- [Status page](https://status.tricentis.com/) (Testim listed as a component)
- [Tricentis Security Center](https://security.tricentis.com/): SOC 2 Type 2, ISO 27001:2022 (covers Testim).

## Optional

- [Testim documentation](https://docs.tricentis.com/testim/)
- [GitHub org (testimio)](https://github.com/testimio)