settings

Create Api Key Endpoint

Mint a key. The plaintext is in this response and NOWHERE else — it is stored only as a bcrypt hash, so it cannot be shown again.

post/api/settings/api-keys

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/settings/api-keys
  • Auth: HTTP bearer

Request body

namestring required

Human label so a key can be identified later without revealing it, e.g. 'ATS integration' or 'Zapier'.

descriptionstring nullable
read_onlyboolean

Read-only keys are rejected on every write route (schedule, submit, trigger, upload, match, webhook changes).

sandboxboolean

Sandbox keys are free and isolated: they authenticate to a separate sandbox organisation, are never billed, and never reach a vendor. Use them to build an integration without paying for every mistake. They cannot see live data.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.