Create a new scoped API key
Create an additional API key on the authenticated account, with its own name, scopes and compliance policy.
Create an additional API key on the authenticated account, with its own name, scopes and compliance policy.
Scopes narrow what a key may do — issue a key scoped to extract for an agent that should never be able to start a crawl. A key can only grant scopes the calling key already holds.
The raw key is returned once, in this response, and is stored hashed; there is no way to read it back. Unmetered.
Authorization
BearerAuth Your API key, sent as Authorization: Bearer wm_.... Keys are wm_ followed by 40 hex characters. Create one with POST /register (free, no auth) or POST /keys.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.wellmarked.io/keys" \ -H "Authorization: Bearer wm_your_api_key_here" \ -H "Content-Type: application/json" \ -d '{ "scopes": [ "string" ] }'{ "api_key": "string", "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "scopes": [ "string" ]}List your API keys (metadata only — never the raw keys)
List every developer key on the authenticated account, including revoked ones — a non-null revoked_at marks a key as dead.
Rotate the API key you're calling with (old key invalidated immediately)
Replace the key used to authenticate this request with a fresh one that inherits its name, scopes and policy.