---
title: "Get the current key"
description: "Trillet OEM API: Returns the key's mode, scopes, tenant restriction and partner account."
openapi: /public/openapi/trillet-oem.yaml GET /partner/v1/key
lastUpdated: "2026-10-28"
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://docs.trillet.ai/llms.txt). Append `.md` to any page URL for its markdown version.

`GET https://api.trillet.ai/partner/v1/key`

Returns the key's mode, scopes, tenant restriction and partner account. Needs no scope.

## Authentication

- `partnerKey` — http bearer (tpk_live_...)

## Response 200

The key.
  - response (object)
    - `object` (string, required)
    - `id` (string, required)
    - `mode` (string, required, one of: live, sandbox)
    - `scopes` (array, required)
      - `items` (string, one of: tenants:read, tenants:write, resources:read, resources:write, calls:write, numbers:write, templates:read, templates:write, events:read, webhooks:write, usage:read, sessions:write)
    - `tenantIds` (array, required) — Empty when the key is not restricted to some tenants.
      - `items` (string)
    - `partner` (object, required)
      - `id` (string)
      - `name` (string | null)
      - `maxTenants` (integer | null)
      - `tenantCount` (integer)

## Response 401

The partner key is missing, malformed, unknown or revoked (`partner_key_required`, `invalid_api_key`, `partner_not_enabled`).
  - response (object)
    - `error` (object, required)
      - `type` (string, required, one of: invalid_request_error, authentication_error, permission_error, conflict_error, rate_limit_error, api_error, idempotency_error)
      - `code` (string, required) — A stable code. Handle errors by `code`, not by `message`.
      - `message` (string, required)
      - `param` (string) — The request field the error is about, when there is one.
      - `requestId` (string | null) — Include it when you contact support. Not present on idempotency errors.


---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://docs.trillet.ai/api-specs.zip