> ## Documentation Index > Fetch the complete documentation index at: https://docs.testorim.com/llms.txt > Use this file to discover all available pages before exploring further. # Identify the presented credential > Returns the user the credential belongs to plus the active and personal organizations. The cheapest way to validate a key. This is exactly what `testorim login` calls before it writes the key to `~/.testorim/config.json`. For an API key, `currentOrg` is always the organization the key is bound to. `organization` is a backwards-compatible alias of `currentOrg` with identical content. ## OpenAPI ````yaml /api-reference/openapi.yaml get /api/me openapi: 3.1.0 info: title: Testorim API version: 1.0.0 summary: AI browser QA. Trigger and inspect test runs from CI or your terminal. description: > Testorim runs plain-English browser QA tests in a real Playwright browser. This document describes the **API-key-authenticated subset** of the HTTP API, meaning the endpoints a CI pipeline, a terminal, or a third-party integration is expected to call. ## Scope and honesty notes * **This is not a frozen contract.** `1.0.0` is a documentation version, not a server version. The API is **unversioned in the URL**. There is no `/v1` prefix; every router mounts flat under `/api`. * **This is a subset.** The app's own SPA calls many more endpoints (billing, Polar/Clerk/GitHub webhooks, Slack and GitHub OAuth callbacks, fixtures, environments, schedules, alerts, visual baselines, run sharing, flakiness, test-data variables, perf budgets, role probes, bug reports, org/invite management). Those are deliberately **not** documented here: they are either session-oriented, provider-signed, or not stable enough to hand to an integrator. `PATCH`/`DELETE` on projects and procedures also exist in the code but are out of scope for this reference. ## Authentication Send the API key as an **HTTP Bearer token**: ``` Authorization: Bearer tst_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx ``` Testorim reads exactly one header, `Authorization`, and accepts either credential on it: 1. a value matching `tst_live_…` (prefix + at least 16 more chars) is verified as an API key by SHA-256 hash lookup, or 2. anything else is verified as a Clerk session JWT (the browser path). An API key is bound to **one user and one organization**. On every request the middleware pins `currentOrg` to the key's org, so a key issued for org A can never read or write org B, even when the owning user belongs to both. If the user has since been removed from that org, the key stops working (`401`). Every list and lookup is org-scoped. A resource belonging to another organization returns `404`, never `403`, so the API does not leak the existence of rows you cannot see. ## Role restrictions Members of an org with role `viewer` are read-only: any non-`GET`/`HEAD`/`OPTIONS` request is rejected with `403` and `code: "read_only_role"`. This applies to API-key callers too, because the key inherits the user's role in the bound org. ## Rate limiting Limits are enforced as a sliding window: | Limiter | Policy | Keyed by | Applied to | | --- | --- | --- | --- | | `api:global` | 600 / minute | client IP | every `/api/*` request | | `procedure:minute` | 30 / minute | authenticated user id | `POST /api/runs/trigger` | | `api:read` | 120 / minute | authenticated user id | `GET /api/runs/active` | | `auth:strict` | 5 / 15 minutes | client IP | **failed** credential checks | A throttled request returns `429`, a JSON body of `{ "error": …, "retryAfter": }`, and a `Retry-After` response header. **There are no `X-RateLimit-*` headers**. The middleware sets only `Retry-After`, so do not write a client that depends on quota headers. Rate limits are separate from **plan quotas**. Exhausting the organization's monthly run allowance also returns `429`, but from `checkRunLimit` rather than the limiter, and with no `Retry-After`. ## Request body rules * JSON bodies are capped at **1 MB**. * Any string anywhere in the body containing a NUL byte (`U+0000`) rejects the whole request with `400` before it reaches a handler. * Bodies are validated with Zod. A schema failure returns `400` with `{ "error": "Invalid request body", "issues": [...] }`, where `issues` is the raw `ZodError.issues` array. contact: name: Testorim support email: info@fulgic.com url: https://testorim.com license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://app.testorim.com description: >- Production. Single-origin deployment: Caddy on one GCP VM serves the SPA at `/` and reverse-proxies `/api/*` and `/ws` to the backend. This is also the default API base URL used by the Testorim CLI. - url: http://localhost:3001 description: >- A locally running Testorim backend, for self-hosted or development use. The default port is 3001. security: - ApiKeyAuth: [] tags: - name: Runs description: >- Trigger a test run and read its result. `POST /api/runs/trigger` is the endpoint CI actually uses. - name: Procedures description: Saved, replayable test sequences belonging to a project. - name: Projects description: A website-under-test, scoped to an organization. - name: API keys description: >- Mint, list and revoke API keys. Creating a key requires a browser session. See the operation notes. - name: Identity description: Who the presented credential belongs to. paths: /api/me: get: tags: - Identity summary: Identify the presented credential description: >- Returns the user the credential belongs to plus the active and personal organizations. The cheapest way to validate a key. This is exactly what `testorim login` calls before it writes the key to `~/.testorim/config.json`. For an API key, `currentOrg` is always the organization the key is bound to. `organization` is a backwards-compatible alias of `currentOrg` with identical content. operationId: getMe responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/MeResponse' '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' security: - ApiKeyAuth: [] components: schemas: MeResponse: type: object title: MeResponse required: - user - organization - currentOrg - personalOrg properties: user: type: object required: - id - email - name - imageUrl properties: id: type: string format: uuid description: The internal user id, not the Clerk id. email: type: string format: email name: type: - string - 'null' imageUrl: type: - string - 'null' organization: $ref: '#/components/schemas/MeOrganization' description: >- Backwards-compatible alias of `currentOrg` with identical content. Prefer `currentOrg` in new integrations. currentOrg: $ref: '#/components/schemas/MeOrganization' description: >- For an API key, always the organization the key is bound to, every request in this document is scoped to it. personalOrg: $ref: '#/components/schemas/MeOrganization' description: >- The caller's auto-provisioned personal workspace. Not necessarily the org an API key acts on. MeOrganization: type: object title: MeOrganization description: >- An organization as serialized by `GET /api/me`. `plan`, `subscriptionStatus` and `limits` come from the *plan source* org, for a team workspace that is the owner's personal org, so a team shows the owner's subscribed tier rather than its own defaulted row. required: - id - name - slug - kind - plan - subscriptionStatus - limits properties: id: type: string format: uuid name: type: string slug: type: string kind: type: string enum: - personal - team plan: type: string enum: - free - pro - team subscriptionStatus: type: string enum: - none - trialing - active - past_due - canceled - paused limits: type: object required: - monthlyRunLimit - monthlyBrowserMinutesLimit - monthlyLlmBudgetCents properties: monthlyRunLimit: type: integer monthlyBrowserMinutesLimit: type: integer monthlyLlmBudgetCents: type: integer description: Integer cents. role: type: string enum: - owner - admin - member - viewer description: >- The caller's role in this org. Present on `currentOrg` and `organization`; omitted entirely from `personalOrg`, where the caller is always the owner. A `viewer` is read-only across the whole API. Error: type: object title: Error description: >- The universal error envelope. Every failing handler in this surface responds with a JSON object carrying a human-readable `error` string; some add extra fields (see the other error schemas). required: - error properties: error: type: string description: Human-readable message. Not a stable machine-readable code. additionalProperties: true RateLimitError: type: object title: RateLimitError description: Emitted by the rate-limit middleware alongside a `Retry-After` header. required: - error properties: error: type: string description: The limiter's reason, e.g. `Rate limit exceeded. Try again in 42s.` retryAfter: type: - integer - 'null' description: >- Seconds until the window frees. Mirrors `Retry-After`. May be absent/null when the limiter did not report a reset time, in which case the header defaults to 60. additionalProperties: true responses: Unauthorized: description: | No `Authorization: Bearer …` header, or the credential did not verify. Distinct messages the code can return: * `Missing or invalid Authorization header` * `Invalid or revoked API key` * `API key owner not found` * `API key's organization is no longer accessible`. The key's user has been removed from the org it is bound to * `Invalid token` / `Token missing sub claim`. Clerk JWT path Repeated failures burn the `auth:strict` bucket (5 per 15 minutes per IP) and then return `429` instead. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Invalid or revoked API key RateLimited: description: >- Throttled. Every `/api/*` route sits behind `api:global` (600 / minute per IP); some routes add a tighter per-user limiter. headers: Retry-After: description: Seconds until the window frees up. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/RateLimitError' securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: tst_live_<32 url-safe base64 chars> description: | Send `Authorization: Bearer tst_live_…`. Format (`services/api-keys.ts`): the literal prefix `tst_live_` followed by 24 random bytes rendered as 32 base64url characters. Only the SHA-256 hash is stored server-side. The shape check that routes a token down the API-key path rather than the Clerk JWT path requires the `tst_live_` prefix and a total length of at least 25 characters. Keys are minted in the dashboard at `/settings/team`. The same header also accepts a Clerk session JWT, which is how the web app authenticates, but the JWT path is out of scope for this document. ```` ## Related topics - [Platform overview](/developers/platform-overview.md) - [Browser failures](/troubleshooting/browser-failures.md) - [Writing tests in plain English](/test-creation/writing-tests.md) - [Variables and secrets](/projects/variables-and-secrets.md) - [FAQ](/resources/faq.md)