The API storybook · Start here
Choose a path. Leave with a checked result.
Use one guide to try the service, create durable work, research with evidence, manage customer-controlled context, or find any operation in the live API contract.
The fairy-tale language is navigation. The labels, HTTP methods, availability states, and trust boundaries below are literal.
Four trailheads
Start with what you need to accomplish.
Each route begins with a customer outcome and points to the smallest useful part of the contract.
See one result without an account
List the customer jobs, inspect onboarding, and run a bounded trial that performs no external action.
GET /v1/jobs · POST /v1/trial
Create durable, idempotent work
Submit an objective, keep the returned status URL, and read the completion receipt instead of guessing from elapsed time.
POST /v1/agent-runs
Separate sources, inference, and approval
Start from a mission template, inspect state, and explicitly approve effects when the run reaches a boundary.
GET /v1/mission-templates
Use memory you can inspect and change
Search, relate, correct, quarantine, or forget customer-controlled context with provenance.
GET /v1/memory/controls
Chapter one · No key required
Try one bounded task.
Choose bounded_work_plan, decision_brief_outline, or research_question_map. The trial accepts no credentials, takes no external action, and writes no customer memory.
POST /v1/trial
Content-Type: application/json
{
"recipe_id": "bounded_work_plan",
"objective": "Prepare a checked launch checklist.",
"consent_to_process": true
}
Chapter two · Durable work
Retry safely with an idempotency key.
A repeated network request should read the same run instead of creating duplicate work. Poll the returned status_url and treat needs_attention or failed as real states.
Authorization: Bearer <core credential>. Workspace pilot keys authenticate only workspace and vault routes; they do not unlock core endpoints. See the access paths. Effect approval remains separate from possession of either credential.POST /v1/agent-runs
Authorization: Bearer YOUR_KEY
Idempotency-Key: launch-plan-001
Content-Type: application/json
{
"input": "Prepare a checked launch plan.",
"memory": false
}
The index at the crossroads
Find an endpoint by job, word, method, or path.
The directory loads directly from the current OpenAPI contract. Search for plain goals such as “trial,” “memory,” “budget,” “mission,” or “audit.”
Six contract chapters
Browse the public API without learning the machinery first.
Getting started
Research and decide
Continue with context
Trust and evidence
Platform setup
Beyond the core contract
Workspace services have honest signposts.
Pilot surfaces are reachable for bounded evaluation. Planned surfaces remain unavailable until their public contract and operational guarantees are ready.
Workspace
Create and manage workspace keys, inspect workspace account state, and enter the customer vault. This key is separate from a core API credential.
Schedules
Recurring work is not in the public contract yet. Treat it as unavailable until it appears in OpenAPI.
Connectors
Customer-authorized integrations are being hardened. OAuth is not publicly routed yet.
Customer vault
Search and export the customer’s own run history with tenant isolation.
/v1/vault
Trust is a contract, not a costume
Read the state, evidence, boundary, and remainder.
State
Accepted, planning, awaiting approval, executing, verifying, completed, failed, or needs attention.
Evidence
Use the returned receipt and digests. A persuasive explanation is not a readback.
Boundary
An API key authenticates a customer. It does not silently approve external effects.
Remainder
Unresolved uncertainty stays visible instead of being rewritten as success.