Create an API key | Respan Docs

Create a new API key.

This endpoint expects an object.

namestringOptional

Key name.

expiry_datedatetimeOptional

Expiry date (ISO 8601).

max_usageintegerOptionalDefaults to -1

Max usage count. -1 = unlimited.

rate_limitintegerOptional

Calls per minute. Overridden by plan limit.

spending_limitdoubleOptional

Spending limit in USD for gateway usage.

is_testbooleanOptionalDefaults to false

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

Created API key.

idstring

API key ID.

namestring

Key name.

prefixstring

Key prefix.

is_testboolean

Test or production key.

expiry_datedatetime

Expiry date.

max_usageinteger

Max usage count. -1 = unlimited.

rate_limitinteger

Calls per minute.

spending_limitdouble

Spending limit in USD.

created_atdatetime

api_keystring

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

key_usageinteger

Number of times this key has been used.

401

Unauthorized Error

1	curl -X POST https://api.respan.ai/api/temporary-keys/ \
2	-H "Authorization: Bearer sk_live_xxxxx" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3	"name": "Temporary Access Key",
4	"prefix": "tmp_",
5	"is_test": false,
6	"expiry_date": "2024-12-31T23:59:59Z",
7	"max_usage": -1,
8	"rate_limit": 100,
9	"spending_limit": 500,
10	"created_at": "2024-06-01T12:00:00Z",
11	"api_key": "vcjRcdm8.5hSZiXrA698O6KAiWX5CJj8Zrbp0H6gV",
12	"key_usage": 0
13	}