API reference

Canonical reference: cyoda help openapi

This page is the narrative; the binary is authoritative.

The REST API reference is rendered in a dedicated viewer so the documentation chrome does not compete with it for horizontal space:

Open the REST API reference

The viewer works from the OpenAPI spec shipped with this site (/openapi/openapi.json), which was extracted from cyoda-go v0.6.2. For the version you are running, cyoda help openapi on your own binary is authoritative.

The viewer supports the standard operations: browsing endpoints, inspecting request/response shapes, and try-it-out calls against an environment of your choice.

gRPC

gRPC proto documentation is tracked upstream and will appear here once the generated reference is published from cyoda-go. Until then, the .proto files in cyoda-go/api/grpc are the authoritative source.