FIELD NOTES / 07

Integration guides

Conceptual routes through the Hub and workspace APIs. Exact wire shapes remain in the generated contract.

01

Authentication

Sessions, bearer credentials, cookies, CSRF, and terminal authorization.

02

Hub and workspace boundaries

Know which service owns identity, lifecycle, documents, and terminals.

03

Workspace lifecycle

Register, start, observe, stop, and forget workspaces safely.

04

Clone jobs

Drive asynchronous clones, prompts, progress, and cancellation.

05

Streaming protocols

Consume the brokered live stream and clone job events over SSE.

06

Errors

Handle HTTP and stream failures without relying on display text.

07

Compatibility

Compare Hub and workspace revisions and apply migrations.