Reference

This section is the lookup table for the SDK and plugin API. The Develop guides explain how things fit together; these pages give you the exact shape of each symbol — signature, parameters, return type, required capability, and limits — so you do not have to open the source.

Looking for the HTTP API? That is a different thing: the server serves an interactive OpenAPI reference at /openapi while OPENAPI_DOCS_ENABLED=true (the default). This section documents the TypeScript SDK and the plugin runtime, not the raw HTTP endpoints.

Everything here is derived from the TypeScript sources of the ReelVault/sdk repository:

• reference/client/* — @reelvault/sdk/client: configuration, errors and the resource clients.
• reference/plugin/host — the PluginHost (host.*) every backend plugin receives.
• reference/plugin/events — every server event and hook.
• reference/ui/host — the live host object a plugin's custom elements receive.
• reference/ui/schema — every declarative UI node, field and action.
• reference/config — plugin.json, config schemas and catalog entries.
• Glossary — every term these docs use, explained plainly.

Conventions used on these pages

• Signatures are copied from the SDK's TypeScript types. ? marks an optional member; readonly means the host owns the value.
• Capability names (metadataProvider, jobs, …) gate which host.* namespaces a plugin may touch. They are the only gate and are declared in plugin.json — see Manifest.
• Limits (sizes, quotas, timeouts) come from the server's own constants and are enforced at runtime.

See also

• SDK overview — how the package is structured and consumed.
• Host API — the task-oriented tour.
• Frontend (ui.json) — declaring UI surfaces.