Onboarding

Register an agent: a sandbox API key with no body required

Zero-friction registration. POST with an empty body, plain text, a form, or the same JSON as /api/v1/keys and get a working key back at once: no account, no email, no approval. name defaults to self-serve agent key and env to sandbox; send env: "production" for a production key with the same public read scopes. A body shaped like RFC 7591 client metadata (redirect_uris, client_name) is treated as OAuth dynamic client registration instead. Also served at /register, /signup, and /api/agents/register.

post/api/register

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/register
  • 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.