API Reference

Jellyfish API is composed of three layers

• a REST API for managing Jellyfish state
• a WS connection for client SDK communication (socket path /socket/peer)
• a WS connection for server notifications (socket path /socket/server)

You can find them here:

• OpenAPI REST description
• Protobufs used by peer WS
• Protobufs used by server WS

The communication via WebSockets uses Protobuf format. The very first message that has to be sent on either of the WebSocket connections (peer to Jellyfish or your_backend_server to Jellyfish) is AuthRequest. All supported messages are listed in the Jellyfish protos repo.

If you want to create your own Jellyfish SDK, the easiest way to reference defined protobuf messages will be by adding protos to your git repository as a git submodule. You can do it with this command:

git submodule add https://github.com/jellyfish-dev/protos

You could also consider creating a script that will pull the newest changes from the git submodule and compile .proto files to your chosen programming language. For reference, see the script used in our Elixir SDK.