API Changelog
NexSpace uses date-based API versioning. Breaking changes ship only under a new version date; additive, non-breaking changes (new fields, new endpoints) roll out to all active versions and are listed here under Additive changes.The machine-readable source of truth for supported versions is
GET https://api.nexspace365.com/.well-known/api-versions. Pin your
integration with the NexSpace-Version header.Versions
2026-07-24 — Headless AI follow-on
Extends the headless stack after Tiers 1–3:
-
Broadened event triggers.
eventautomations now fire onstaff.onboarded,lead.qualified, andcredential.expiredin addition to the shift events. See Agent Automations. -
Run-outcome auto-disable. A trigger’s
consecutiveFailuresstreak now counts runs that error mid-flight (not just dispatch failures); a completed run resets it. The auto-disable quarantine therefore reacts to agents that repeatedly error, not only ones that fail to enqueue. -
MCP Streamable-HTTP. Send
Accept: text/event-streamon atools/callto receive the response as SSE. Supplyparams._meta.progressTokento also getnotifications/progressframes. Streams are resumable: reconnect toGET /mcp/stream/{streamId}(from theMcp-Stream-Idresponse header) with aLast-Event-IDheader to replay missed frames. -
CLI
agents run. Start and stream a headless run from the terminal, with--output-format stream-jsonfor line-delimited JSON (NDJSON) events. - Status: Latest · stable
- Sunset: none
2026-07-23 — Headless AI Tiers 1–3
The full headless agent stack: the agent-run API (agents:run) with resumable
SSE, MCP request-id correlation + idempotency, and registry tool outputSchema
(Tier 1); the approval-resolution loop with agents:approve, the rejected
run status, run lifecycle webhooks, and run list/cancel (Tier 2); and
in-product agent automations — cron schedule and event triggers
(/api/agent-builder/{id}/triggers) that fire agents through the durable run
path with a privilege-escalation guard and per-mutation audit (Tier 3). See
Agent Automations.
- Status: Stable
- Sunset: none
2026-05-10 — Initial public API
The headless ecosystem launch: API keys, OAuth 2.1 (PKCE + Dynamic Client
Registration), the hosted MCP server, curated agent verbs, idempotency,
sandbox test keys, and usage analytics.
- Status: stable
- Sunset: none
Additive changes
Non-breaking improvements applied to all active versions. These do not require a version bump — your existingNexSpace-Version pin keeps working.
-
@nexspace/cli@0.2.0agent surface — discovery loop (search→mcp schema→--dry-run), first-class MCP verb commands,skill install,context use, webhooks +events listen(HMAC), approvals / audit /logs tail, fixtures, andconformance run. See CLI Overview and Commands. The CLI ships on its own semver, independent of the dated API versions above — nothing here changes the REST contract. Note that 0.2.0 does change the CLI’s default output format for scripts: see Output format. 0.2.0 also fixes the documented exit codes, which never actually worked: the bin entrypoint collapsed every failure to1, so2(auth) and3(bad input) were unreachable. Agents branching on exit status will now see the distinct codes instead of a uniform1. -
Rate-limit headers on every API-key response —
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset,X-RateLimit-Window, andX-RateLimit-Policynow accompany every API-key-authenticated response (and the429), so agents can throttle proactively. See Rate Limits. -
Structured error contract for agents — error responses now carry
suggestionandretryablefields (and, over MCP, aSuggestion:line in tool-error text) so LLM agents can self-correct. See Error Handling. -
Webhook retries & auto-disable — failed deliveries now retry on a fixed
exponential backoff (30s, 2m, 15m, 1h, 6h). After the initial send plus 5
retries all fail, the subscription is automatically disabled and its creator is
notified; re-enable it with
PATCH /api/webhooks/{id}. See Webhooks → Retry Policy. -
On-demand sandbox reset —
POST /api/sandbox/resetclears a facility’snex_test_sandbox rows and re-seeds a small synthetic dataset for a clean slate. See Sandbox. Prefernexspace fixtures sandbox-reset --facility-id Nwhen using the CLI (session auth only). -
Credential-agnostic identity probe —
GET /api/auth/mereturns the identity a credential authenticates as, accepting any supported credential (API key, PAT, OAuth access token, or session). It’s the shared “who am I” endpoint for the CLI (nexspace whoami), SDKs, and MCP clients. See Authentication → Verify identity.
Deprecation policy
- 12-month window — a deprecated version keeps working for at least 12
months. During that window responses include RFC 8594
DeprecationandSunsetheaders. - After sunset — requests pinned to a removed version return
410 Gonewith codeVERSION_SUNSET. Upgrade to the latest version to resolve. - Migration notes for each new version are published on this page before the previous version’s sunset date.

