AIDE interface
The public, versioned contract between AIDE backends and IDE frontends.
The AIDE interface defines bidirectional communication between IDE frontends and AIDE backends through a validating relay. Softmax owns the contract. It uses AsyncAPI 3.0, JSON Schema, and JSON-RPC 2.0.
Version 1.0.0
- Interactive reference: operations, example exchanges, and clickable schemas. Download it as a standalone HTML file.
- AsyncAPI specification: the authoritative machine-readable contract, including every message and nested schema.
- Protocol rules: request semantics, errors, recovery, and the WebSocket binding.
- Example exchanges.
Frontends, AIDE backends, and the relay use the same versioned contract. The relay validates method direction, parameters, correlated responses, and their schemas. Releases are immutable; a connection selects an exact version.
Workspace state contains sessions, tasks, goals, and chat requests. Chat preserves OpenAI Chat Completions messages and chunks.
Reads are authoritative: every state a frontend shows is readable on demand, and notifications only make it appear sooner.
Browser state is separate: exposed DOM snapshots and explicit click, fill, or highlight requests.
Surface requests carry JSON objects the frontend and AIDE define: surface.event reports frontend state changes to AIDE, and surface.act lets AIDE act in the frontend.
AIDE can also ask a question that holds no work with clarification.request; the frontend answers later with clarification.response.
AIDE sends policy code for the frontend to deploy with policy.create and policy.update, and asks which policies the frontend holds with policy.list.
Commands request actions; recipients own their state. Every defined request may return unsupported without breaking the connection.
The AsyncAPI document describes the relay’s viewpoint: receive means the relay receives a message; send means it sends one.
The explorer labels logical directions as Frontend → AIDE and AIDE → Frontend.
The platform supplies the relay base URL and authentication. This documentation URL is not a relay endpoint.
OpenAI schemas are pinned to openai-python 2.54.0; see provenance and the OpenAI SDK third-party license. That license accompanies the bundled OpenAI schemas; it does not license the Softmax API.