Softmax · Public interface

AIDE interface 1.0.0

Conversations, workspace state, and browser actions between an IDE frontend and AIDE.

Frontend → AIDEAIDE → FrontendJSON-RPC 2.0 · AsyncAPI 3.0 · JSON Schema

The download is a standalone HTML file. All types and examples work offline. The AsyncAPI file is the authoritative contract. Publication describes the contract; it does not enable a relay or certify an implementation.

Operations

Example exchanges

Application frames as seen by the frontend. The backend wraps each frame with frontend_id and message. Example expiry times are illustrative.

Schemas

How to read this contract

Every command requests action from its recipient. Sending task.cancel does not change the task's status. Use subsequent authoritative state updates.

Every defined request may return unsupported. This is a normal error response, not an invalid request. Keep the connection usable; do not automatically retry or fall back to another protocol.

Notifications have typed parameters and no response. An empty {} parameter schema is intentional for requests such as browser.snapshot.

Reads are authoritative; notifications are hints. Every state a frontend shows is readable on demand, and every notification carries the cursor of the read that recovers it.

Request validates the method and its specific parameters. State resources are restricted to sessions, tasks, goals, and requests. The relay also checks direction, pending request IDs, and corresponding result types.

The AsyncAPI document describes the relay: receive means the relay receives a message, and send means it sends one. This explorer labels the logical sender and recipient.

Read the normative rules for retries, recovery, approvals, browser safety, and endpoint qualification.