Documentation
Documentation
Private local M1 candidate. Hosting and external acceptance remain open.
Versioned canonical source. An update timestamp is not supplied by this content registry.
PDF uses your browser’s print dialog. It is not a hosted export service.
The guides explain how clients use the canonical Control API, Task voice, Realtime RTC, Room, Source, SignalStream, Task and Artifact contracts. Generated reference is authoritative when prose and registry output disagree. Both SDKs are private local candidates: neither is published, and Staging is NOT-RUN — requires authorized Staging environment.
Quickstarts#
- JavaScript Quickstart: Task voice (explicit audio input and a Task result over the OneSay Realtime WebSocket) and Realtime RTC (publications, subscriptions, data, RPC and explicit Agents) from the installed local package. The local paths run against owned local services; deployed Staging and a public package are not available.
- ESP32 Quickstart: Task voice from an exported ESP-IDF application and the Realtime RTC component integration. These commands build an application; flashing, provisioning and the required real-device SDK smoke are not covered and remain NOT-RUN.
SDK reference#
- JavaScript SDK Reference: environments, Task and RTC entry points, session states and declared capabilities.
- ESP32 SDK Reference: component,
Task and RTC entry points, declared capabilities with their limitations,
and what the pinned
runtime_implemented: falsegate means. - SDK Capability and Compatibility: the two-SDK support matrix, unsupported and not exposed entries, the RTC lifecycle, Task recovery, limits and privacy, and the contract-gate labels.
- Canonical Reference: the public API operations, events, Grants and errors.
Security and identity#
- Credential Safety: browser, server and device boundaries.
- Authentication: Human, server, device and internal-service identity paths.
- API Keys: environment prefixes, display-once storage and revoke behavior.
- Device Provisioning: one-time code, per-device secret and short token flow.
- Authorization: server-owned scope, Grants, deny precedence and audit order.
Source and provenance
View original Markdown
# Documentation The guides explain how clients use the canonical Control API, Task voice, Realtime RTC, Room, Source, SignalStream, Task and Artifact contracts. Generated reference is authoritative when prose and registry output disagree. Both SDKs are private local candidates: neither is published, and Staging is NOT-RUN — requires authorized Staging environment. ## Quickstarts - [JavaScript Quickstart](JAVASCRIPT_QUICKSTART.md): Task voice (explicit audio input and a Task result over the OneSay Realtime WebSocket) and Realtime RTC (publications, subscriptions, data, RPC and explicit Agents) from the installed local package. The local paths run against owned local services; deployed Staging and a public package are not available. - [ESP32 Quickstart](ESP32_QUICKSTART.md): Task voice from an exported ESP-IDF application and the Realtime RTC component integration. These commands build an application; flashing, provisioning and the required real-device SDK smoke are not covered and remain NOT-RUN. ## SDK reference - [JavaScript SDK Reference](../reference/generated/javascript-sdk-draft.md): environments, Task and RTC entry points, session states and declared capabilities. - [ESP32 SDK Reference](../reference/generated/esp32-sdk.md): component, Task and RTC entry points, declared capabilities with their limitations, and what the pinned `runtime_implemented: false` gate means. - [SDK Capability and Compatibility](../reference/generated/sdk-compatibility.md): the two-SDK support matrix, unsupported and not exposed entries, the RTC lifecycle, Task recovery, limits and privacy, and the contract-gate labels. - [Canonical Reference](../reference/generated/catalog.md): the public API operations, events, Grants and errors. ## Security and identity - [Credential Safety](CREDENTIAL_SAFETY.md): browser, server and device boundaries. - Authentication: Human, server, device and internal-service identity paths. - API Keys: environment prefixes, display-once storage and revoke behavior. - Device Provisioning: one-time code, per-device secret and short token flow. - Authorization: server-owned scope, Grants, deny precedence and audit order.