Exchange an emailed claim token for the API key

Spends the token emailed by POST /v1/keys and returns the key. The key is shown ONCE — only a peppered hash is stored, so it can never be read back; if you lose it, rotate. The key works only on this API, and the allowance it is issued with reflects your account: your paid plan when you have one, the free sandbox allowance when you do not.

post/v1/keys/claim

Request

  • Base URL: https://agentmandate-api.com
  • URL: https://agentmandate-api.com/v1/keys/claim
  • Auth: none required

Request body

tokenstring required

The claim token from the verification email.

Response

Success

apiKeystring

Shown once and never again. Store it now.

keyIdstring

Use this with /v1/keys/{id}/revoke and /v1/keys/{id}/rotate.

productstring

The key works only on this API.

quotaPerPeriodinteger nullable
planstring

The tier this allowance came from, or "sandbox" on the free tier.

warningstring
usagestring
requestIdstring

Changes

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