@octavus/docs 3.7.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/content/02-server-sdk/01-overview.md +1 -0
- package/content/03-client-sdk/02-messages.md +11 -2
- package/content/05-api-reference/01-overview.md +17 -0
- package/dist/{chunk-IECY2DX5.js → chunk-V4C4VGHD.js} +13 -13
- package/dist/chunk-V4C4VGHD.js.map +1 -0
- package/dist/content.js +1 -1
- package/dist/docs.json +6 -6
- package/dist/index.js +1 -1
- package/dist/search-index.json +1 -1
- package/dist/search.js +1 -1
- package/dist/search.js.map +1 -1
- package/dist/sections.json +6 -6
- package/package.json +1 -1
- package/dist/chunk-IECY2DX5.js.map +0 -1
|
@@ -149,6 +149,7 @@ interface OctavusClientConfig {
|
|
|
149
149
|
baseUrl: string; // Octavus API URL
|
|
150
150
|
apiKey?: string; // Your API key
|
|
151
151
|
traceModelRequests?: boolean; // Enable model request tracing (default: false)
|
|
152
|
+
maxRetries?: number; // Retries for transient network failures during streaming (default: 2, set to 0 to disable)
|
|
152
153
|
}
|
|
153
154
|
|
|
154
155
|
class OctavusClient {
|
|
@@ -33,7 +33,8 @@ type UIMessagePart =
|
|
|
33
33
|
| UIFilePart
|
|
34
34
|
| UIObjectPart
|
|
35
35
|
| UITodoPart
|
|
36
|
-
| UIWorkerPart
|
|
36
|
+
| UIWorkerPart
|
|
37
|
+
| UIStepStartPart;
|
|
37
38
|
|
|
38
39
|
// Text content
|
|
39
40
|
interface UITextPart {
|
|
@@ -60,7 +61,7 @@ interface UIToolCallPart {
|
|
|
60
61
|
args: Record<string, unknown>;
|
|
61
62
|
result?: unknown;
|
|
62
63
|
error?: string;
|
|
63
|
-
status: 'pending' | 'running' | 'done' | 'error';
|
|
64
|
+
status: 'pending' | 'running' | 'done' | 'error' | 'cancelled';
|
|
64
65
|
thread?: string;
|
|
65
66
|
}
|
|
66
67
|
|
|
@@ -134,6 +135,11 @@ interface UIWorkerPart {
|
|
|
134
135
|
error?: string;
|
|
135
136
|
status: 'running' | 'done' | 'error';
|
|
136
137
|
}
|
|
138
|
+
|
|
139
|
+
// Step boundary marker (structural, not rendered visually)
|
|
140
|
+
interface UIStepStartPart {
|
|
141
|
+
type: 'step-start';
|
|
142
|
+
}
|
|
137
143
|
```
|
|
138
144
|
|
|
139
145
|
## Sending Messages
|
|
@@ -316,6 +322,9 @@ function PartRenderer({ part }: { part: UIMessagePart }) {
|
|
|
316
322
|
// See Structured Output guide for more details
|
|
317
323
|
return <ObjectPartRenderer part={part} />;
|
|
318
324
|
|
|
325
|
+
case 'step-start':
|
|
326
|
+
return null;
|
|
327
|
+
|
|
319
328
|
default:
|
|
320
329
|
return null;
|
|
321
330
|
}
|
|
@@ -24,6 +24,23 @@ curl -H "Authorization: Bearer YOUR_API_KEY" \
|
|
|
24
24
|
|
|
25
25
|
API keys can be created in the Octavus Platform under your project's **API Keys** page.
|
|
26
26
|
|
|
27
|
+
## Wire-Format Versioning
|
|
28
|
+
|
|
29
|
+
The platform negotiates wire shape via the `X-Octavus-Sdk-Version` header. The Server SDK sets this automatically; direct API users only need to send it when they want the latest format.
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
curl -H "Authorization: Bearer YOUR_API_KEY" \
|
|
33
|
+
-H "X-Octavus-Sdk-Version: 4" \
|
|
34
|
+
https://octavus.ai/api/agent-sessions/SESSION_ID
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
| Header value | Wire shape |
|
|
38
|
+
| ------------ | -------------------------------------------------------------------------------------------------------- |
|
|
39
|
+
| (missing) | Legacy (v3) - matches `@octavus/server-sdk@^3` |
|
|
40
|
+
| `4` | Current (v4) - matches `@octavus/server-sdk@^4`. Adds `step-start` parts to `UIMessage` / `ChatMessage`. |
|
|
41
|
+
|
|
42
|
+
The header value is the major version the client can parse, not the SDK release version. Future wire-incompatible additions bump it again.
|
|
43
|
+
|
|
27
44
|
## API Key Permissions
|
|
28
45
|
|
|
29
46
|
API keys have two permission scopes:
|