Skip to main content

Using Z AI With Roo Code

Z AI (Zhipu AI) provides advanced language models with the GLM family. The provider offers region-aware routing with separate endpoints for international users and China mainland users.

Website: https://z.ai/model-api (International) | https://open.bigmodel.cn/ (China)

Getting an API Key​

International Users​

  1. Sign Up/Sign In: Go to https://z.ai/model-api. Create an account or sign in.
  2. Navigate to API Keys: Access your account dashboard and find the API keys section.
  3. Create a Key: Generate a new API key for your application.
  4. Copy the Key: Important: Copy the API key immediately and store it securely.

China Mainland Users​

  1. Sign Up/Sign In: Go to https://open.bigmodel.cn/. Create an account or sign in.
  2. Navigate to API Keys: Access your account dashboard and find the API keys section.
  3. Create a Key: Generate a new API key for your application.
  4. Copy the Key: Important: Copy the API key immediately and store it securely.

Available Models​

Roo Code automatically fetches all available models from Z AI's API based on your selected region.

For the complete, up-to-date model list and specifications, see the official provider documentation:

Configuration in Roo Code​

  1. Open Roo Code Settings: Click the gear icon () in the Roo Code panel.
  2. Select Provider: Choose "Z AI" from the "API Provider" dropdown.
  3. Select Region: Choose your region:
    • "International" (default) for global access
    • "China" for mainland China access
  4. Enter API Key: Paste your Z AI API key into the "Z AI API Key" field.
  5. Select Model: Choose your desired model from the "Model" dropdown. Available models depend on your selected region.

Defaults & Behavior​

  • Automatic Base URL: Selected region determines the API endpoint automatically:
    • International → https://api.z.ai/api/paas/v4
    • China → https://open.bigmodel.cn/api/paas/v4
  • Dynamic Models: Changing the region automatically updates the model catalog and target endpoint.
  • No Manual Base URL Needed: You typically do not need to configure a custom base URL.

Tips and Notes​

  • Region Selection: The region setting determines both the API endpoint and available models:
    • International: Uses https://api.z.ai/api/paas/v4
    • China: Uses https://open.bigmodel.cn/api/paas/v4
  • Automatic Base URL: Base URL is selected from your region; manual override is not required in typical setups.
  • OpenAI Compatibility: Z AI uses an OpenAI-compatible API, providing streaming responses and usage reporting.
  • Model Selection: Models are automatically filtered based on your selected region to ensure compatibility.
  • API Key Required: A valid API key is required for all requests. Ensure you've obtained one from the appropriate regional platform.
  • Pricing: Check the respective regional websites for current pricing information.