ORorq-ai
API keys

Retrieve an API key

Changed on

Retrieves the metadata for an existing API key by its unique identifier. The raw secret is never returned; token carries a masked display value.

get/v2/api-keys/{api_key_id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/api-keys/{api_key_id}
  • Auth
    HTTP bearer

Path parameters

api_key_idstring required

Unique identifier of the API key.

Response

API key retrieved successfully.

idstring required
namestring required
workspace_idstring required
tokenstring required

Raw on create; the key prefix on retrieve and update; masked in list responses.

activeboolean
is_legacyboolean
sourcestring
budgetobject
expirationstring date-time
projectsstring[]
created_by_idstring nullable
updated_by_idstring nullable
createdstring date-time
updatedstring date-time
consumptionnumber
token_consumptionnumber
requests_per_minute_consumptionnumber
ownerobject
project_scopeobject
permission_modestring
accessobject
token_prefixstring
statusstring
constraintsobject
mcp_accessobject
legacy_token_familystring
legacy_key_idstring
last_used_atstring date-time

Changes

  • adbca2e54ca7Revision changes
    • warning

      deleted the query request parameter include_budget

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 52477a31a784Revision changes
    • info

      added the new optional query request parameter include_budget

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status