keys.create

Make a named agent key for one shop (owner only). The owner accepts the agent key terms by passing accept_terms_version. Optional scopes narrow the key: read_only (no changes) and no_money (no charges, refunds or payment changes). A key never does more than the owner can. The key is shown once, here, and never again.

WhoA person's own sign-in only (agent tokens are refused)
RESTPOST /v1/keys
MCP toolNot an MCP tool
Writesyes, send an Idempotency-Key
AreaSign-in and agent access

When to use it

Make a named agent key for one shop (owner only). The owner accepts the agent key terms by passing accept_terms_version.

What to tell the owner

Ask the person to do this with their own sign-in. Your agent token is refused here.

Input

FieldTypeRequired
shop_idstringyes
labelstringyes
scopesarrayno
audiencestring (one of any, mcp)no
accept_terms_versionstringyes

Example

POST https://doingwork.work/v1/keys
content-type: application/json
Idempotency-Key: 3f1c...

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "label": "...",
  "accept_terms_version": "..."
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.