keys

Mint Key

Create another key on your account.

The value is in this response and nowhere else. Keys are stored as hashes, so a key that is not written down is a key that has to be replaced rather than recovered.

Every key on an account shares that account's credits, job history and job ceilings, and carries its own request rate limit. Several is the ordinary arrangement: one per service or per environment, so that revoking one does not stop the others.

This is also how you rotate without downtime — create the new key, move your clients onto it, then revoke the old one. There is no window in which nothing works, which is why there is no single "rotate" call.

An account is given a limited number of new keys in any hour, whichever of its keys asks; past it this is refused with 429 and Retry-After. Revoking is never limited. Each request also counts against the calling key's own request rate, as a submission does.

post/v1/keys

Request

  • Base URL: https://api.craterview.ai
  • URL: https://api.craterview.ai/v1/keys
  • Auth: HTTP bearer

Request body

namestring

A label to tell this key from your others in a listing. Not a secret and not interpreted.

Response

Successful Response

idstring required

Identifies this key, for revoking it.

keystring required

The key itself. This is the only time it is returned — it is stored as a hash, so it cannot be shown again and cannot be recovered for you.

prefixstring required

The opening characters of the key, for telling your keys apart once the secret is no longer shown.

namestring required

The label you gave this key.

rate_limit_per_minuteinteger required

Requests a minute this key may make before it is throttled.

Changes

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