Document API #53

New issue

Closed

opened 2026-09-21 18:04:32 +01:00 by cruelacid · 1 comment

cruelacid commented

2026-09-21 18:04:32 +01:00

Owner

Part of #37. Depends on the headless client.

What Relay does

"API access to your Relay Server — documented API for external applications,
enabling automation workflows, AI integration and custom applications" is
Active on their roadmap and a Premium line item. No public documentation
of it exists that I could find, so it is announced rather than shipped.

What ours must be

Same constraint as the Git mirror: the server cannot serve plaintext, so the API
is local — served by the headless client or the plugin, against decrypted
content, on the customer's machine.

That is a real difference from theirs and worth stating plainly: their document
API is a cloud endpoint, ours is a local one. Ours cannot be called by a SaaS
integration without the customer running something. In exchange, no third party
ever holds readable content.

Risk

risk:additive.

Verification

The API is proven to serve only decrypted-locally content and to require keys the
server does not hold — assert it, since this is the claim the product is built on.

Part of #37. Depends on the headless client. ## What Relay does "API access to your Relay Server — documented API for external applications, enabling automation workflows, AI integration and custom applications" is **Active** on their roadmap and a **Premium** line item. No public documentation of it exists that I could find, so it is announced rather than shipped. ## What ours must be Same constraint as the Git mirror: the server cannot serve plaintext, so the API is **local** — served by the headless client or the plugin, against decrypted content, on the customer's machine. That is a real difference from theirs and worth stating plainly: their document API is a cloud endpoint, ours is a local one. Ours cannot be called by a SaaS integration without the customer running something. In exchange, no third party ever holds readable content. ## Risk `risk:additive`. ## Verification The API is proven to serve only decrypted-locally content and to require keys the server does not hold — assert it, since this is the claim the product is built on.

cruelacid added this to the Phase 18 - Agents and headless milestone

2026-09-21 18:04:32 +01:00

cruelacid added the

labels

2026-09-21 18:04:32 +01:00

cruelacid referenced this issue

2026-09-21 18:08:51 +01:00