Fix xchat docs: path params, scopes, Flask compat, new chat endpoints

tcaldwell-x · tcaldwell-x · commit 74ca5d6a7c66 · 2026-03-23T15:00:15.000-07:00
- Fix 5 x-api/chat endpoint paths: {conversation_id} -&gt; {id} to match
  OpenAPI spec v2.160 (send-message, get-conversation, mark-read,
  typing-indicator, download-media)
- Add 4 previously untracked x-api/chat endpoint pages
  (add-members, create-group, initialize-group, initialize-keys)
- Add x-api/users/get-public-keys-for-multiple-users.mdx
- Fix @app.before_first_request (removed Flask 2.3+) in getting-started.mdx
- Add media.write to required scopes list in troubleshooting.mdx
- Fix TypeScript XDK import: 'xdk' -&gt; '@xdevplatform/xdk' in real-time-events.mdx
diff --git a/x-api/chat/add-members-to-a-chat-group-conversation.mdx b/x-api/chat/add-members-to-a-chat-group-conversation.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /2/chat/conversations/{id}/members
+---
diff --git a/x-api/chat/create-chat-group-conversation.mdx b/x-api/chat/create-chat-group-conversation.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /2/chat/conversations/group
+---
diff --git a/x-api/chat/download-chat-media.mdx b/x-api/chat/download-chat-media.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /2/chat/media/{conversation_id}/{media_hash_key}
+openapi: get /2/chat/media/{id}/{media_hash_key}
 ---
diff --git a/x-api/chat/get-chat-conversation.mdx b/x-api/chat/get-chat-conversation.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /2/chat/conversations/{conversation_id}
+openapi: get /2/chat/conversations/{id}
 ---
diff --git a/x-api/chat/initialize-chat-group.mdx b/x-api/chat/initialize-chat-group.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /2/chat/conversations/group/initialize
+---
diff --git a/x-api/chat/initialize-conversation-keys.mdx b/x-api/chat/initialize-conversation-keys.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /2/chat/conversations/{id}/keys
+---
diff --git a/x-api/chat/mark-conversation-as-read.mdx b/x-api/chat/mark-conversation-as-read.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /2/chat/conversations/{conversation_id}/read
+openapi: post /2/chat/conversations/{id}/read
 ---
diff --git a/x-api/chat/send-chat-message.mdx b/x-api/chat/send-chat-message.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /2/chat/conversations/{conversation_id}/messages
+openapi: post /2/chat/conversations/{id}/messages
 ---
diff --git a/x-api/chat/send-typing-indicator.mdx b/x-api/chat/send-typing-indicator.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /2/chat/conversations/{conversation_id}/typing
+openapi: post /2/chat/conversations/{id}/typing
 ---
diff --git a/x-api/users/get-public-keys-for-multiple-users.mdx b/x-api/users/get-public-keys-for-multiple-users.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /2/users/public_keys
+---
diff --git a/xchat/getting-started.mdx b/xchat/getting-started.mdx
@@ -64,7 +64,7 @@ flowchart TB
   <Tab title="TypeScript">
     ```bash
     # Install the XDK and Chat XDK
-    npm install xdk chat-xdk
+    npm install @xdevplatform/xdk chat-xdk
     ```
   </Tab>
 </Tabs>
@@ -117,7 +117,7 @@ Create a main application file and initialize both SDKs.
   </Tab>
   <Tab title="TypeScript">
     ```typescript
-    import { Client } from 'xdk';
+    import { Client } from '@xdevplatform/xdk';
     import { createChat } from 'chat-xdk';
 
     // Initialize the XDK with OAuth 2.0 credentials
@@ -658,9 +658,8 @@ Here's a complete example that brings everything together into a simple customer
 
     app = Flask(__name__)
 
-    @app.before_first_request
-    def startup():
-        """Unlock encryption keys on startup."""
+    # Unlock encryption keys on startup
+    with app.app_context():
         chat.unlock("1234")  # Use secure PIN management in production
         print("Encryption keys unlocked")
 
diff --git a/xchat/real-time-events.mdx b/xchat/real-time-events.mdx
@@ -51,7 +51,7 @@ print(f"Webhook ID: {webhook.id}")
 ```
 
 ```typescript TypeScript
-import { Client } from 'xdk';
+import { Client } from '@xdevplatform/xdk';
 
 const client = new Client({ bearerToken: 'YOUR_BEARER_TOKEN' });
 
diff --git a/xchat/troubleshooting.mdx b/xchat/troubleshooting.mdx
@@ -298,7 +298,8 @@ if response.status_code == 401:
 
 **Required scopes for Chat:**
 - `dm.read` — Read conversations and messages
-- `dm.write` — Send messages
+- `dm.write` — Send messages, create conversations, register public keys
+- `media.write` — Upload media attachments
 - `users.read` — Read user profiles and public keys
 
 ---

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+openapi: post /2/chat/conversations/{id}/members`
	`3`	`+---`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+openapi: post /2/chat/conversations/group`
	`3`	`+---`
-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 ---
 -openapi: get /2/chat/media/{conversation_id}/{media_hash_key}
 +openapi: get /2/chat/media/{id}/{media_hash_key}
 ---
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+openapi: get /2/users/public_keys`
	`3`	`+---`