@octavus/docs 0.0.2 → 0.0.4

package/content/04-protocol/04-tools.md

@@ -46,6 +46,8 @@ tools:
 
 ## Parameter Types
 
+Supported types: `string`, `number`, `boolean`, `unknown`
+
 ```yaml
 tools:
   search-products:
@@ -57,8 +59,7 @@ tools:
       
       category:
         type: string
-        description: Filter by category
-        enum: [electronics, clothing, books, home]
+        description: Filter by category (electronics, clothing, books, home)
       
       maxPrice:
         type: number
@@ -67,10 +68,6 @@ tools:
       inStock:
         type: boolean
         description: Only show in-stock items
-      
-      tags:
-        type: array
-        description: Filter by tags
 ```
 
 ## Making Tools Available
@@ -88,7 +85,7 @@ tools:
     description: Create a support ticket
     parameters:
       summary: { type: string }
-      priority: { type: string, enum: [low, medium, high, urgent] }
+      priority: { type: string }  # low, medium, high, urgent
 
 agent:
   model: anthropic/claude-sonnet-4-5
@@ -231,17 +228,13 @@ tools:
       query: { type: string }
     returns:
       products:
-        type: array
-        items:
-          type: object
-          properties:
-            id: { type: string }
-            name: { type: string }
-            price: { type: number }
-      totalCount: { type: number }
+        type: unknown
+        description: Array of product objects
+      totalCount:
+        type: number
 ```
 
-### 3. Use Enums for Constrained Values
+### 3. Document Constrained Values
 
 ```yaml
 tools:
@@ -249,7 +242,6 @@ tools:
     parameters:
       priority:
         type: string
-        description: Ticket priority level
-        enum: [low, medium, high, urgent]
+        description: Ticket priority level (low, medium, high, urgent)
 ```
 

package/content/04-protocol/06-agent-config.md

@@ -162,6 +162,7 @@ input:
 
 resources:
   CONVERSATION_SUMMARY:
+    type: string
     default: ""
 
 tools:
@@ -179,7 +180,7 @@ tools:
     description: Create a support ticket
     parameters:
       summary: { type: string }
-      priority: { type: string, enum: [low, medium, high] }
+      priority: { type: string }  # low, medium, high
 
 agent:
   model: anthropic/claude-sonnet-4-5

package/content/05-api-reference/01-overview.md

@@ -107,13 +107,21 @@ curl -N -H "Authorization: Bearer YOUR_API_KEY" \
 Response format:
 
 ```
-data: {"type":"block-start","blockId":"...","blockName":"Respond"}
+data: {"type":"start","messageId":"..."}
 
-data: {"type":"text-delta","content":"Hello"}
+data: {"type":"block-start","blockId":"...","blockName":"Respond","blockType":"next-message","display":"stream"}
 
-data: {"type":"text-delta","content":"!"}
+data: {"type":"text-start","id":"..."}
 
