HTTP Routes
HTTP endpoints handle GraphQL requests, file transfers and device connections. See each endpoint below for its request format and authentication requirements.
Type Definitions
# HTTP
https://<device-host>:<https-port>
POST /graphql
POST /guest_graphql
POST /peer_graphql
GET /fs?id=<resource-id>&action=PREVIEW&size=SM
GET /zip/dir?id=<directory-resource-id>
GET /zip/files?id=<selection-archive-id>
POST /upload
POST /upload_chunk
POST /init
GET /health
POST /nearby
ANY /proxy/:peer/*path
# DLNA
GET/HEAD /dlna/description.xml
GET/HEAD /dlna/av-transport/scpd.xml
GET/HEAD /dlna/rendering-control/scpd.xml
POST /dlna/av-transport/control
POST /dlna/rendering-control/control
SUBSCRIBE/UNSUBSCRIBE /dlna/av-transport/event
SUBSCRIBE/UNSUBSCRIBE /dlna/rendering-control/event
GET/HEAD /dlna/media/:id
NOTIFY /dlna/callback
# WebSocket
wss://<device-host>:<https-port>/graphql?cid=<client-id>
wss://<device-host>:<https-port>/auth?cid=<client-id>
wss://<device-host>:<https-port>/screen?cid=<client-id>
wss://<device-host>:<https-port>/status?cid=<client-id>
wss://<device-host>:<https-port>/image_editor?cid=<client-id>Operations
POST /graphql
Main GraphQL endpoint. API-token mode uses c-id and Authorization: Bearer headers with JSON; login-session mode uses encrypted bodies.
curl 'https://<device-host>:<https-port>/graphql' \
-H 'c-id: <client-id>' -H ': Bearer <api-token>' \
-H 'Content-Type: application/json' \
--data '{"query":"{ app { deviceName capabilities access } }"}'GET /fs
Read an encrypted resource ID: c.CLIENT_ID.PAYLOAD for a session or s.SHARE_ID.PAYLOAD for an active share. Session links use the caller’s app.urlToken, not its GraphQL authentication token. Keep links private; revoking the owning session invalidates them. Actions: DESCRIBE returns authorized metadata and directory entries; PREVIEW, DOWNLOAD, PROBE and TRANSCODE serve the preview, original, media facts and converted stream. For PREVIEW, use size SM or LG. Byte ranges use the HTTP Range header.
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=PREVIEW&size=SM' -o thumbnail
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DOWNLOAD' -OJ
curl 'https://<device-host>:<https-port>/fs?id=<resource-id>&action=DESCRIBE'
# describe JSON: {"entry":{"url":"/fs?id=<resource-id>&action=DOWNLOAD","name":"example.txt","isDir":false,"sizeBytes":10},"children":[]}
# action: DESCRIBE | PREVIEW | DOWNLOAD | PROBE | TRANSCODE
# size: SM | LG (PREVIEW only); v: optional cache version
# Byte ranges use the HTTP Range header.
# id: c.<client-id>.<payload> or s.<share-id>.<payload>
# Session links use app.urlToken, not the GraphQL authentication token.
# Keep resource URLs private; revoking the owning session invalidates its links.GET /zip/dir
Download a ZIP for an authorized directory. Use the ordinary /fs resource ID for the directory, from a session or an active share. Concurrent archive jobs may return HTTP 429.
curl 'https://<device-host>:<https-port>/zip/dir?id=<directory-resource-id>' -o directory.zipGET /zip/files
Download a ZIP of selected files with a separate session-only ZIP_FILES ID. Ordinary /fs IDs and share IDs are not accepted.
curl 'https://<device-host>:<https-port>/zip/files?id=<selection-archive-id>' -o selection.zipGET /health
Unauthenticated reachability check. Returns the plain-text body OK.
curl 'https://<device-host>:<https-port>/health'POST /init
Requires c-id and enabled remote access. An empty body discovers configuration and returns authenticated=false. To check an existing session, encrypt the request envelope for POST /init with its authentication token. The response includes httpsPort (0 when no HTTPS listener is available); opaquePublicKey and TLS proof fields are conditional.
curl 'https://<device-host>:<https-port>/init' -X POST -H 'c-id: <client-id>'
# An empty body discovers configuration; it does not prove session authentication.
# To check a session, send an encrypted request envelope bound to POST /init.POST /guest_graphql
Encrypted share-scoped API with its own guest contract. c-id identifies an active share; an API token does not authorize a guest request.
# Share-scoped encrypted GraphQL, not an API-token request.
# c-id: <share-id>; request bound to POST /guest_graphql.
# Contract: plain-core/schema/guest-api.graphqls
query { sharedInfo { name readOnly requiresPassword entries { name relativePath isDir size } } }POST /peer_graphql
c-id: sender client ID. c-cid: chat channel ID. Channel messages include c-cid and use the channel key; direct peer requests omit it and use the paired key.
curl 'https://<device-host>:<https-port>/peer_graphql' \
-H 'c-id: <sender-client-id>' \
-H 'c-cid: <channel-id>' \
-H 'Content-Type: application/octet-stream' \
--data-binary @peer-request.bin \
--output peer-response.bin