Public agent API v3
Flow API
Agents and humans create independent Solve, Calibration, and Verification flows with a Bearer API key. Proof of work is recorded in the product UI. Headless session upload is not a public agent API.
Authentication
Mint a key in the dashboard Integrations tab. Bearer endpoints require an active API Metered plan. Cookie dashboard and in-app sessions do not.
Authorization: Bearer sk_… Content-Type: application/json
Each key is a single full-access token. MCP uses the same key on POST /api/mcp.
Rate limits
120 requests per minute per key. Exceeded returns 429 rate_limit_exceeded.
What you can create
- Flows — independent Solve, Calibration, and Verification at
/api/v3/flows. MCP toolslist_flows,create_flow,upload_flow_file,generate_flow_unsys_seed,get_flow,update_flow, anddelete_floware 1:1 with these REST twins. Create/update take one Author source: written problem, files, or a prepared board.
Choose one source. exact_problem_on_canvas is valid only with a written topic. Files as the problem source generate a new statement when a learner opens. opening_canvas_scene ignores exact problem. Prepared board wins if more than one source is sent.
POST /api/v3/flows
{
"kind": "solve",
"name": "Linear systems",
"topic": "Solve Ax = b",
"exact_problem_on_canvas": true,
"enforced_channels": { "audio": true, "muse": false, "video": false, "screenshots": false }
}
POST /api/v3/flows
{
"kind": "solve",
"name": "Decoder",
"artifacts": [{ "name": "brief.pdf", "xai_file_id": "file_…" }],
"generate_problem_on_open": true
}
POST /api/v3/flows
{
"kind": "verification",
"name": "Board flow",
"opening_canvas_scene": { "elements": [], "appState": {}, "files": {} }
}Endpoint index
MCP tools/list is 1:1 with these REST twins.
- GET /api/v3/flowslist_flows
List Solve, Calibration, and Verification flows owned by this key.
- POST /api/v3/flowscreate_flow
Create a Solve, Calibration, or Verification flow.
- POST /api/v3/flows/filesupload_flow_file
Upload a Problem-context file (PDF, text, image) and get an artifact pointer for create_flow / update_flow.
- POST /api/v3/flows/unsys-seedgenerate_flow_unsys_seed
Generate the Unsys model for a flow from the Problem, artifacts, and optional guidance (wizard model step).
- GET /api/v3/flows/{flow_id}get_flow
Read one Solve, Calibration, or Verification flow.
- PATCH /api/v3/flows/{flow_id}update_flow
Update a Solve, Calibration, or Verification flow.
- DELETE /api/v3/flows/{flow_id}delete_flow
Delete a Solve, Calibration, or Verification flow.
- GET /api/v3/knowledge-regions/{knowledge_region_id}/candidates/{candidate_id}get_knowledge_region_candidate
Render metrics for one candidate in a knowledge region: unsys distance, cluster L2, path and pairwise L2.
MCP
POST /api/mcp
Authorization: Bearer sk_…
{ "jsonrpc": "2.0", "id": 1, "method": "tools/list" }Partner loop: list_flows, then upload_flow_file → generate_flow_unsys_seed → create_flow → get_flow → update_flow. REST lives at /api/v3/flows.
Do not call start_session, upload_proof_of_work, or end_session. Those tools are not on the public catalog. Static skill: /skill.md.