Skip to content

Commit 71ae125

Browse files
committed
docs(voyage): clarify API key setup
1 parent 9a50fe1 commit 71ae125

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

docs/plugins/reference/voyage.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,54 @@ title: "Voyage plugin"
99

1010
Adds memory embedding provider support.
1111

12+
## Setup
13+
14+
Voyage is a remote memory embedding provider, so it needs a Voyage API key before
15+
memory search can use it.
16+
17+
Set the key with either:
18+
19+
- Environment variable: `VOYAGE_API_KEY`
20+
- Config key: `models.providers.voyage.apiKey`
21+
22+
For an interactive setup, run:
23+
24+
```bash
25+
openclaw configure --section model
26+
```
27+
28+
To make memory search use Voyage explicitly, set the memory search provider to
29+
`voyage` and choose a Voyage embedding model:
30+
31+
```ts
32+
{
33+
agents: {
34+
defaults: {
35+
memorySearch: {
36+
provider: "voyage",
37+
model: "voyage-3-large",
38+
},
39+
},
40+
},
41+
models: {
42+
providers: {
43+
voyage: {
44+
apiKey: "${VOYAGE_API_KEY}",
45+
},
46+
},
47+
},
48+
}
49+
```
50+
51+
Verify the runtime credential and embedding provider path with:
52+
53+
```bash
54+
openclaw memory status --deep
55+
```
56+
57+
For the full memory embedding provider matrix and API key resolution order, see
58+
[Memory config](/reference/memory-config).
59+
1260
## Distribution
1361

1462
- Package: `@openclaw/voyage-provider`

0 commit comments

Comments
 (0)