Skip to content

feat(api-catalog): add auth + signup_cta fields to discovery metadata (BUY-31214)#147

Merged
BuyWhere merged 1 commit into
mainfrom
lyra/buy-31214-api-catalog-auth-field
Jun 17, 2026
Merged

feat(api-catalog): add auth + signup_cta fields to discovery metadata (BUY-31214)#147
BuyWhere merged 1 commit into
mainfrom
lyra/buy-31214-api-catalog-auth-field

Conversation

@BuyWhere

Copy link
Copy Markdown
Owner

Context

BUY-31214 KPI 3 = 280/1000, 14d left, 0 today. Top-of-funnel CTA amplification is the highest-leverage move available while board approval 67981867 (OpenTools) is pending.

The /.well-known/api-catalog endpoint is the canonical machine-readable API contract that agents hit during discovery. Every agent that lands on api.buywhere.ai for the first time does well-known discovery to learn how to authenticate. Today, that endpoint has no auth field — agents who consume it literally cannot learn how to obtain an API key without doing a separate page load.

Change

Add two fields to the api-catalog JSON response:

"auth": {
  "type": "api_key",
  "header": "Authorization: Bearer",
  "obtain_at": "https://buywhere.ai/api-keys",
  "free": true
},
"signup_cta": "Get your free API key in 60 seconds → https://buywhere.ai/api-keys"
  • auth is a structured spec agents can parse (matches the format already used in ai-plugin.json)
  • signup_cta is a human-readable line for agent/operator logs
  • free: true explicitly signals no credit card at signup

Verify

  • obtain_at URL https://buywhere.ai/api-keys returns 200 with working email+use-case form (verified 2026-06-17 01:50Z)
  • The endpoint is already linked in the Link: header on every api.buywhere.ai response (rel=api-catalog)
  • One-file change, 7 lines added

Tracked under

BUY-31214 Jun 5-30 API key registration amplification push. Same CTA amplification wave as:

… (BUY-31214)

Agents that hit https://api.buywhere.ai/.well-known/api-catalog during
discovery (the canonical machine-readable contract) had no way to learn
how to obtain an API key. Add an auth object (type, header, obtain_at,
free) and a signup_cta pointing to https://buywhere.ai/api-keys.

This is the highest-leverage surface for agent-driven signups — every
agent that lands on the API for the first time does /.well-known/* discovery.
Verified live: api.buywhere.ai returns the well-known headers on every
response (Link: </.well-known/api-catalog>; rel=api-catalog). CTA path
200 with working email+use-case form (verified 2026-06-17 01:50Z).

Tracked under BUY-31214 Jun 5-30 API key registration amplification push.
Same wave as PR #141 (landing.ts) and PR #29 (npm README).
@BuyWhere BuyWhere merged commit a59593e into main Jun 17, 2026
0 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant