Skip to main content
GET
Observe a note enhancement
Only the note owner can observe enhancements. Use operation_id to read a specific operation; omit it for the latest operation, or idle when none exists. Accept: application/json returns {enhancement: ...}. Accept: text/event-stream opens an authenticated stream of enhancement events with the same JSON wrapper. Subscribe before starting an enhancement to show progress in an open editor. The stream replays the latest snapshot when reconnecting and, without operation_id, continues observing later operations. Each content is the full accumulated HTML preview: replace the previous preview rather than appending it. Compare operation_id and sequence together because the sequence restarts for each operation. SSE event IDs use <operation_id>:<sequence>. Statuses are idle, running, completed, and failed. A running preview is not saved; only completed with ai_note confirms the durable result. On failure, keep the previous saved content and read the latest note before retrying. See start enhancement and CLI status commands.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
enum<string>
default:application/json

Return a JSON snapshot or an authenticated SSE stream.

Available options:
application/json,
text/event-stream

Path Parameters

team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

note_id
string
required

Note ID is a numerical string that identifies a Note.

Query Parameters

operation_id
string<uuid>

Enhancement operation to observe; omit to observe the latest operation and future operations.

Response

Current enhancement snapshot or stream of full snapshots.

enhancement
object
required