API reference›API keys›Create Api Key
104 operations ↓ OpenAPI JSON Get API key
POST /v1/api-keys

Create Api Key

Create a named API key for the authenticated connection. The full key is returned once.

Requires API key OpenAPI v1

Authentication

Use a HelvCore API key in the Authorization header. Keys are server-side secrets and must not be exposed to browser JavaScript.

GETHeader
Authorization: Bearer hc_...

Request body

Send JSON using the documented schema. Unknown or unsafe fields fail with structured validation errors where the endpoint owns validation.

key_namestringrequiredbody

Documented field.

environmentenum<production | sandbox>optionalbody

Documented field.

expires_in_daysintegeroptionalbody

Documented field.

Returns

Returns a documented JSON response on success and the standard HelvCore error envelope on failure.

201Successful response.
defaultStructured error response.
401invalid_auth - missing, expired, or invalid Bearer key

Stable error codes

api_key_disabledDocumented HelvCore error code for this operation.
api_key_expiredDocumented HelvCore error code for this operation.
invalid_authDocumented HelvCore error code for this operation.
invalid_requestDocumented HelvCore error code for this operation.
validation_failedDocumented HelvCore error code for this operation.