From 51a31483c27669cd61d77918e80f500bf06988e6 Mon Sep 17 00:00:00 2001 From: geobelsky Date: Wed, 18 Mar 2026 16:54:28 +0000 Subject: [PATCH 1/2] Replace alpha access with Quick Start reference in README Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 423eddb..014e5cb 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ **Official TypeScript SDK for the AXME platform.** Send and manage intents, observe lifecycle events, handle approvals, and access the enterprise admin surface — fully typed, Promise-based, works in Node.js and edge runtimes. > **Alpha** · API surface is stabilizing. Not recommended for production workloads yet. -> Alpha access: https://cloud.axme.ai/alpha · Contact and suggestions: [hello@axme.ai](mailto:hello@axme.ai) +> **Alpha** — install CLI, log in, run your first example in under 5 minutes. [Quick Start](https://cloud.axme.ai/alpha/cli) · [hello@axme.ai](mailto:hello@axme.ai) --- @@ -270,6 +270,6 @@ npm test ## Contributing & Contact - Bug reports and feature requests: open an issue in this repository -- Alpha access: https://cloud.axme.ai/alpha · Contact and suggestions: [hello@axme.ai](mailto:hello@axme.ai) +- Quick Start: https://cloud.axme.ai/alpha/cli · Contact: [hello@axme.ai](mailto:hello@axme.ai) - Security disclosures: see [SECURITY.md](SECURITY.md) - Contribution guidelines: [CONTRIBUTING.md](CONTRIBUTING.md) From 8f9c06a3319478c811fee3bca556eb0c55bbe490 Mon Sep 17 00:00:00 2001 From: geobelsky Date: Thu, 19 Mar 2026 12:43:18 +0000 Subject: [PATCH 2/2] docs: add human-in-the-loop section with 8 task types Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 014e5cb..3a1a8b3 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,56 @@ for await (const event of client.observe(intent.intent_id)) { --- -## Approvals +## Human-in-the-Loop (8 Task Types) + +AXME supports 8 human task types. Each pauses the workflow and notifies a human via email with a link to a web task page. + +| Task type | Use case | Default outcomes | +|-----------|----------|-----------------| +| `approval` | Approve or reject a request | approved, rejected | +| `confirmation` | Confirm a real-world action completed | confirmed, denied | +| `review` | Review content with multiple outcomes | approved, changes_requested, rejected | +| `assignment` | Assign work to a person or team | assigned, declined | +| `form` | Collect structured data via form fields | submitted | +| `clarification` | Request clarification (comment required) | provided, declined | +| `manual_action` | Physical task completion (evidence required) | completed, failed | +| `override` | Override a policy gate (comment required) | override_approved, rejected | + +```typescript +// Create an intent with a human task step +const result = await client.createIntent({ + intentType: "intent.budget.approval.v1", + toAgent: "agent://agent_core", + payload: { amount: 32000, department: "engineering" }, + humanTask: { + title: "Approve Q3 budget", + description: "Review and approve the Q3 infrastructure budget.", + taskType: "approval", + notifyEmail: "approver@example.com", + allowedOutcomes: ["approved", "rejected"], + }, +}); +``` + +Task types with forms use `form_schema` to define required fields: + +```typescript +humanTask: { + title: "Assign incident commander", + taskType: "assignment", + notifyEmail: "oncall@example.com", + formSchema: { + type: "object", + required: ["assignee"], + properties: { + assignee: { type: "string", title: "Commander name" }, + priority: { type: "string", enum: ["P1", "P2", "P3"] }, + }, + }, +}, +``` + +### Programmatic approvals (inbox API) ```typescript // Fetch and approve pending items