> ## Documentation Index
> Fetch the complete documentation index at: https://developers.meshapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Describe Key

> Report a key's org, scopes, model access and effective limits ([internal]).

Two credentials reach this:
- the rsk_ key itself — `key_id` must equal its own id, and any other value is
  404 (never 403), so a data-plane credential is no enumeration oracle;
- a management credential (mak_ admin key or user JWT) with keys:read — it reads
  any key its scope reaches: an admin key per `_admin_key_reaches`, a JWT caller
  by org role OR as a team admin of the key's team (`allow_team_admin`, the same
  visibility `list_keys` grants); a key it cannot reach, or an admin key with no
  access at all, is 403.

The payload is read from a fresh authoritative row: on a warm cache
`get_authenticated_key` hands back a key_cache reconstruction whose non-projected
columns (`meta`, carrying label/masked_key) are null.



## OpenAPI

````yaml /api/openapi.json get /v1/keys/{key_id}
openapi: 3.1.0
info:
  title: MeshAPI
  description: One key, all AI models.
  version: 0.1.0
servers:
  - url: https://api.meshapi.ai
security:
  - BearerAuth: []
paths:
  /v1/keys/{key_id}:
    get:
      tags:
        - Keys
      summary: Describe Key
      description: >-
        Report a key's org, scopes, model access and effective limits
        ([internal]).


        Two credentials reach this:

        - the rsk_ key itself — `key_id` must equal its own id, and any other
        value is
          404 (never 403), so a data-plane credential is no enumeration oracle;
        - a management credential (mak_ admin key or user JWT) with keys:read —
        it reads
          any key its scope reaches: an admin key per `_admin_key_reaches`, a JWT caller
          by org role OR as a team admin of the key's team (`allow_team_admin`, the same
          visibility `list_keys` grants); a key it cannot reach, or an admin key with no
          access at all, is 403.

        The payload is read from a fresh authoritative row: on a warm cache

        `get_authenticated_key` hands back a key_cache reconstruction whose
        non-projected

        columns (`meta`, carrying label/masked_key) are null.
      operationId: describe_key
      parameters:
        - name: key_id
          in: path
          required: true
          schema:
            type: string
            title: Key Id
        - in: header
          name: X-Mesh-Version
          required: false
          schema:
            type: string
            enum:
              - 2026-08
              - 2026-09
              - 2026-11
              - '2026-11-12'
            default: 2026-08
          example: '2026-11-12'
          description: >-
            Dated version of the API contract to pin this request to. Omit it
            and the request is served under `2026-08` — the oldest supported
            version, so an existing integration is never moved by a release. A
            malformed or unsupported value is rejected with `400
            invalid_api_version` rather than falling back silently. The version
            actually served is echoed as `X-Mesh-Version` on every response,
            including errors.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyIntrospection'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    KeyIntrospection:
      properties:
        key_id:
          type: string
          title: Key Id
        label:
          anyOf:
            - type: string
            - type: 'null'
          title: Label
        status:
          type: string
          title: Status
        masked_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Masked Key
        default_model:
          anyOf:
            - type: string
            - type: 'null'
          title: Default Model
        scopes:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scopes
        allowed_models:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Allowed Models
        blocked_models:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Blocked Models
        model_limits:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Model Limits
        limits:
          $ref: '#/components/schemas/EffectiveLimits'
      type: object
      required:
        - key_id
        - label
        - status
        - masked_key
        - default_model
        - scopes
        - allowed_models
        - blocked_models
        - model_limits
        - limits
      title: KeyIntrospection
      description: >-
        What the presented key is and may do ([internal]). Carries no secret or
        hash.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EffectiveLimits:
      properties:
        key_id:
          type: string
          title: Key Id
        key_rpm:
          anyOf:
            - type: integer
            - type: 'null'
          title: Key Rpm
        key_rpd:
          anyOf:
            - type: integer
            - type: 'null'
          title: Key Rpd
        key_tpm:
          anyOf:
            - type: integer
            - type: 'null'
          title: Key Tpm
        key_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Key Spend Cap
        effective_rpm:
          anyOf:
            - type: integer
            - type: 'null'
          title: Effective Rpm
        effective_rpd:
          anyOf:
            - type: integer
            - type: 'null'
          title: Effective Rpd
        effective_tpm:
          anyOf:
            - type: integer
            - type: 'null'
          title: Effective Tpm
        effective_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Effective Spend Cap
        org:
          anyOf:
            - $ref: '#/components/schemas/OrgContext'
            - type: 'null'
        team:
          anyOf:
            - $ref: '#/components/schemas/TeamContext'
            - type: 'null'
        member:
          anyOf:
            - $ref: '#/components/schemas/MemberContext'
            - type: 'null'
        team_member:
          anyOf:
            - $ref: '#/components/schemas/TeamMemberContext'
            - type: 'null'
      type: object
      required:
        - key_id
        - key_rpm
        - key_rpd
        - key_tpm
        - key_spend_cap
        - effective_rpm
        - effective_rpd
        - effective_tpm
        - effective_spend_cap
        - org
        - team
        - member
        - team_member
      title: EffectiveLimits
      description: >-
        Final computed limits applying minimum-wins across key → member → org
        tiers.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    OrgContext:
      properties:
        org_id:
          type: string
          title: Org Id
        org_name:
          type: string
          title: Org Name
        org_rpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Org Rpm Limit
        org_rpd_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Org Rpd Limit
        org_tpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Org Tpm Limit
        org_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Org Spend Cap
      type: object
      required:
        - org_id
        - org_name
        - org_rpm_limit
        - org_rpd_limit
        - org_tpm_limit
        - org_spend_cap
      title: OrgContext
    TeamContext:
      properties:
        team_id:
          type: string
          title: Team Id
        team_name:
          type: string
          title: Team Name
        team_slug:
          type: string
          title: Team Slug
        team_rpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Team Rpm Limit
        team_rpd_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Team Rpd Limit
        team_tpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Team Tpm Limit
        team_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Team Spend Cap
      type: object
      required:
        - team_id
        - team_name
        - team_slug
        - team_rpm_limit
        - team_rpd_limit
        - team_tpm_limit
        - team_spend_cap
      title: TeamContext
    MemberContext:
      properties:
        user_id:
          type: string
          title: User Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
        role:
          type: string
          title: Role
        member_rpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Rpm Limit
        member_rpd_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Rpd Limit
        member_tpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Tpm Limit
        member_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Member Spend Cap
      type: object
      required:
        - user_id
        - name
        - email
        - role
        - member_rpm_limit
        - member_rpd_limit
        - member_tpm_limit
        - member_spend_cap
      title: MemberContext
    TeamMemberContext:
      properties:
        user_id:
          type: string
          title: User Id
        role:
          type: string
          title: Role
        member_rpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Rpm Limit
        member_rpd_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Rpd Limit
        member_tpm_limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Member Tpm Limit
        member_spend_cap:
          anyOf:
            - type: string
            - type: 'null'
          title: Member Spend Cap
        access_via_org_admin:
          type: boolean
          title: Access Via Org Admin
          default: false
      type: object
      required:
        - user_id
        - role
        - member_rpm_limit
        - member_rpd_limit
        - member_tpm_limit
        - member_spend_cap
      title: TeamMemberContext
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Enter your MeshAPI key (`rsk_...`) or, for the admin-keys endpoints, a
        dashboard session token — sent as `Authorization: Bearer <token>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.