diff --git a/docs/providers/glm.md b/docs/providers/glm.md index 9d0873a0ef8..76ebc5f6ace 100644 --- a/docs/providers/glm.md +++ b/docs/providers/glm.md @@ -1,37 +1,61 @@ --- -summary: "GLM model family overview + how to use it in OpenClaw" +summary: "GLM model family overview and how to use it in OpenClaw" read_when: - You want GLM models in OpenClaw - You need the model naming convention and setup title: "GLM (Zhipu)" --- -# GLM models +GLM is a model family (not a company) available through the [Z.AI](https://z.ai) platform. In OpenClaw, GLM models are accessed through the bundled `zai` provider with refs like `zai/glm-5.1`. -GLM is a **model family** (not a company) available through the Z.AI platform. In OpenClaw, GLM -models are accessed via the `zai` provider and model IDs like `zai/glm-5`. +| Property | Value | +| ------------------- | --------------------------------------------------------------------------- | +| Provider id | `zai` | +| Plugin | bundled, `enabledByDefault: true` | +| Auth env vars | `ZAI_API_KEY` or `Z_AI_API_KEY` | +| Onboarding choices | `zai-api-key`, `zai-coding-global`, `zai-coding-cn`, `zai-global`, `zai-cn` | +| API | OpenAI-compatible | +| Default base URL | `https://api.z.ai/api/paas/v4` | +| Suggested default | `zai/glm-5.1` | +| Default image model | `zai/glm-4.6v` | ## Getting started - Pick the onboarding choice that matches your Z.AI plan and region: + Pick the onboarding choice that matches your Z.AI plan and region. The generic `zai-api-key` choice auto-detects the matching endpoint from the key shape; use the explicit regional choices when you want to force a specific Coding Plan or general API surface. - | Auth choice | Best for | - | ----------- | -------- | - | `zai-api-key` | Generic API-key setup with endpoint auto-detection | - | `zai-coding-global` | Coding Plan users (global) | - | `zai-coding-cn` | Coding Plan users (China region) | - | `zai-global` | General API (global) | - | `zai-cn` | General API (China region) | + | Auth choice | Best for | + | ------------------- | --------------------------------------------------- | + | `zai-api-key` | Generic API key with endpoint auto-detection | + | `zai-coding-global` | Coding Plan users (global) | + | `zai-coding-cn` | Coding Plan users (China region) | + | `zai-global` | General API (global) | + | `zai-cn` | General API (China region) | - ```bash - # Example: generic auto-detect - openclaw onboard --auth-choice zai-api-key + - # Example: Coding Plan global - openclaw onboard --auth-choice zai-coding-global - ``` +```bash Auto-detect +openclaw onboard --auth-choice zai-api-key +``` + +```bash Coding Plan (global) +openclaw onboard --auth-choice zai-coding-global +``` + +```bash Coding Plan (China) +openclaw onboard --auth-choice zai-coding-cn +``` + +```bash General API (global) +openclaw onboard --auth-choice zai-global +``` + +```bash General API (China) +openclaw onboard --auth-choice zai-cn +``` + + @@ -56,45 +80,42 @@ models are accessed via the `zai` provider and model IDs like `zai/glm-5`. ``` -`zai-api-key` lets OpenClaw detect the matching Z.AI endpoint from the key and -apply the correct base URL automatically. Use the explicit regional choices when -you want to force a specific Coding Plan or general API surface. + `zai-api-key` lets OpenClaw detect the matching Z.AI endpoint from the key shape and apply the correct base URL automatically. Use the explicit regional choices when you want to pin a specific Coding Plan or general API surface. ## Built-in catalog -OpenClaw currently seeds the bundled `zai` provider with these GLM refs: +The bundled `zai` provider seeds 13 GLM model refs. All entries support reasoning unless marked otherwise; `glm-5v-turbo` and `glm-4.6v` accept image input as well as text. -| Model | Model | -| --------------- | ---------------- | -| `glm-5.1` | `glm-4.7` | -| `glm-5` | `glm-4.7-flash` | -| `glm-5-turbo` | `glm-4.7-flashx` | -| `glm-5v-turbo` | `glm-4.6` | -| `glm-4.5` | `glm-4.6v` | -| `glm-4.5-air` | | -| `glm-4.5-flash` | | -| `glm-4.5v` | | +| Model ref | Notes | +| -------------------- | -------------------------------------------------- | +| `zai/glm-5.1` | Default model. Reasoning, text only, 202k context. | +| `zai/glm-5` | Reasoning, text only, 202k context. | +| `zai/glm-5-turbo` | Reasoning, text only, 202k context. | +| `zai/glm-5v-turbo` | Reasoning, text + image, 202k context. | +| `zai/glm-4.7` | Reasoning, text only, 204k context. | +| `zai/glm-4.7-flash` | Reasoning, text only, 200k context. | +| `zai/glm-4.7-flashx` | Reasoning, text only. | +| `zai/glm-4.6` | Reasoning, text only. | +| `zai/glm-4.6v` | Reasoning, text + image. Default image model. | +| `zai/glm-4.5` | Reasoning, text only. | +| `zai/glm-4.5-air` | Reasoning, text only. | +| `zai/glm-4.5-flash` | Reasoning, text only. | +| `zai/glm-4.5v` | Reasoning, text + image. | -The default bundled model ref is `zai/glm-5.1`. GLM versions and availability -can change; check Z.AI's docs for the latest. + GLM versions and availability can change. Run `openclaw models list --provider zai` to see the catalog rows known to your installed version, and check Z.AI's docs for newly added or deprecated models. ## Advanced configuration - When you use the `zai-api-key` auth choice, OpenClaw inspects the key format - to determine the correct Z.AI base URL. Explicit regional choices - (`zai-coding-global`, `zai-coding-cn`, `zai-global`, `zai-cn`) override - auto-detection and pin the endpoint directly. + When you use the `zai-api-key` auth choice, OpenClaw inspects the key shape to determine the correct Z.AI base URL. Explicit regional choices (`zai-coding-global`, `zai-coding-cn`, `zai-global`, `zai-cn`) override auto-detection and pin the endpoint directly. - GLM models are served by the `zai` runtime provider. For full provider - configuration, regional endpoints, and additional capabilities, see - [Z.AI provider docs](/providers/zai). + GLM models are served by the `zai` runtime provider. For full provider configuration, regional endpoints, and additional capabilities, see the [Z.AI provider page](/providers/zai). @@ -104,7 +125,13 @@ can change; check Z.AI's docs for the latest. Full Z.AI provider configuration and regional endpoints. - + Choosing providers, model refs, and failover behavior. + + `/think` levels for the reasoning-capable GLM family. + + + Auth profiles, switching models, and resolving "no profile" errors. + diff --git a/docs/providers/runway.md b/docs/providers/runway.md index e9000e66b47..b4af0d1bff6 100644 --- a/docs/providers/runway.md +++ b/docs/providers/runway.md @@ -7,13 +7,17 @@ read_when: - You want to make Runway the default video provider --- -OpenClaw ships a bundled `runway` provider for hosted video generation. +OpenClaw ships a bundled `runway` provider for hosted video generation. The plugin is enabled by default and registers the `runway` provider against the `videoGenerationProviders` contract. -| Property | Value | -| ----------- | ----------------------------------------------------------------- | -| Provider id | `runway` | -| Auth | `RUNWAYML_API_SECRET` (canonical) or `RUNWAY_API_KEY` | -| API | Runway task-based video generation (`GET /v1/tasks/{id}` polling) | +| Property | Value | +| --------------- | ----------------------------------------------------------------- | +| Provider id | `runway` | +| Plugin | bundled, `enabledByDefault: true` | +| Auth env vars | `RUNWAYML_API_SECRET` (canonical) or `RUNWAY_API_KEY` | +| Onboarding flag | `--auth-choice runway-api-key` | +| Direct CLI flag | `--runway-api-key ` | +| API | Runway task-based video generation (`GET /v1/tasks/{id}` polling) | +| Default model | `runway/gen4.5` | ## Getting started @@ -33,23 +37,31 @@ OpenClaw ships a bundled `runway` provider for hosted video generation. -## Supported modes +## Supported modes and models -| Mode | Model | Reference input | -| -------------- | ------------------ | ----------------------- | -| Text-to-video | `gen4.5` (default) | None | -| Image-to-video | `gen4.5` | 1 local or remote image | -| Video-to-video | `gen4_aleph` | 1 local or remote video | +The provider exposes seven Runway models split across three modes. The same model id can serve more than one mode (for example `gen4.5` works for both text-to-video and image-to-video). - -Local image and video references are supported via data URIs. Text-only runs -currently expose `16:9` and `9:16` aspect ratios. - +| Mode | Models | Reference input | +| -------------- | ---------------------------------------------------------------------- | ----------------------- | +| Text-to-video | `gen4.5` (default), `veo3.1`, `veo3.1_fast`, `veo3` | None | +| Image-to-video | `gen4.5`, `gen4_turbo`, `gen3a_turbo`, `veo3.1`, `veo3.1_fast`, `veo3` | 1 local or remote image | +| Video-to-video | `gen4_aleph` | 1 local or remote video | + +Local image and video references are supported via data URIs. + +| Aspect ratios | Allowed values | +| --------------------- | ------------------------------------------- | +| Text-to-video | `16:9`, `9:16` | +| Image and video edits | `1:1`, `16:9`, `9:16`, `3:4`, `4:3`, `21:9` | -Video-to-video currently requires `runway/gen4_aleph` specifically. + Video-to-video currently requires `runway/gen4_aleph`. Other Runway model ids reject video reference inputs. + + Picking a Runway model id from the wrong column produces an explicit error before the API request leaves OpenClaw. The provider validates `model` against the mode's allowlist (`TEXT_ONLY_MODELS`, `IMAGE_MODELS`, `VIDEO_MODELS`) in `extensions/runway/video-generation-provider.ts`. + + ## Configuration ```json5 diff --git a/docs/providers/vydra.md b/docs/providers/vydra.md index 8ce1ea5043c..3b44eb595f7 100644 --- a/docs/providers/vydra.md +++ b/docs/providers/vydra.md @@ -14,10 +14,18 @@ The bundled Vydra plugin adds: OpenClaw uses the same `VYDRA_API_KEY` for all three capabilities. - -Use `https://www.vydra.ai/api/v1` as the base URL. +| Property | Value | +| --------------- | ------------------------------------------------------------------------- | +| Provider id | `vydra` | +| Plugin | bundled, `enabledByDefault: true` | +| Auth env var | `VYDRA_API_KEY` | +| Onboarding flag | `--auth-choice vydra-api-key` | +| Direct CLI flag | `--vydra-api-key ` | +| Contracts | `imageGenerationProviders`, `videoGenerationProviders`, `speechProviders` | +| Base URL | `https://www.vydra.ai/api/v1` (use the `www` host) | -Vydra's apex host (`https://vydra.ai/api/v1`) currently redirects to `www`. Some HTTP clients drop `Authorization` on that cross-host redirect, which turns a valid API key into a misleading auth failure. The bundled plugin uses the `www` base URL directly to avoid that. + + Use `https://www.vydra.ai/api/v1` as the base URL. Vydra's apex host (`https://vydra.ai/api/v1`) currently redirects to `www`. Some HTTP clients drop `Authorization` on that cross-host redirect, which turns a valid API key into a misleading auth failure. The bundled plugin uses the `www` base URL directly to avoid that. ## Setup