This repository provides a comprehensive JavaScript SDK suite for interacting with the Coze API, targeting developers building applications across Node.js, web, and mini-program environments (Taro, UniApp). It simplifies integration with Coze's AI capabilities by offering distinct packages for core API access and real-time communication, accelerating development and enabling richer chatbot experiences.

How It Works

The project is structured as a monorepo managed by Rush, housing multiple independent SDK packages. Key packages include @coze/api for standard API interactions, @coze/realtime-api for real-time features, and specialized SDKs like @coze/taro-api and @coze/uniapp-api tailored for mini-program frameworks. This modular approach facilitates focused development and easier management of dependencies across diverse platforms.

Quick Start & Requirements

• Primary Install: Clone the repository (git clone git@github.com:coze-dev/coze-js.git).
• Prerequisites: Node.js 18+ (LTS/Hydrogen recommended), pnpm 9.12.0, and Rush 5.140.0 are required. Global installation of pnpm and Rush is necessary (npm i -g pnpm@9.12.0 @microsoft/rush@5.140.0).
• Setup: Install project dependencies using rush update followed by rush build.
• Documentation: Links to Official Documentation, Contributing Guidelines, and publishing information are provided.

Highlighted Details

• Offers dedicated SDKs for Node.js, React web, Taro (v3/v4), and UniApp (v2/v3) mini-programs.
• Includes specific packages for real-time API interactions (@coze/realtime-api) with various demo examples available.
• Provides examples for advanced use cases such as OAuth server integration and simultaneous interpretation extensions.

Maintenance & Community

The provided README does not detail maintainers, community channels (e.g., Discord/Slack), or a public roadmap.

Licensing & Compatibility

Licensed under the MIT License, permitting broad commercial use and integration with closed-source projects without significant restrictions.

Limitations & Caveats

Setup requires specific versions of Node.js, pnpm, and Rush, potentially posing an initial hurdle for users not already utilizing these tools. The README lacks explicit details on community support, contribution workflows beyond a mention, or comprehensive API stability guarantees.