Skip to content
Patomic

Create a new API key for the authenticated user

POST
/v1/keys

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
name
required
string
>= 1 characters <= 255 characters
rate_limit_rpm
integer
>= 1 <= 100000
expires_at
integer
nullable

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Key created. The plain_key field is returned exactly once and is not retrievable again.

object
id
required
string
name
required
string
key_prefix
required
string
rate_limit_rpm
required
number
last_used_at
required
number
nullable
expires_at
required
number
nullable
created_at
required
number
revoked_at
required
number
nullable
plain_key
required

The plain API key. Returned exactly once at creation time. Save it immediately.

string

400

Section titled “400 ”

Request body failed validation.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

401

Section titled “401 ”

Missing or invalid API key.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

429

Section titled “429 ”

Rate limit exceeded.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable

500

Section titled “500 ”

An unexpected error occurred.

object
error
required
object
type
required
string
Allowed values: authentication_error rate_limit_error invalid_request_error idempotency_error not_found_error internal_error
code
required
string
Allowed values: unauthorized rate_limit_exceeded invalid_idempotency_key idempotency_key_conflict invalid_parameter not_found internal_error
message
required
string
param
required
string
nullable
docs_url
required
string format: uri
request_id
required
string
suggestion
required
string
nullable