Signal Studio / Docs / API / API documentation

API documentation

The marketplace, the forum and the release feed are served by a public HTTP API. Reading requires no key. Publishing requires a signed-in session.

Base URL: https://eeg.studio/api. All responses are JSON. Send a real User-Agent header: requests with a default library signature may be refused by the edge.

Catalogue

MethodPathDoes
GET/catalogList approved entries
GET/catalog/<id>One entry, full detail
POST/catalogPublish, requires sign-in
PATCH/catalog/<id>Edit your own entry
DELETE/catalog/<id>Remove your own entry
POST/catalog/<id>/downloadIncrement the install counter
GET/catalog/healthService status and item count

Query parameters on /catalog

NameValuesDefault
kindcard, workflow, extension, model, skinall
qfree text, full-text searchnone
sortdownloads, recentdownloads
limit1 to 500200
mine1, requires sign-inoff

An entry

GET /api/catalog?kind=card&limit=1
{
  "ok": true,
  "items": [{
    "id": "uuid",
    "kind": "card",
    "slug": "band-pass",
    "version": "1.0.0",
    "name": "Band Pass",
    "summary": "...",
    "readme": "...markdown...",
    "tags": ["filter"],
    "display_name": "...",
    "publisher": "...",
    "unique_id": "publisher.slug",
    "icon_url": "/api/files/...",
    "url": "/api/files/...",
    "file_size": 12345,
    "sha256": "...",
    "downloads": 42,
    "rating": 4.5,
    "min_app": "0.9.0",
    "platforms": ["windows", "macos"]
  }]
}
url and icon_url may be relative. If the value starts with /, prefix it with https://eeg.studio.

Files

GET/files/<key>Download an object
PUT/files/<key>Upload, requires sign-in. Keys must start with u/<your id>/

Releases

GET/release/latestCurrent build and its installers
GET/release/appcast.xmlSparkle and WinSparkle feed

Forum

GET/forum/postsList threads
POST/forum/postsCreate a thread
GET/forum/posts/<id>/repliesReplies
POST/forum/posts/<id>/voteToggle a vote

Reviews and publishers

GET/reviews/<itemId>Reviews for an entry
POST/reviews/<itemId>Leave or update your review, 1 to 5
GET/publishers/<slug>Publisher profile and their entries

Authentication

Reading is open. Writing requires a session token in the Authorization: Bearer <token> header. The identity is taken from the verified token, never from the request body, so an author cannot be set by the client.

Errors

StatusMeaning
400Malformed request
401Sign-in required
403Not yours, or not an administrator
404No such entry or endpoint
409That version or slug already exists
413File too large, 200 MB limit
503Backend unavailable

Error bodies are { "ok": false, "error": "message" }.