feat(api-catalog): add auth + signup_cta fields to discovery metadata (BUY-31214)#147
Merged
Merged
Conversation
… (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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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-catalogendpoint is the canonical machine-readable API contract that agents hit during discovery. Every agent that lands onapi.buywhere.aifor the first time does well-known discovery to learn how to authenticate. Today, that endpoint has noauthfield — 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:
authis a structured spec agents can parse (matches the format already used inai-plugin.json)signup_ctais a human-readable line for agent/operator logsfree: trueexplicitly signals no credit card at signupVerify
obtain_atURLhttps://buywhere.ai/api-keysreturns 200 with working email+use-case form (verified 2026-06-17 01:50Z)Link:header on every api.buywhere.ai response (rel=api-catalog)Tracked under
BUY-31214 Jun 5-30 API key registration amplification push. Same CTA amplification wave as: