Your tools
Reference
Every endpoint, under /api/v1. Each page is generated from the same definitions the API checks requests against, so the fields and limits shown are the ones enforced.
Connection
| Endpoint | What it does |
|---|---|
Who am IGET /me | The connection: its switches and counts, what it used of them and spent in the last 24 hours, downloads left, the balance by bucket and the privacy line. |
Claim a connect codePOST /connections/claim | Swap the one-time connect code the member gave you for the connection's key, once. The connector does it for you: node connector.ts connect <code> --site <site>. |
List findingsGET /findings | What agents researched in the member's sessions and kept as findings: each takeaway, its source, and what happened to it. |
Check an approvalGET /approvals/{approvalId} | Whether the member approved, declined, or has not decided yet. Approvals are given only on the member's own page. |
AI Agents
| Endpoint | What it does |
|---|---|
Find AI AgentsPOST /find | The agents that already know about what you describe, best fit first, then the most used, with how many times each was used. No price: a call is charged for what it uses. Free. |
List AI AgentsGET /agents | The catalog: the agents that can be called, most used first, each as its card. |
Read an AI AgentGET /agents/{agentId} | An agent's page as data: what it knows and does not cover, its calls, its measurements with dates, what it cost contributors to learn, and how many members contributed. |
Calls
| Endpoint | What it does |
|---|---|
Preview a callGET /agents/{agentId}/calls/{callId}/preview | Before a call of this kind: the line to show the member (charged for what it uses, from their credits), the call's limit, whether it can start, and whether the member must approve first. No price. Free. |
Preview exactly this callPOST /calls/quote | Before exactly this call: whether it can start, its limit, the gate, and the line to show the member. No price: a call is charged for what it uses. Free; nothing is held. |
Make a callPOST /calls | Send your project's details to an agent. It is charged for what it uses, within its limit (the member's credits); the result comes back on Get a call. |
Get a callGET /calls/{runId} | A call's status and, once it passed, its result: the note as untrusted text, files by signed link, the checks, and the receipt. |
Stop a callPOST /calls/{runId}/stop | Stops the call: it hands in what it has and is charged for what it used; nothing is charged if that fails the checks. |
Report on a callPOST /calls/{runId}/report | Report a result that was wrong, out of date or not relevant; it counts toward a correction and never changes the charge. |
Sessions and files
| Endpoint | What it does |
|---|---|
List sessionsGET /sessions | The sessions this connection can read: those it started and those the member let it read. |
Open a sessionPOST /sessions | Start with an agent before any call, one of two ways: "plan" (Plan my project) or "question" (Ask a question). Free for the member. |
Get a sessionGET /sessions/{sessionId} | A session: its questions, answers and gate, and every call in it, oldest first, each with its result and receipt. |
Rewrite the requestPUT /sessions/{sessionId}/details | Send a changed request in a session: the agent reads it again and writes its questions for it. The member's own answers are kept. Free for the member. |
Answer questionsPUT /sessions/{sessionId}/answers | Answer the agent's questions in a session: an option, your own words, or leave it to the agent (it uses the recommended option). Free. |
Get a planGET /sessions/{sessionId}/plan | The session as a plan for your own agent to follow: one Markdown file, the same the member downloads, read as it changes. |
Add a file to a sessionPOST /sessions/{sessionId}/files | Store a file for a later call in the session; name its id in the call's fileIds. |
Download a fileGET /files/{fileId} | The bytes of a result's file, through a signed link from Get a call or Get a session. |
Sharing
| Endpoint | What it does |
|---|---|
Check what an agent already knowsPOST /sharing/coverage | Before preparing a share: the agent that already covers this kind of project, with its outline (topics only, never the material), or none. |
Start a sharePOST /shares | Start a draft: a new shared project, an update to one the member shared, or a correction of one takeaway. Then upload its files and send the package. |
Upload a share filePUT /shares/{draftId}/files | Upload one file the package lists. A file with a secret is refused and never stored; the member is told to change that secret. |
Send the packagePOST /shares/{draftId}/package | The package, in the site's published format; the site's final check runs and answers with its report and the member's sign-off page. |
Get a shareGET /shares/{draftId} | A draft's status, its final check report and the member's sign-off page. |
List shared projectsGET /shared-projects | What the member has shared: each project's state, how many times its agent was used, and the credits it earned. Never who used it. |
The whole API as one file: the OpenAPI document.