KEkeywordsai
Temporary API Keys

Create a temporary API key

Changed on
post/api/temporary-keys/

Request

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

Request body

namestring

Key name.

expiry_datestring date-time

Expiry date (ISO 8601).

max_usageinteger

Max usage count. -1 = unlimited.

rate_limitinteger

Calls per minute. Overridden by plan limit.

spending_limitnumber

Spending limit in USD for gateway usage.

is_testboolean

Test key (true) or production key (false).

Example request

{
  "name": "Production Key",
  "expiry_date": "2025-12-31T23:59:59Z",
  "max_usage": -1
}

Response

Created API key.

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.

api_keystring

The API key value. Only returned on creation - store it securely.

key_usageinteger

Number of times this key has been used.

createdstring date-time

When the API key was created.

unique_organization_idstring nullable

Owning organization UUID.

Example response

{
  "api_key": "vcjRcdm8.5hSZiXrA698O6KAiWX5CJj8Zrbp0H6gV"
}

Changes

  • c30bcb383ee8Revision changes
    • breaking

      request body became required

    • breaking

      the // request property type changed from number null to number, and format from double to no format

    • 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_createApiKey removed and replaced with createApiKey

    • info

      api tag Temporary API Keys added

    • info

      api tag temporaryApiKeys removed

    • info

      the request property // became nullable

    • info

      the request property // became nullable

    • info

      the // request property format was generalized from double to no format

    • info

      the request property format was generalized from double to no format

  • b830b79cfd52Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status