Onboarding

Issue a self-serve API key

Returns a working API key immediately, with no account and no human approval. Keys are limited to the public read scopes and mainly buy a higher rate limit; the key is shown once and stored only as a hash, so save it. Request env: "sandbox" to get a key whose writes are acknowledged and discarded.

post/api/v1/keys

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/keys
  • Auth: none required

Request body

namestring required

A short label for this key.

env'sandbox' | 'production'
scopesstring[]
contact_emailstring email

Example request

{
  "name": "my-shopping-agent"
}

Response

The key. Store it now; it is not retrievable.

object'api_key' required
api_keystring required

Shown once. Store it.

key_idstring required
namestring
scopesstring[] required
env'sandbox' | 'production' required
usagestring
documentation_urlstring uri

Changes

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