Plugin API reference
English reading guide. The complete Chinese specification remains the authoritative source for exact fields, examples, implementation status, and historical details. This page is a concise guide, not a full translation.
Treat API contracts as versioned boundaries
Match the declared capability, Host API range, SDK exports, and machine-readable contract. An exported low-level type does not grant permission to use an internal bridge.
Keep stable contribution IDs. Validate intent source, action ID, and payload before handling actions, and unregister handlers during cleanup.
Handle unavailable capabilities, permissions, account changes, and stale asynchronous results explicitly. Avoid reporting success until the actual operation is confirmed.
Consult the Chinese reference for exact request and response fields, error codes, support matrices, and candidate versus released capabilities.
Continue reading
- Complete Chinese specification
- Documentation overview
- Plugin development
- API reference
- Packaging and submission
Source: docs/plugin-api-reference-v1.md.