RErespan
Temporary API Keys

Get a temporary API key

Changed on
get/api/temporary-keys/{id}/

Request

  • Base URL
    https://api.respan.ai
  • URL
    https://api.respan.ai/api/temporary-keys/{id}/
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the temporary API key to retrieve.

Response

API key details.

idstring

API key ID.

namestring

Key name.

prefixstring

Key prefix.

is_testboolean

Test or production key.

expiry_datestring date-time

Expiry date.

max_usageinteger

Max usage count. -1 = unlimited.

rate_limitnumber nullable

Requests per minute. null uses the organization default.

spending_limitnumber nullable

Spending limit in USD. null when not set.

createdstring date-time

When the API key was created.

unique_organization_idstring nullable

Owning organization UUID.

Changes

  • c30bcb383ee8Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response's property type changed from number null to number, and format from double to no format for status

    • breaking

      the response's property type changed from number null to number, and format from double to no format for status

    • info

      api operation id temporaryApiKeys_retrieveApiKey removed and replaced with retrieveApiKey

    • info

      api tag Temporary API Keys added

    • info

      api tag temporaryApiKeys removed

  • b830b79cfd52Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status