-data: {"type":"done","finishReason":"stop"}
+data: {"type":"text-delta","id":"...","delta":"Hello"}
+
+data: {"type":"text-delta","id":"...","delta":"!"}
+
+data: {"type":"text-end","id":"..."}
+
+data: {"type":"block-end","blockId":"..."}
+
+data: {"type":"finish","finishReason":"stop"}
 
 data: [DONE]
 ```

package/content/05-api-reference/02-sessions.md

@@ -19,7 +19,7 @@ POST /api/agent-sessions
 
 ```json
 {
-  "agentId": "support-chat",
+  "agentId": "cm5xvz7k80001abcd",
   "input": {
     "COMPANY_NAME": "Acme Corp",
     "PRODUCT_NAME": "Widget Pro",
@@ -30,14 +30,16 @@ POST /api/agent-sessions
 
 | Field | Type | Required | Description |
 |-------|------|----------|-------------|
-| `agentId` | string | Yes | Agent identifier (slug) |
+| `agentId` | string | Yes | Agent ID (the `id` field, not `slug`) |
 | `input` | object | No | Input variables for the agent |
 
+> To get the agent ID, copy it from the platform URL, use [Get Agent by slug](/docs/api-reference/agents#get-agent) (`GET /api/agents/:slug?by=slug`), or the SDK's `agents.getBySlug()` method.
+
 ### Response
 
 ```json
 {
-  "sessionId": "sess_abc123xyz"
+  "sessionId": "cm5xyz123abc456def"
 }
 ```
 
@@ -48,7 +50,7 @@ curl -X POST https://octavus.ai/api/agent-sessions \
   -H "Authorization: Bearer YOUR_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{
-    "agentId": "support-chat",
+    "agentId": "cm5xvz7k80001abcd",
     "input": {
       "COMPANY_NAME": "Acme Corp",
       "PRODUCT_NAME": "Widget Pro"
@@ -68,8 +70,8 @@ GET /api/agent-sessions/:sessionId
 
 ```json
 {
-  "id": "sess_abc123xyz",
-  "agentId": "support-chat",
+  "id": "cm5xyz123abc456def",
+  "agentId": "cm5xvz7k80001abcd",
   "input": {
     "COMPANY_NAME": "Acme Corp",
     "PRODUCT_NAME": "Widget Pro"
@@ -80,7 +82,7 @@ GET /api/agent-sessions/:sessionId
   },
   "messages": [
     {
-      "id": "msg_1",
+      "id": "1702345800000-xyz789a",
       "role": "user",
       "parts": [
         { "type": "text", "visible": true, "content": "How do I reset my password?" }
@@ -89,7 +91,7 @@ GET /api/agent-sessions/:sessionId
       "createdAt": "2024-01-15T10:30:00Z"
     },
     {
-      "id": "msg_2",
+      "id": "1702345805000-def456b",
       "role": "assistant",
       "parts": [
         { "type": "text", "visible": true, "content": "I can help you reset your password..." }
@@ -106,7 +108,7 @@ GET /api/agent-sessions/:sessionId
 ### Example
 
 ```bash
-curl https://octavus.ai/api/agent-sessions/sess_abc123xyz \
+curl https://octavus.ai/api/agent-sessions/:sessionId \
   -H "Authorization: Bearer YOUR_API_KEY"
 ```
 
@@ -141,6 +143,8 @@ POST /api/agent-sessions/:sessionId/trigger
 Returns `text/event-stream` with SSE events:
 
 ```
+data: {"type":"start","messageId":"msg-123"}
+
 data: {"type":"block-start","blockId":"b1","blockName":"Add user message","blockType":"add-message","display":"hidden"}
 
 data: {"type":"block-end","blockId":"b1"}
@@ -149,27 +153,27 @@ data: {"type":"block-start","blockId":"b2","blockName":"Respond to user","blockT
 
 data: {"type":"text-start","id":"t1"}
 
-data: {"type":"text-delta","content":"I"}
+data: {"type":"text-delta","id":"t1","delta":"I"}
 
-data: {"type":"text-delta","content":" can"}
+data: {"type":"text-delta","id":"t1","delta":" can"}
 
-data: {"type":"text-delta","content":" help"}
+data: {"type":"text-delta","id":"t1","delta":" help"}
 
-data: {"type":"text-delta","content":" you"}
+data: {"type":"text-delta","id":"t1","delta":" you"}
 
-data: {"type":"text-delta","content":" reset"}
+data: {"type":"text-delta","id":"t1","delta":" reset"}
 
-data: {"type":"text-delta","content":" your"}
+data: {"type":"text-delta","id":"t1","delta":" your"}
 
-data: {"type":"text-delta","content":" password"}
+data: {"type":"text-delta","id":"t1","delta":" password"}
 
-data: {"type":"text-delta","content":"!"}
+data: {"type":"text-delta","id":"t1","delta":"!"}
 
 data: {"type":"text-end","id":"t1"}
 
 data: {"type":"block-end","blockId":"b2"}
 
-data: {"type":"done","finishReason":"stop"}
+data: {"type":"finish","finishReason":"stop"}
 
 data: [DONE]
 ```
@@ -178,27 +182,30 @@ data: [DONE]
 
 | Event | Description |
 |-------|-------------|
+| `start` | Stream started |
+| `finish` | Execution complete |
+| `error` | Error occurred |
 | `block-start` | Execution block started |
 | `block-end` | Execution block completed |
 | `text-start` | Text generation started |
 | `text-delta` | Incremental text content |
 | `text-end` | Text generation ended |
-| `tool-call-start` | Tool call initiated |
-| `tool-call-args` | Tool arguments (JSON string) |
-| `tool-call-result` | Tool completed with result |
-| `tool-call-error` | Tool failed |
+| `reasoning-start` | Extended reasoning started |
+| `reasoning-delta` | Reasoning content |
+| `reasoning-end` | Extended reasoning ended |
+| `tool-input-start` | Tool call initiated |
+| `tool-input-delta` | Tool arguments streaming |
+| `tool-input-end` | Tool arguments streaming ended |
+| `tool-input-available` | Tool input complete |
+| `tool-output-available` | Tool completed with result |
+| `tool-output-error` | Tool failed |
 | `tool-request` | Platform requesting tool execution |
-| `thinking-start` | Extended reasoning started |
-| `thinking-delta` | Reasoning content |
-| `thinking-end` | Extended reasoning ended |
 | `resource-update` | Resource value changed |
-| `done` | Execution complete |
-| `error` | Error occurred |
 
 ### Example
 
 ```bash
-curl -N -X POST https://octavus.ai/api/agent-sessions/sess_abc123xyz/trigger \
+curl -N -X POST https://octavus.ai/api/agent-sessions/:sessionId/trigger \
   -H "Authorization: Bearer YOUR_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{
@@ -229,4 +236,3 @@ When the agent calls external tools, you'll receive a `tool-request` event. Exec
 ```
 
 The Server SDK handles this continuation pattern automatically.
-

package/content/05-api-reference/03-agents.md

@@ -21,7 +21,7 @@ GET /api/agents
 {
   "agents": [
     {
-      "id": "agt_abc123",
+      "id": "cm5xvz7k80001abcd",
       "slug": "support-chat",
       "name": "Support Chat",
       "description": "Customer support agent",
@@ -53,11 +53,13 @@ GET /api/agents/:slug?by=slug
 
 ```json
 {
-  "id": "agt_abc123",
-  "slug": "support-chat",
-  "name": "Support Chat",
-  "description": "Customer support agent",
-  "format": "interactive",
+  "id": "cm5xvz7k80001abcd",
+  "settings": {
+    "slug": "support-chat",
+    "name": "Support Chat",
+    "description": "Customer support agent",
+    "format": "interactive"
+  },
   "protocol": "input:\n  COMPANY_NAME: { type: string }\n...",
   "prompts": [
     {
@@ -68,9 +70,7 @@ GET /api/agents/:slug?by=slug
       "name": "user-message",
       "content": "{{USER_MESSAGE}}"
     }
-  ],
-  "createdAt": "2024-01-10T08:00:00Z",
-  "updatedAt": "2024-01-15T10:00:00Z"
+  ]
 }
 ```
 
@@ -78,11 +78,11 @@ GET /api/agents/:slug?by=slug
 
 ```bash
 # By ID
-curl https://octavus.ai/api/agents/agt_abc123 \
+curl https://octavus.ai/api/agents/:agentId \
   -H "Authorization: Bearer YOUR_API_KEY"
 
 # By slug
-curl "https://octavus.ai/api/agents/support-chat?by=slug" \
+curl "https://octavus.ai/api/agents/:slug?by=slug" \
   -H "Authorization: Bearer YOUR_API_KEY"
 ```
 
@@ -127,7 +127,8 @@ POST /api/agents
 
 ```json
 {
-  "agentId": "agt_abc123"
+  "agentId": "cm5xvz7k80001abcd",
+  "message": "Agent created successfully"
 }
 ```
 
@@ -179,14 +180,15 @@ All fields are optional. Only provided fields are updated.
 
 ```json
 {
-  "agentId": "agt_abc123"
+  "agentId": "cm5xvz7k80001abcd",
+  "message": "Agent updated successfully"
 }
 ```
 
 ### Example
 
 ```bash
-curl -X PATCH https://octavus.ai/api/agents/agt_abc123 \
+curl -X PATCH https://octavus.ai/api/agents/:agentId \
   -H "Authorization: Bearer YOUR_API_KEY" \
   -H "Content-Type: application/json" \
   -d '{