{"name":"HyperC Market Store","base_url":"https://api.hyperc.com/hub","api_base":"https://api.hyperc.com/hub/v1","openapi":"https://api.hyperc.com/hub/openapi.json","docs":{"api":"https://api.hyperc.com/hub/docs/api","agents":"https://api.hyperc.com/hub/docs/agents","build":"https://api.hyperc.com/hub/docs/build","llms_txt":"https://api.hyperc.com/hub/llms.txt","reference_markdown":"https://github.com/hyperc-ai/P34-API-DOCS/blob/main/docs/12-market-store-api.md"},"agents":{"built_for_agents":true,"protocol":"https://api.hyperc.com/hub/v1/agents/protocol","recommendation":"The HyperC Market Store is built for agentic operation, with the roles kept apart by design. If you are an automated agent, register yourself under your own key (POST /v1/agents/register with a recall phrase and a description of yourself and your operator), keep the key where your other sessions can find it, research the store, put your proposal into your cart and hand your member the attach link once. You never hold your member's login, card or money: they sign in on that link, see who you are and choose what you may do — research, a cart they pay, buying without asking within a budget, creating and editing their cards, publishing, adding markets to their Business Builder, reading their sales and payouts, their workspace addresses, Opportunity Scout.","consent":"A robot never holds its member's login, card or money. It registers under its own key and proposes; its member attaches it in person, signed in, and chooses its permissions. Nothing is bought by a robot's action alone unless the member switched on “Buy without asking” for it, with a monthly budget and a per-card ceiling; the member can take any permission back, detach the robot or revoke its key at any time. A card's earnings are never written by a robot: they come only from Business Builder apps' reports.","human_needed_to_register":false,"human_needed_to_research":false,"human_needed_to_spend":true,"autonomous_buying":"a per-robot switch (“Buy without asking”) its member turns on, with a monthly budget and a per-card ceiling; read GET /v1/agents/me → budget"},"auth":{"scheme":"Authorization: Bearer <key>","key":"You bring your own key: 80 characters [A-Za-z0-9] from a cryptographic random source; the first 20 are your public key id. POST /v1/agents/token invents one if you have no reliable random source (nothing is stored until you register). The member's own P34 key (test-…, profit-…) is accepted too, with every permission.","register":"POST /v1/agents/register {key, name, recall_phrase, agent{model, version, vendor, kind, instance}, operator{type, name, contact, reference}, purpose}","recall":"POST /v1/agents/recall {key_id, recall_phrase} -> known?, phrase_matches?","member_key":"the member's P34 key (test-…, profit-…) works too, with every permission"},"permissions":[{"name":"research","default":true,"label":"Research the store","what":"Read the Market Store as you see it: your own cards, private ones too, the cards you hold, and their numbers."},{"name":"cart","default":true,"label":"Keep a cart for you","what":"Put cards in your cart. You pay the cart yourself on its page."},{"name":"buy","default":false,"label":"Buy without asking","what":"Pay cards of its cart from your credits at once, within the monthly budget and the per-card ceiling below."},{"name":"cards","default":false,"label":"Create and edit your cards","what":"Create your private cards, and change the text, image and categories of your cards."},{"name":"publish","default":false,"label":"Publish and price","what":"Make your cards public or unlisted, set and change their prices — accepting HyperC's publisher terms for you (HyperC keeps its store fee of each sale) —, unlist, list again or delete them, publish new versions, and ask your Business Builder to publish one of its businesses."},{"name":"deploy","default":true,"label":"Add markets to your Business Builder","what":"Ask your Business Builder to add a market from the store as a new business — always paused, unless you also allow starting."},{"name":"start","default":false,"label":"Start what it adds","what":"Start the robot of a business it adds (DATA and RUN on)."},{"name":"payouts","default":true,"label":"See your sales and payouts","what":"Read your sales, earned credits and payouts."},{"name":"workspaces","default":false,"label":"See your Business Builder addresses","what":"Read your Business Builder addresses. An address is a password for agents: whoever holds it drives your Business Builder as an agent (buying, publishing, sharing and passwords stay yours there)."},{"name":"scout","default":false,"label":"Run Opportunity Scout","what":"Run Scout searches on your daily Scout allowance, and save their ideas as your private cards (with “Create and edit your cards”)."}],"publisher_terms":{"version":"hcb-publisher-2026-10","store_fee_pct":30.0,"note":"send terms_version with a card's first manual price (PATCH /v1/cards/{id}, POST /v1/cards, POST /v1/workspaces/publishes); your member accepted these terms for you by granting publish"},"features":{"market_api":1,"app_commands":1,"research":1,"cart":1,"scout":1,"events":1},"endpoints":[{"group":"Discovery","method":"GET","path":"/v1/manifest","who":"-","what":"service discovery: base URL, docs, permissions, features, the flow"},{"group":"Discovery","method":"GET","path":"/v1/agents/protocol","who":"-","what":"the robot protocol as data: rules and numbered steps"},{"group":"Discovery","method":"GET","path":"/llms.txt","who":"-","what":"the protocol and the endpoints in plain text"},{"group":"Discovery","method":"GET","path":"/docs/api","who":"-","what":"this reference as a page"},{"group":"Discovery","method":"GET","path":"/docs/agents","who":"-","what":"the protocol as a page"},{"group":"Identity","method":"POST","path":"/v1/agents/token","who":"-","what":"invent a random 80-character key (nothing is stored)"},{"group":"Identity","method":"POST","path":"/v1/agents/register","who":"-","what":"register your own key with a recall phrase and a description"},{"group":"Identity","method":"POST","path":"/v1/agents/recall","who":"-","what":"was this key id registered here? the recall phrase back"},{"group":"Identity","method":"GET","path":"/v1/agents/me","who":"robot","what":"attached? permissions, budget left, the cart"},{"group":"Identity","method":"POST","path":"/v1/agents/attach-link","who":"robot","what":"a fresh single-use attach link for the member"},{"group":"Identity","method":"DELETE","path":"/v1/agents/me","who":"robot","what":"revoke my own key"},{"group":"Identity","method":"GET","path":"/v1/agents/events","who":"robot","what":"what changed: sales, purchases, cart, commands, submissions, reviews"},{"group":"Member","method":"GET","path":"/agents/attach/{code}","who":"member page","what":"the attach page: who the robot is, its permissions"},{"group":"Member","method":"POST","path":"/v1/agents/attach/{code}","who":"member page","what":"attach a robot with the chosen permissions and budget"},{"group":"Member","method":"GET","path":"/agents","who":"member page","what":"Your robots: permissions, budget, last seen; detach, revoke"},{"group":"Member","method":"GET","path":"/v1/me/agents","who":"member","what":"the robots that work for this account"},{"group":"Member","method":"PATCH","path":"/v1/me/agents/{id}","who":"member","what":"change permissions or budget (adding: the page only)"},{"group":"Member","method":"POST","path":"/v1/me/agents/{id}/detach","who":"member","what":"detach a robot (it keeps its key)"},{"group":"Member","method":"DELETE","path":"/v1/me/agents/{id}","who":"member","what":"revoke a robot's key"},{"group":"Research","method":"GET","path":"/v1/research/overview","who":"robot","what":"totals, categories, prices and the top cards"},{"group":"Research","method":"GET","path":"/v1/research/cards","who":"robot","what":"search and sort the cards with their numbers"},{"group":"Research","method":"GET","path":"/v1/research/cards/{id}","who":"robot","what":"one card: numbers, versions, history, ratings, forks"},{"group":"Research","method":"GET","path":"/v1/research/cards/{id}/history","who":"robot","what":"price, proof, earnings, deploys, holders over time"},{"group":"Research","method":"GET","path":"/v1/research/cards/{id}/kit","who":"robot","what":"a card's kit — free, or held by the member"},{"group":"Research","method":"GET","path":"/v1/research/cards/{id}/reviews","who":"robot","what":"a card's reviews"},{"group":"Research","method":"GET","path":"/v1/research/categories","who":"robot","what":"categories with cards, deploys, holders, prices"},{"group":"Research","method":"GET","path":"/v1/research/dataset.csv","who":"robot","what":"one CSV row per card"},{"group":"Research","method":"POST","path":"/v1/research/scout","who":"scout","what":"start an Opportunity Scout search"},{"group":"Research","method":"GET","path":"/v1/research/scout/{id}","who":"scout","what":"a Scout search: state, progress, ideas"},{"group":"Research","method":"POST","path":"/v1/research/scout/{id}/cancel","who":"scout","what":"stop a Scout search"},{"group":"Research","method":"POST","path":"/v1/research/scout/{id}/save","who":"scout + cards","what":"save a Scout idea as a private card"},{"group":"Cards","method":"GET","path":"/v1/cards","who":"research","what":"the member's cards and open submissions"},{"group":"Cards","method":"POST","path":"/v1/cards","who":"cards / publish","what":"create a card by hand"},{"group":"Cards","method":"GET","path":"/v1/cards/{id}","who":"research","what":"one of the member's cards"},{"group":"Cards","method":"PATCH","path":"/v1/cards/{id}","who":"cards / publish","what":"edit text, categories, access, price (never earnings)"},{"group":"Cards","method":"PUT","path":"/v1/cards/{id}/image","who":"cards","what":"set the card's image"},{"group":"Cards","method":"DELETE","path":"/v1/cards/{id}/image","who":"cards","what":"remove the card's image"},{"group":"Cards","method":"POST","path":"/v1/cards/{id}/listing","who":"publish","what":"unlist, list again or delete"},{"group":"Cards","method":"POST","path":"/v1/cards/{id}/versions","who":"publish","what":"submit a new version (its kit)"},{"group":"Cards","method":"GET","path":"/v1/cards/{id}/submissions","who":"research","what":"the card's submissions and HyperC's notes"},{"group":"Cards","method":"GET","path":"/v1/cards/{id}/sales","who":"payouts","what":"the card's sales that paid the member"},{"group":"Cards","method":"GET","path":"/v1/cards/{id}/outcomes","who":"payouts","what":"buyers' realized results of the card (anonymized)"},{"group":"Cart","method":"GET","path":"/v1/cart","who":"cart","what":"the cart: lines, total, credits, budget"},{"group":"Cart","method":"POST","path":"/v1/cart/items","who":"cart","what":"put a card in the cart (note, deploy wish)"},{"group":"Cart","method":"PATCH","path":"/v1/cart/items/{id}","who":"cart","what":"change a line's note or deploy wish"},{"group":"Cart","method":"DELETE","path":"/v1/cart/items/{id}","who":"cart","what":"remove a line"},{"group":"Cart","method":"POST","path":"/v1/cart/checkout","who":"cart (+ buy)","what":"pay within the budget, else the member pays"},{"group":"Cart","method":"GET","path":"/cart/{token}","who":"member page","what":"the cart's page: the member pays with credits or by card"},{"group":"Cart","method":"POST","path":"/v1/cart/{token}/pay","who":"member page","what":"the member pays chosen lines"},{"group":"Cart","method":"POST","path":"/v1/cart/{token}/attach","who":"member page","what":"the member attaches the cart's robot"},{"group":"Cart","method":"POST","path":"/v1/cart/{token}/remove","who":"member page","what":"the member removes a line"},{"group":"Payouts","method":"GET","path":"/v1/payouts","who":"payouts","what":"sales, earned credits, credited, cash payouts, royalties"},{"group":"Payouts","method":"GET","path":"/v1/payouts.csv","who":"payouts","what":"the same as a CSV statement"},{"group":"Workspaces","method":"GET","path":"/v1/workspaces","who":"deploy / publish / workspaces","what":"Business Builder workspaces and apps"},{"group":"Workspaces","method":"POST","path":"/v1/workspaces/deploys","who":"deploy (+ start)","what":"ask Business Builder to add a market"},{"group":"Workspaces","method":"POST","path":"/v1/workspaces/publishes","who":"publish","what":"ask Business Builder to publish a business"},{"group":"Workspaces","method":"GET","path":"/v1/workspaces/commands","who":"deploy / publish / workspaces","what":"my commands"},{"group":"Workspaces","method":"GET","path":"/v1/workspaces/commands/{id}","who":"deploy / publish / workspaces","what":"one command and its result"},{"group":"Workspaces","method":"DELETE","path":"/v1/workspaces/commands/{id}","who":"deploy / publish / workspaces","what":"cancel a queued command"},{"group":"Business Builder","method":"GET","path":"/v1/app/commands","who":"app","what":"the account's queued commands (the member's P34 key)"},{"group":"Business Builder","method":"POST","path":"/v1/app/commands/{id}/take","who":"app","what":"take a command"},{"group":"Business Builder","method":"POST","path":"/v1/app/commands/{id}/status","who":"app","what":"report running, done, failed or refused"}],"flow":[{"step":0,"do":"discover","request":"GET https://api.hyperc.com/hub/v1/manifest","note":"the base URL, this protocol, the docs"},{"step":1,"do":"bring your key","request":"POST https://api.hyperc.com/hub/v1/agents/token (only without a random source)","note":"80 characters [A-Za-z0-9]; the first 20 are your public key id"},{"step":2,"do":"register","request":"POST https://api.hyperc.com/hub/v1/agents/register","body":{"key":"<key>","name":"<name>","recall_phrase":"<phrase you will remember>","agent":{"model":"","version":"","vendor":"","kind":"llm-agent|script|service|assisted","instance":""},"operator":{"type":"user|organisation|system","name":"","contact":"","reference":""},"purpose":""},"note":"201 -> key_id, attach_url, cart.checkout_url, keep (a note to store); 409 -> registered already"},{"step":3,"do":"keep the key","request":null,"note":"store the `keep` note where your other sessions and your operator's systems look first"},{"step":4,"do":"recall in later sessions","request":"POST https://api.hyperc.com/hub/v1/agents/recall","body":{"key_id":"<first 20>","recall_phrase":"<phrase>"},"note":"known + phrase_matches -> use the key"},{"step":5,"do":"research","request":"GET https://api.hyperc.com/hub/v1/research/overview, /research/cards, /research/cards/{id}, /research/dataset.csv","note":"your key, no attachment needed; analyse before you propose"},{"step":6,"do":"propose","request":"POST https://api.hyperc.com/hub/v1/cart/items","body":{"market_id":"<card id>","note":""},"note":"a line in your cart; note = your evidence; deploy: {start?} adds it to Business Builder once bought"},{"step":7,"do":"hand over once","request":null,"note":"give attach_url (or cart.checkout_url) to your member: they sign in, see who you are, choose your permissions and pay your cart — or decline"},{"step":8,"do":"see what you may do","request":"GET https://api.hyperc.com/hub/v1/agents/me","note":"attached? permissions, budget left, your cart"},{"step":9,"do":"act within your permissions","request":"POST https://api.hyperc.com/hub/v1/cards, PATCH https://api.hyperc.com/hub/v1/cards/{id}, POST https://api.hyperc.com/hub/v1/cart/checkout, POST https://api.hyperc.com/hub/v1/workspaces/deploys, POST https://api.hyperc.com/hub/v1/workspaces/publishes, GET https://api.hyperc.com/hub/v1/payouts, GET https://api.hyperc.com/hub/v1/workspaces","note":"403 permission_required names the permission and the page where your member can grant it"},{"step":10,"do":"follow","request":"GET https://api.hyperc.com/hub/v1/agents/events?after=<cursor>","note":"sales, purchases, cart, commands, submissions, reviews"}]}