vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-06 05:10:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(providers): rewrite GLM, Runway, and Vydra with code-verified setup

Browse Source 
GLM (docs/providers/glm.md): rewrote against extensions/zai/openclaw.plugin.json.
Removed the duplicate '# GLM models' H1 (Mintlify renders title from
frontmatter; an in-body H1 produces a brittle anchor). Replaced the
two-column model table with a single Notes column covering all 13
bundled refs, including which are reasoning, which accept image input,
and which is the default image model (zai/glm-4.6v from the auto-routing
defaults). Expanded the auth-choice step into a CodeGroup covering all
five onboarding choices (zai-api-key, zai-coding-global, zai-coding-cn,
zai-global, zai-cn) sourced from the plugin manifest's
providerAuthChoices.

Runway (docs/providers/runway.md): expanded the supported-modes table
to cover all seven Runway models from
extensions/runway/video-generation-provider.ts. Text-to-video now lists
veo3, veo3.1, veo3.1_fast alongside gen4.5; image-to-video adds
gen4_turbo, gen3a_turbo, veo3, veo3.1, and veo3.1_fast. Added an
aspect-ratio table covering the documented RUNWAY_TEXT_ASPECT_RATIOS
('16:9'/'9:16') and RUNWAY_EDIT_ASPECT_RATIOS ('1:1'/'16:9'/'9:16'/
'3:4'/'4:3'/'21:9'). Promoted the existing properties table with
plugin/onboarding/CLI flag rows from the manifest.

Vydra (docs/providers/vydra.md): added a properties table sourced from
extensions/vydra/openclaw.plugin.json, including the three
providerAuthContract memberships (image/video/speech) and the
vydra-api-key onboarding choice plus --vydra-api-key direct flag. Kept
the existing Warning about the apex-host redirect intact.
This commit is contained in:
Vincent Koc
2026-05-05 17:15:25 -07:00
parent 01377ddbe2
commit 6aaf235aee
3 changed files with 109 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
docs/providers/glm.md
View File

@@ -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
<Steps>
<Step title="Choose an auth route and run onboarding">
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
<CodeGroup>
# 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
```
</CodeGroup>
</Step>
<Step title="Set GLM as the default model">
@@ -56,45 +80,42 @@ models are accessed via the `zai` provider and model IDs like `zai/glm-5`.
```
<Tip>
`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.
</Tip>
## 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. |
<Note>
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.
</Note>
## Advanced configuration
<AccordionGroup>
<Accordion title="Endpoint auto-detection">
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.
</Accordion>
<Accordion title="Provider details">
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).
</Accordion>
</AccordionGroup>
@@ -104,7 +125,13 @@ can change; check Z.AI's docs for the latest.
<Card title="Z.AI provider" href="/providers/zai" icon="server">
Full Z.AI provider configuration and regional endpoints.
</Card>
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
<Card title="Model providers" href="/concepts/model-providers" icon="layers">
Choosing providers, model refs, and failover behavior.
</Card>
<Card title="Thinking modes" href="/tools/thinking" icon="brain">
`/think` levels for the reasoning-capable GLM family.
</Card>
<Card title="Models FAQ" href="/help/faq-models" icon="circle-question">
Auth profiles, switching models, and resolving "no profile" errors.
</Card>
</CardGroup>

46
docs/providers/runway.md
View File

@@ -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 <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.
</Step>
</Steps>
## 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).
<Note>
Local image and video references are supported via data URIs. Text-only runs
currently expose `16:9` and `9:16` aspect ratios.
</Note>
| 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` |
<Warning>
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.
</Warning>
<Note>
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`.
</Note>
## Configuration
```json5

14
docs/providers/vydra.md
View File

@@ -14,10 +14,18 @@ The bundled Vydra plugin adds:
OpenClaw uses the same `VYDRA_API_KEY` for all three capabilities.
<Warning>
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 <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.
<Warning>
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.
</Warning>
## Setup