keys

Create an API key

Mint a key for this account. The plaintext is in the response and nowhere else: it is never stored in readable form and cannot be recovered. A key may hold any scope except keys:manage: a credential that could create credentials would outlive its own revocation. At most 25 active keys per account.

post/keys

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/keys
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Request body

expiresAtstring date-time nullable

When the key stops working. Omit for a key that does not expire.

namestring required

What this key is for. Shown in the console and in the account's audit trail.

rateLimitPerDayinteger nullable

A daily request cap for this key alone (up to 864000, the per-minute ceiling run for 24 hours).

rateLimitPerMinuteinteger nullable

A ceiling below the rate class's own. Cannot raise it.

scopesstring[] required

What the key may do. At least one, and from this list only: two scopes are never on it. keys:manage is withheld because a key that could mint keys would outlive its own revocation, and assistant:use because the in-app assistant is for people in the dashboard, not for integrations.

Response

Create an API key

keystring required

THE KEY. This is the only time it is shown: it is never stored in readable form and cannot be recovered. Save it now; if it is lost, rotate.

Changes

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