@utdk/posthog 1.0.0-20260712.5-dev.e2949a6

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.
Files changed (151) hide show
  1. package/LICENSE +373 -0
  2. package/README.md +172 -0
  3. package/docs/account_relationship_definitions.md +194 -0
  4. package/docs/accounts.md +380 -0
  5. package/docs/actions.md +274 -0
  6. package/docs/activity_logs.md +144 -0
  7. package/docs/advanced_activity_logs.md +101 -0
  8. package/docs/agent_platform.md +2525 -0
  9. package/docs/ai-observability.md +514 -0
  10. package/docs/alerts.md +444 -0
  11. package/docs/annotations.md +200 -0
  12. package/docs/batch_exports.md +2118 -0
  13. package/docs/business_knowledge.md +468 -0
  14. package/docs/code-invites.md +72 -0
  15. package/docs/cohorts.md +412 -0
  16. package/docs/comments.md +321 -0
  17. package/docs/conversations.md +695 -0
  18. package/docs/custom_property_definitions.md +442 -0
  19. package/docs/custom_property_sources.md +194 -0
  20. package/docs/customer_analytics.md +442 -0
  21. package/docs/customer_journeys.md +380 -0
  22. package/docs/customer_profile_configs.md +380 -0
  23. package/docs/dashboard_templates.md +258 -0
  24. package/docs/dashboards.md +1896 -0
  25. package/docs/data_color_themes.md +380 -0
  26. package/docs/data_modeling_jobs.md +264 -0
  27. package/docs/data_warehouse.md +928 -0
  28. package/docs/dataset_items.md +382 -0
  29. package/docs/datasets.md +382 -0
  30. package/docs/desktop_file_system.md +753 -0
  31. package/docs/desktop_file_system_shortcut.md +244 -0
  32. package/docs/docs.md +72 -0
  33. package/docs/early_access_feature.md +194 -0
  34. package/docs/elements.md +510 -0
  35. package/docs/endpoints.md +1030 -0
  36. package/docs/engineering_analytics.md +712 -0
  37. package/docs/environments.md +881 -0
  38. package/docs/error_tracking.md +5108 -0
  39. package/docs/evaluation_runs.md +78 -0
  40. package/docs/evaluations.md +446 -0
  41. package/docs/event_definitions.md +425 -0
  42. package/docs/event_filter.md +280 -0
  43. package/docs/event_schemas.md +163 -0
  44. package/docs/events.md +208 -0
  45. package/docs/experiment_holdouts.md +194 -0
  46. package/docs/experiment_saved_metrics.md +194 -0
  47. package/docs/experiments.md +1088 -0
  48. package/docs/exports.md +256 -0
  49. package/docs/external_data_schemas.md +752 -0
  50. package/docs/external_data_sources.md +2296 -0
  51. package/docs/feature_flags.md +808 -0
  52. package/docs/field_notes.md +206 -0
  53. package/docs/file_system.md +880 -0
  54. package/docs/file_system_shortcut.md +444 -0
  55. package/docs/flag_value.md +46 -0
  56. package/docs/groups.md +514 -0
  57. package/docs/groups_types.md +349 -0
  58. package/docs/health_issues.md +386 -0
  59. package/docs/heatmap_screenshots.md +72 -0
  60. package/docs/heatmaps.md +136 -0
  61. package/docs/hog_flows.md +1576 -0
  62. package/docs/hog_function_templates.md +101 -0
  63. package/docs/hog_functions.md +974 -0
  64. package/docs/ingestion_warnings_v2.md +40 -0
  65. package/docs/insight_variables.md +380 -0
  66. package/docs/insights.md +1722 -0
  67. package/docs/integrations.md +1954 -0
  68. package/docs/js-snippet.md +104 -0
  69. package/docs/live_debugger_breakpoints.md +264 -0
  70. package/docs/llm_analytics.md +3373 -0
  71. package/docs/llm_prompts.md +442 -0
  72. package/docs/llm_skills.md +952 -0
  73. package/docs/logs.md +2446 -0
  74. package/docs/managed_viewsets.md +140 -0
  75. package/docs/marketing_analytics.md +518 -0
  76. package/docs/max.md +772 -0
  77. package/docs/max_tools.md +70 -0
  78. package/docs/mcp_analytics.md +712 -0
  79. package/docs/mcp_server_installations.md +970 -0
  80. package/docs/mcp_servers.md +78 -0
  81. package/docs/mcp_tools.md +82 -0
  82. package/docs/messaging_templates.md +444 -0
  83. package/docs/metrics.md +462 -0
  84. package/docs/notebooks.md +838 -0
  85. package/docs/object_media_previews.md +228 -0
  86. package/docs/organizations.md +2958 -0
  87. package/docs/persons.md +1514 -0
  88. package/docs/platform_features.md +700 -0
  89. package/docs/plugin_configs.md +70 -0
  90. package/docs/product_enablement.md +39 -0
  91. package/docs/product_tours.md +357 -0
  92. package/docs/project_secret_api_keys.md +444 -0
  93. package/docs/property_access_controls.md +200 -0
  94. package/docs/property_definitions.md +244 -0
  95. package/docs/query.md +560 -0
  96. package/docs/quota_limits.md +40 -0
  97. package/docs/reminders.md +194 -0
  98. package/docs/replay.md +1020 -0
  99. package/docs/reverse_proxy.md +200 -0
  100. package/docs/sandbox-custom-images.md +209 -0
  101. package/docs/sandbox-environments.md +168 -0
  102. package/docs/saved.md +392 -0
  103. package/docs/saved_query_column_annotations.md +224 -0
  104. package/docs/scheduled_changes.md +200 -0
  105. package/docs/schema_property_groups.md +194 -0
  106. package/docs/sdk_health.md +40 -0
  107. package/docs/session_group_summaries.md +200 -0
  108. package/docs/session_recordings.md +260 -0
  109. package/docs/session_summaries.md +200 -0
  110. package/docs/sessions.md +132 -0
  111. package/docs/signals.md +1428 -0
  112. package/docs/single_session_summaries.md +72 -0
  113. package/docs/streamlit_apps.md +456 -0
  114. package/docs/subscriptions.md +634 -0
  115. package/docs/surveys.md +731 -0
  116. package/docs/taggers.md +446 -0
  117. package/docs/task-automations.md +200 -0
  118. package/docs/task-runs.md +654 -0
  119. package/docs/task_channels.md +136 -0
  120. package/docs/task_mentions.md +40 -0
  121. package/docs/tasks.md +776 -0
  122. package/docs/tracing.md +1186 -0
  123. package/docs/uploaded_media.md +44 -0
  124. package/docs/user_home_settings.md +72 -0
  125. package/docs/user_interview_topics.md +1288 -0
  126. package/docs/user_interviews.md +444 -0
  127. package/docs/users.md +1267 -0
  128. package/docs/vision.md +2022 -0
  129. package/docs/visual_review.md +816 -0
  130. package/docs/warehouse_column_annotations.md +224 -0
  131. package/docs/warehouse_column_statistics.md +80 -0
  132. package/docs/warehouse_dag.md +40 -0
  133. package/docs/warehouse_model_paths.md +70 -0
  134. package/docs/warehouse_saved_queries.md +1056 -0
  135. package/docs/warehouse_saved_query_folders.md +318 -0
  136. package/docs/warehouse_tables.md +584 -0
  137. package/docs/warehouse_view_link.md +456 -0
  138. package/docs/warehouse_view_links.md +456 -0
  139. package/docs/web_analytics.md +136 -0
  140. package/docs/web_analytics_achievements.md +200 -0
  141. package/docs/web_experiments.md +194 -0
  142. package/docs/web_vitals.md +74 -0
  143. package/docs/wizard.md +170 -0
  144. package/index.ts +22 -0
  145. package/metadata.ts +41419 -0
  146. package/openapi.json +297382 -0
  147. package/overlay.yaml +23 -0
  148. package/package.json +34 -0
  149. package/provenance.json +24 -0
  150. package/research.json +80 -0
  151. package/types/index.ts +17547 -0
package/docs/max.md ADDED
@@ -0,0 +1,772 @@
1
+ # Max
2
+
3
+ ## Operations
4
+
5
+ ### `posthog.environmentsConversationsList`
6
+
7
+ - **HTTP**: `GET /api/environments/{environment_id}/conversations/`
8
+ - **OpenAPI operationId**: `environments_conversations_list`
9
+ - **Path params**: None
10
+ - **Query params**: `limit`, `offset`
11
+ - **Response codes**: `200`
12
+ - **Transport options**: None
13
+ - **TypeScript**: [Client interface](../types.ts)
14
+
15
+ **Inputs**
16
+
17
+ - Client input type: `{ [key: string]: unknown }`
18
+ - Client transport options: None
19
+
20
+ **Outputs**
21
+
22
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay...`
23
+ - OpenAPI response codes: `200`
24
+
25
+ ```ts
26
+ import posthog from "@utdk/posthog";
27
+
28
+ type EnvironmentsConversationsListInput = Parameters<typeof posthog.environmentsConversationsList> extends [infer T, ...unknown[]] ? T : undefined;
29
+ type EnvironmentsConversationsListOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsList>>;
30
+
31
+ const result: EnvironmentsConversationsListOutput = await posthog.environmentsConversationsList();
32
+
33
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay...
34
+ ```
35
+
36
+ ### `posthog.environmentsConversationsCreate`
37
+
38
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/`
39
+ - **What it does**: Unified endpoint that handles both conversation creation and streaming.
40
+
41
+ - If message is provided: Start new conversation processing
42
+ - If no message: Stream from existing conversation
43
+ - **OpenAPI operationId**: `environments_conversations_create`
44
+ - **Path params**: None
45
+ - **Query params**: None
46
+ - **Response codes**: `201`
47
+ - **Transport options**: None
48
+ - **TypeScript**: [Client interface](../types.ts)
49
+
50
+ **Inputs**
51
+
52
+ - Client input type: `{ [key: string]: unknown }`
53
+ - Client transport options: None
54
+
55
+ **Outputs**
56
+
57
+ - Client return type: `{ content: string | null; conversation: string; contextual_tools?: { [key: string]: unknown }; ui_context?: unknown; billing_context?: unknown; trace_id: string; session_id?: string; agent_mode?: "product_analytics" | "...`
58
+ - OpenAPI response codes: `201`
59
+
60
+ ```ts
61
+ import posthog from "@utdk/posthog";
62
+
63
+ type EnvironmentsConversationsCreateInput = Parameters<typeof posthog.environmentsConversationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
64
+ type EnvironmentsConversationsCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsCreate>>;
65
+
66
+ const result: EnvironmentsConversationsCreateOutput = await posthog.environmentsConversationsCreate();
67
+
68
+ // Result shape (from schema): { content: string | null; conversation: string; contextual_tools?: { [key: string]: unknown }; ui_context?: unknown; billing_context?: unknown; trace_id: string; session_id?: string; agent_mode?: "product_analytics" | "...
69
+ ```
70
+
71
+ ### `posthog.environmentsConversationsDestroy`
72
+
73
+ - **HTTP**: `DELETE /api/environments/{environment_id}/conversations/{conversation}/`
74
+ - **What it does**: Delete a conversation.
75
+ - **OpenAPI operationId**: `environments_conversations_destroy`
76
+ - **Path params**: `conversation`
77
+ - **Query params**: None
78
+ - **Response codes**: `204`
79
+ - **Transport options**: None
80
+ - **TypeScript**: [Client interface](../types.ts)
81
+
82
+ **Inputs**
83
+
84
+ - Client input type: `{ [key: string]: unknown }`
85
+ - Client transport options: None
86
+
87
+ **Outputs**
88
+
89
+ - Client return type: `unknown`
90
+ - OpenAPI response codes: `204`
91
+
92
+ ```ts
93
+ import posthog from "@utdk/posthog";
94
+
95
+ type EnvironmentsConversationsDestroyInput = Parameters<typeof posthog.environmentsConversationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
96
+ type EnvironmentsConversationsDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsDestroy>>;
97
+
98
+ const result: EnvironmentsConversationsDestroyOutput = await posthog.environmentsConversationsDestroy();
99
+
100
+ // Result shape (from schema): unknown
101
+ ```
102
+
103
+ ### `posthog.environmentsConversationsRetrieve`
104
+
105
+ - **HTTP**: `GET /api/environments/{environment_id}/conversations/{conversation}/`
106
+ - **OpenAPI operationId**: `environments_conversations_retrieve`
107
+ - **Path params**: `conversation`
108
+ - **Query params**: None
109
+ - **Response codes**: `200`
110
+ - **Transport options**: None
111
+ - **TypeScript**: [Client interface](../types.ts)
112
+
113
+ **Inputs**
114
+
115
+ - Client input type: `{ [key: string]: unknown }`
116
+ - Client transport options: None
117
+
118
+ **Outputs**
119
+
120
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
121
+ - OpenAPI response codes: `200`
122
+
123
+ ```ts
124
+ import posthog from "@utdk/posthog";
125
+
126
+ type EnvironmentsConversationsRetrieveInput = Parameters<typeof posthog.environmentsConversationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
127
+ type EnvironmentsConversationsRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsRetrieve>>;
128
+
129
+ const result: EnvironmentsConversationsRetrieveOutput = await posthog.environmentsConversationsRetrieve();
130
+
131
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
132
+ ```
133
+
134
+ ### `posthog.environmentsConversationsAppendMessageCreate`
135
+
136
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/{conversation}/append_message/`
137
+ - **What it does**: Appends a message to an existing conversation without triggering AI processing.
138
+ This is used for client-side generated messages that need to be persisted
139
+ (e.g., support ticket confirmation messages).
140
+ - **OpenAPI operationId**: `environments_conversations_append_message_create`
141
+ - **Path params**: `conversation`
142
+ - **Query params**: None
143
+ - **Response codes**: `200`
144
+ - **Transport options**: None
145
+ - **TypeScript**: [Client interface](../types.ts)
146
+
147
+ **Inputs**
148
+
149
+ - Client input type: `{ [key: string]: unknown }`
150
+ - Client transport options: None
151
+
152
+ **Outputs**
153
+
154
+ - Client return type: `{ content: string }`
155
+ - OpenAPI response codes: `200`
156
+
157
+ ```ts
158
+ import posthog from "@utdk/posthog";
159
+
160
+ type EnvironmentsConversationsAppendMessageCreateInput = Parameters<typeof posthog.environmentsConversationsAppendMessageCreate> extends [infer T, ...unknown[]] ? T : undefined;
161
+ type EnvironmentsConversationsAppendMessageCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsAppendMessageCreate>>;
162
+
163
+ const result: EnvironmentsConversationsAppendMessageCreateOutput = await posthog.environmentsConversationsAppendMessageCreate();
164
+
165
+ // Result shape (from schema): { content: string }
166
+ ```
167
+
168
+ ### `posthog.environmentsConversationsCancelPartialUpdate`
169
+
170
+ - **HTTP**: `PATCH /api/environments/{environment_id}/conversations/{conversation}/cancel/`
171
+ - **What it does**: Cancel the conversation's in-progress LangGraph run.
172
+ - **OpenAPI operationId**: `environments_conversations_cancel_partial_update`
173
+ - **Path params**: `conversation`
174
+ - **Query params**: None
175
+ - **Response codes**: `204`, `422`
176
+ - **Transport options**: None
177
+ - **TypeScript**: [Client interface](../types.ts)
178
+
179
+ **Inputs**
180
+
181
+ - Client input type: `{ [key: string]: unknown }`
182
+ - Client transport options: None
183
+
184
+ **Outputs**
185
+
186
+ - Client return type: `unknown`
187
+ - OpenAPI response codes: `204`, `422`
188
+
189
+ ```ts
190
+ import posthog from "@utdk/posthog";
191
+
192
+ type EnvironmentsConversationsCancelPartialUpdateInput = Parameters<typeof posthog.environmentsConversationsCancelPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
193
+ type EnvironmentsConversationsCancelPartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsCancelPartialUpdate>>;
194
+
195
+ const result: EnvironmentsConversationsCancelPartialUpdateOutput = await posthog.environmentsConversationsCancelPartialUpdate();
196
+
197
+ // Result shape (from schema): unknown
198
+ ```
199
+
200
+ ### `posthog.environmentsConversationsOpenCreate`
201
+
202
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/{conversation}/open/`
203
+ - **What it does**: Create-or-resume a sandbox conversation — the single sandbox session opener. With `content`, processes the turn (first message, in-progress follow-up, or terminal resume); without `content`, warms a sandbox that idles awaiting the first message. Returns the `(task, run)` handle the frontend opens SSE against. The conversation row is created on first use from the URL id.
204
+ - **OpenAPI operationId**: `environments_conversations_open_create`
205
+ - **Path params**: `conversation`
206
+ - **Query params**: None
207
+ - **Response codes**: `200`, `204`, `400`
208
+ - **Transport options**: None
209
+ - **TypeScript**: [Client interface](../types.ts)
210
+
211
+ **Inputs**
212
+
213
+ - Client input type: `{ [key: string]: unknown }`
214
+ - Client transport options: None
215
+
216
+ **Outputs**
217
+
218
+ - Client return type: `{ task_id: string; run_id: string; trace_id: string | null; run_status: string; just_created_run: boolean }`
219
+ - OpenAPI response codes: `200`, `204`, `400`
220
+
221
+ ```ts
222
+ import posthog from "@utdk/posthog";
223
+
224
+ type EnvironmentsConversationsOpenCreateInput = Parameters<typeof posthog.environmentsConversationsOpenCreate> extends [infer T, ...unknown[]] ? T : undefined;
225
+ type EnvironmentsConversationsOpenCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsOpenCreate>>;
226
+
227
+ const result: EnvironmentsConversationsOpenCreateOutput = await posthog.environmentsConversationsOpenCreate();
228
+
229
+ // Result shape (from schema): { task_id: string; run_id: string; trace_id: string | null; run_status: string; just_created_run: boolean }
230
+ ```
231
+
232
+ ### `posthog.environmentsConversationsQueueRetrieve`
233
+
234
+ - **HTTP**: `GET /api/environments/{environment_id}/conversations/{conversation}/queue/`
235
+ - **OpenAPI operationId**: `environments_conversations_queue_retrieve`
236
+ - **Path params**: `conversation`
237
+ - **Query params**: None
238
+ - **Response codes**: `200`
239
+ - **Transport options**: None
240
+ - **TypeScript**: [Client interface](../types.ts)
241
+
242
+ **Inputs**
243
+
244
+ - Client input type: `{ [key: string]: unknown }`
245
+ - Client transport options: None
246
+
247
+ **Outputs**
248
+
249
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
250
+ - OpenAPI response codes: `200`
251
+
252
+ ```ts
253
+ import posthog from "@utdk/posthog";
254
+
255
+ type EnvironmentsConversationsQueueRetrieveInput = Parameters<typeof posthog.environmentsConversationsQueueRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
256
+ type EnvironmentsConversationsQueueRetrieveOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsQueueRetrieve>>;
257
+
258
+ const result: EnvironmentsConversationsQueueRetrieveOutput = await posthog.environmentsConversationsQueueRetrieve();
259
+
260
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
261
+ ```
262
+
263
+ ### `posthog.environmentsConversationsQueueCreate`
264
+
265
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/{conversation}/queue/`
266
+ - **OpenAPI operationId**: `environments_conversations_queue_create`
267
+ - **Path params**: `conversation`
268
+ - **Query params**: None
269
+ - **Response codes**: `200`
270
+ - **Transport options**: None
271
+ - **TypeScript**: [Client interface](../types.ts)
272
+
273
+ **Inputs**
274
+
275
+ - Client input type: `{ [key: string]: unknown }`
276
+ - Client transport options: None
277
+
278
+ **Outputs**
279
+
280
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
281
+ - OpenAPI response codes: `200`
282
+
283
+ ```ts
284
+ import posthog from "@utdk/posthog";
285
+
286
+ type EnvironmentsConversationsQueueCreateInput = Parameters<typeof posthog.environmentsConversationsQueueCreate> extends [infer T, ...unknown[]] ? T : undefined;
287
+ type EnvironmentsConversationsQueueCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsQueueCreate>>;
288
+
289
+ const result: EnvironmentsConversationsQueueCreateOutput = await posthog.environmentsConversationsQueueCreate();
290
+
291
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
292
+ ```
293
+
294
+ ### `posthog.environmentsConversationsQueueDestroy`
295
+
296
+ - **HTTP**: `DELETE /api/environments/{environment_id}/conversations/{conversation}/queue/{queue_id}/`
297
+ - **OpenAPI operationId**: `environments_conversations_queue_destroy`
298
+ - **Path params**: `conversation`, `queue_id`
299
+ - **Query params**: None
300
+ - **Response codes**: `204`
301
+ - **Transport options**: None
302
+ - **TypeScript**: [Client interface](../types.ts)
303
+
304
+ **Inputs**
305
+
306
+ - Client input type: `{ [key: string]: unknown }`
307
+ - Client transport options: None
308
+
309
+ **Outputs**
310
+
311
+ - Client return type: `unknown`
312
+ - OpenAPI response codes: `204`
313
+
314
+ ```ts
315
+ import posthog from "@utdk/posthog";
316
+
317
+ type EnvironmentsConversationsQueueDestroyInput = Parameters<typeof posthog.environmentsConversationsQueueDestroy> extends [infer T, ...unknown[]] ? T : undefined;
318
+ type EnvironmentsConversationsQueueDestroyOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsQueueDestroy>>;
319
+
320
+ const result: EnvironmentsConversationsQueueDestroyOutput = await posthog.environmentsConversationsQueueDestroy();
321
+
322
+ // Result shape (from schema): unknown
323
+ ```
324
+
325
+ ### `posthog.environmentsConversationsQueuePartialUpdate`
326
+
327
+ - **HTTP**: `PATCH /api/environments/{environment_id}/conversations/{conversation}/queue/{queue_id}/`
328
+ - **OpenAPI operationId**: `environments_conversations_queue_partial_update`
329
+ - **Path params**: `conversation`, `queue_id`
330
+ - **Query params**: None
331
+ - **Response codes**: `200`
332
+ - **Transport options**: None
333
+ - **TypeScript**: [Client interface](../types.ts)
334
+
335
+ **Inputs**
336
+
337
+ - Client input type: `{ [key: string]: unknown }`
338
+ - Client transport options: None
339
+
340
+ **Outputs**
341
+
342
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
343
+ - OpenAPI response codes: `200`
344
+
345
+ ```ts
346
+ import posthog from "@utdk/posthog";
347
+
348
+ type EnvironmentsConversationsQueuePartialUpdateInput = Parameters<typeof posthog.environmentsConversationsQueuePartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
349
+ type EnvironmentsConversationsQueuePartialUpdateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsQueuePartialUpdate>>;
350
+
351
+ const result: EnvironmentsConversationsQueuePartialUpdateOutput = await posthog.environmentsConversationsQueuePartialUpdate();
352
+
353
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
354
+ ```
355
+
356
+ ### `posthog.environmentsConversationsQueueClearCreate`
357
+
358
+ - **HTTP**: `POST /api/environments/{environment_id}/conversations/{conversation}/queue/clear/`
359
+ - **OpenAPI operationId**: `environments_conversations_queue_clear_create`
360
+ - **Path params**: `conversation`
361
+ - **Query params**: None
362
+ - **Response codes**: `200`
363
+ - **Transport options**: None
364
+ - **TypeScript**: [Client interface](../types.ts)
365
+
366
+ **Inputs**
367
+
368
+ - Client input type: `{ [key: string]: unknown }`
369
+ - Client transport options: None
370
+
371
+ **Outputs**
372
+
373
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
374
+ - OpenAPI response codes: `200`
375
+
376
+ ```ts
377
+ import posthog from "@utdk/posthog";
378
+
379
+ type EnvironmentsConversationsQueueClearCreateInput = Parameters<typeof posthog.environmentsConversationsQueueClearCreate> extends [infer T, ...unknown[]] ? T : undefined;
380
+ type EnvironmentsConversationsQueueClearCreateOutput = Awaited<ReturnType<typeof posthog.environmentsConversationsQueueClearCreate>>;
381
+
382
+ const result: EnvironmentsConversationsQueueClearCreateOutput = await posthog.environmentsConversationsQueueClearCreate();
383
+
384
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
385
+ ```
386
+
387
+ ### `posthog.conversationsList`
388
+
389
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/`
390
+ - **OpenAPI operationId**: `conversations_list`
391
+ - **Path params**: None
392
+ - **Query params**: `limit`, `offset`
393
+ - **Response codes**: `200`
394
+ - **Transport options**: None
395
+ - **TypeScript**: [Client interface](../types.ts)
396
+
397
+ **Inputs**
398
+
399
+ - Client input type: `{ [key: string]: unknown }`
400
+ - Client transport options: None
401
+
402
+ **Outputs**
403
+
404
+ - Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay...`
405
+ - OpenAPI response codes: `200`
406
+
407
+ ```ts
408
+ import posthog from "@utdk/posthog";
409
+
410
+ type ConversationsListInput = Parameters<typeof posthog.conversationsList> extends [infer T, ...unknown[]] ? T : undefined;
411
+ type ConversationsListOutput = Awaited<ReturnType<typeof posthog.conversationsList>>;
412
+
413
+ const result: ConversationsListOutput = await posthog.conversationsList();
414
+
415
+ // Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay...
416
+ ```
417
+
418
+ ### `posthog.conversationsCreate`
419
+
420
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/`
421
+ - **What it does**: Unified endpoint that handles both conversation creation and streaming.
422
+
423
+ - If message is provided: Start new conversation processing
424
+ - If no message: Stream from existing conversation
425
+ - **OpenAPI operationId**: `conversations_create`
426
+ - **Path params**: None
427
+ - **Query params**: None
428
+ - **Response codes**: `201`
429
+ - **Transport options**: None
430
+ - **TypeScript**: [Client interface](../types.ts)
431
+
432
+ **Inputs**
433
+
434
+ - Client input type: `{ [key: string]: unknown }`
435
+ - Client transport options: None
436
+
437
+ **Outputs**
438
+
439
+ - Client return type: `{ content: string | null; conversation: string; contextual_tools?: { [key: string]: unknown }; ui_context?: unknown; billing_context?: unknown; trace_id: string; session_id?: string; agent_mode?: "product_analytics" | "...`
440
+ - OpenAPI response codes: `201`
441
+
442
+ ```ts
443
+ import posthog from "@utdk/posthog";
444
+
445
+ type ConversationsCreateInput = Parameters<typeof posthog.conversationsCreate> extends [infer T, ...unknown[]] ? T : undefined;
446
+ type ConversationsCreateOutput = Awaited<ReturnType<typeof posthog.conversationsCreate>>;
447
+
448
+ const result: ConversationsCreateOutput = await posthog.conversationsCreate();
449
+
450
+ // Result shape (from schema): { content: string | null; conversation: string; contextual_tools?: { [key: string]: unknown }; ui_context?: unknown; billing_context?: unknown; trace_id: string; session_id?: string; agent_mode?: "product_analytics" | "...
451
+ ```
452
+
453
+ ### `posthog.conversationsDestroy`
454
+
455
+ - **HTTP**: `DELETE /api/projects/{project_id}/conversations/{conversation}/`
456
+ - **What it does**: Delete a conversation.
457
+ - **OpenAPI operationId**: `conversations_destroy`
458
+ - **Path params**: `conversation`
459
+ - **Query params**: None
460
+ - **Response codes**: `204`
461
+ - **Transport options**: None
462
+ - **TypeScript**: [Client interface](../types.ts)
463
+
464
+ **Inputs**
465
+
466
+ - Client input type: `{ [key: string]: unknown }`
467
+ - Client transport options: None
468
+
469
+ **Outputs**
470
+
471
+ - Client return type: `unknown`
472
+ - OpenAPI response codes: `204`
473
+
474
+ ```ts
475
+ import posthog from "@utdk/posthog";
476
+
477
+ type ConversationsDestroyInput = Parameters<typeof posthog.conversationsDestroy> extends [infer T, ...unknown[]] ? T : undefined;
478
+ type ConversationsDestroyOutput = Awaited<ReturnType<typeof posthog.conversationsDestroy>>;
479
+
480
+ const result: ConversationsDestroyOutput = await posthog.conversationsDestroy();
481
+
482
+ // Result shape (from schema): unknown
483
+ ```
484
+
485
+ ### `posthog.conversationsRetrieve`
486
+
487
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/{conversation}/`
488
+ - **OpenAPI operationId**: `conversations_retrieve`
489
+ - **Path params**: `conversation`
490
+ - **Query params**: None
491
+ - **Response codes**: `200`
492
+ - **Transport options**: None
493
+ - **TypeScript**: [Client interface](../types.ts)
494
+
495
+ **Inputs**
496
+
497
+ - Client input type: `{ [key: string]: unknown }`
498
+ - Client transport options: None
499
+
500
+ **Outputs**
501
+
502
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
503
+ - OpenAPI response codes: `200`
504
+
505
+ ```ts
506
+ import posthog from "@utdk/posthog";
507
+
508
+ type ConversationsRetrieveInput = Parameters<typeof posthog.conversationsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
509
+ type ConversationsRetrieveOutput = Awaited<ReturnType<typeof posthog.conversationsRetrieve>>;
510
+
511
+ const result: ConversationsRetrieveOutput = await posthog.conversationsRetrieve();
512
+
513
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
514
+ ```
515
+
516
+ ### `posthog.conversationsAppendMessageCreate`
517
+
518
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/{conversation}/append_message/`
519
+ - **What it does**: Appends a message to an existing conversation without triggering AI processing.
520
+ This is used for client-side generated messages that need to be persisted
521
+ (e.g., support ticket confirmation messages).
522
+ - **OpenAPI operationId**: `conversations_append_message_create`
523
+ - **Path params**: `conversation`
524
+ - **Query params**: None
525
+ - **Response codes**: `200`
526
+ - **Transport options**: None
527
+ - **TypeScript**: [Client interface](../types.ts)
528
+
529
+ **Inputs**
530
+
531
+ - Client input type: `{ [key: string]: unknown }`
532
+ - Client transport options: None
533
+
534
+ **Outputs**
535
+
536
+ - Client return type: `{ content: string }`
537
+ - OpenAPI response codes: `200`
538
+
539
+ ```ts
540
+ import posthog from "@utdk/posthog";
541
+
542
+ type ConversationsAppendMessageCreateInput = Parameters<typeof posthog.conversationsAppendMessageCreate> extends [infer T, ...unknown[]] ? T : undefined;
543
+ type ConversationsAppendMessageCreateOutput = Awaited<ReturnType<typeof posthog.conversationsAppendMessageCreate>>;
544
+
545
+ const result: ConversationsAppendMessageCreateOutput = await posthog.conversationsAppendMessageCreate();
546
+
547
+ // Result shape (from schema): { content: string }
548
+ ```
549
+
550
+ ### `posthog.conversationsCancelPartialUpdate`
551
+
552
+ - **HTTP**: `PATCH /api/projects/{project_id}/conversations/{conversation}/cancel/`
553
+ - **What it does**: Cancel the conversation's in-progress LangGraph run.
554
+ - **OpenAPI operationId**: `conversations_cancel_partial_update`
555
+ - **Path params**: `conversation`
556
+ - **Query params**: None
557
+ - **Response codes**: `204`, `422`
558
+ - **Transport options**: None
559
+ - **TypeScript**: [Client interface](../types.ts)
560
+
561
+ **Inputs**
562
+
563
+ - Client input type: `{ [key: string]: unknown }`
564
+ - Client transport options: None
565
+
566
+ **Outputs**
567
+
568
+ - Client return type: `unknown`
569
+ - OpenAPI response codes: `204`, `422`
570
+
571
+ ```ts
572
+ import posthog from "@utdk/posthog";
573
+
574
+ type ConversationsCancelPartialUpdateInput = Parameters<typeof posthog.conversationsCancelPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
575
+ type ConversationsCancelPartialUpdateOutput = Awaited<ReturnType<typeof posthog.conversationsCancelPartialUpdate>>;
576
+
577
+ const result: ConversationsCancelPartialUpdateOutput = await posthog.conversationsCancelPartialUpdate();
578
+
579
+ // Result shape (from schema): unknown
580
+ ```
581
+
582
+ ### `posthog.conversationsOpenCreate`
583
+
584
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/{conversation}/open/`
585
+ - **What it does**: Create-or-resume a sandbox conversation — the single sandbox session opener. With `content`, processes the turn (first message, in-progress follow-up, or terminal resume); without `content`, warms a sandbox that idles awaiting the first message. Returns the `(task, run)` handle the frontend opens SSE against. The conversation row is created on first use from the URL id.
586
+ - **OpenAPI operationId**: `conversations_open_create`
587
+ - **Path params**: `conversation`
588
+ - **Query params**: None
589
+ - **Response codes**: `200`, `204`, `400`
590
+ - **Transport options**: None
591
+ - **TypeScript**: [Client interface](../types.ts)
592
+
593
+ **Inputs**
594
+
595
+ - Client input type: `{ [key: string]: unknown }`
596
+ - Client transport options: None
597
+
598
+ **Outputs**
599
+
600
+ - Client return type: `{ task_id: string; run_id: string; trace_id: string | null; run_status: string; just_created_run: boolean }`
601
+ - OpenAPI response codes: `200`, `204`, `400`
602
+
603
+ ```ts
604
+ import posthog from "@utdk/posthog";
605
+
606
+ type ConversationsOpenCreateInput = Parameters<typeof posthog.conversationsOpenCreate> extends [infer T, ...unknown[]] ? T : undefined;
607
+ type ConversationsOpenCreateOutput = Awaited<ReturnType<typeof posthog.conversationsOpenCreate>>;
608
+
609
+ const result: ConversationsOpenCreateOutput = await posthog.conversationsOpenCreate();
610
+
611
+ // Result shape (from schema): { task_id: string; run_id: string; trace_id: string | null; run_status: string; just_created_run: boolean }
612
+ ```
613
+
614
+ ### `posthog.conversationsQueueRetrieve`
615
+
616
+ - **HTTP**: `GET /api/projects/{project_id}/conversations/{conversation}/queue/`
617
+ - **OpenAPI operationId**: `conversations_queue_retrieve`
618
+ - **Path params**: `conversation`
619
+ - **Query params**: None
620
+ - **Response codes**: `200`
621
+ - **Transport options**: None
622
+ - **TypeScript**: [Client interface](../types.ts)
623
+
624
+ **Inputs**
625
+
626
+ - Client input type: `{ [key: string]: unknown }`
627
+ - Client transport options: None
628
+
629
+ **Outputs**
630
+
631
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
632
+ - OpenAPI response codes: `200`
633
+
634
+ ```ts
635
+ import posthog from "@utdk/posthog";
636
+
637
+ type ConversationsQueueRetrieveInput = Parameters<typeof posthog.conversationsQueueRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
638
+ type ConversationsQueueRetrieveOutput = Awaited<ReturnType<typeof posthog.conversationsQueueRetrieve>>;
639
+
640
+ const result: ConversationsQueueRetrieveOutput = await posthog.conversationsQueueRetrieve();
641
+
642
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
643
+ ```
644
+
645
+ ### `posthog.conversationsQueueCreate`
646
+
647
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/{conversation}/queue/`
648
+ - **OpenAPI operationId**: `conversations_queue_create`
649
+ - **Path params**: `conversation`
650
+ - **Query params**: None
651
+ - **Response codes**: `200`
652
+ - **Transport options**: None
653
+ - **TypeScript**: [Client interface](../types.ts)
654
+
655
+ **Inputs**
656
+
657
+ - Client input type: `{ [key: string]: unknown }`
658
+ - Client transport options: None
659
+
660
+ **Outputs**
661
+
662
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
663
+ - OpenAPI response codes: `200`
664
+
665
+ ```ts
666
+ import posthog from "@utdk/posthog";
667
+
668
+ type ConversationsQueueCreateInput = Parameters<typeof posthog.conversationsQueueCreate> extends [infer T, ...unknown[]] ? T : undefined;
669
+ type ConversationsQueueCreateOutput = Awaited<ReturnType<typeof posthog.conversationsQueueCreate>>;
670
+
671
+ const result: ConversationsQueueCreateOutput = await posthog.conversationsQueueCreate();
672
+
673
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
674
+ ```
675
+
676
+ ### `posthog.conversationsQueueDestroy`
677
+
678
+ - **HTTP**: `DELETE /api/projects/{project_id}/conversations/{conversation}/queue/{queue_id}/`
679
+ - **OpenAPI operationId**: `conversations_queue_destroy`
680
+ - **Path params**: `conversation`, `queue_id`
681
+ - **Query params**: None
682
+ - **Response codes**: `204`
683
+ - **Transport options**: None
684
+ - **TypeScript**: [Client interface](../types.ts)
685
+
686
+ **Inputs**
687
+
688
+ - Client input type: `{ [key: string]: unknown }`
689
+ - Client transport options: None
690
+
691
+ **Outputs**
692
+
693
+ - Client return type: `unknown`
694
+ - OpenAPI response codes: `204`
695
+
696
+ ```ts
697
+ import posthog from "@utdk/posthog";
698
+
699
+ type ConversationsQueueDestroyInput = Parameters<typeof posthog.conversationsQueueDestroy> extends [infer T, ...unknown[]] ? T : undefined;
700
+ type ConversationsQueueDestroyOutput = Awaited<ReturnType<typeof posthog.conversationsQueueDestroy>>;
701
+
702
+ const result: ConversationsQueueDestroyOutput = await posthog.conversationsQueueDestroy();
703
+
704
+ // Result shape (from schema): unknown
705
+ ```
706
+
707
+ ### `posthog.conversationsQueuePartialUpdate`
708
+
709
+ - **HTTP**: `PATCH /api/projects/{project_id}/conversations/{conversation}/queue/{queue_id}/`
710
+ - **OpenAPI operationId**: `conversations_queue_partial_update`
711
+ - **Path params**: `conversation`, `queue_id`
712
+ - **Query params**: None
713
+ - **Response codes**: `200`
714
+ - **Transport options**: None
715
+ - **TypeScript**: [Client interface](../types.ts)
716
+
717
+ **Inputs**
718
+
719
+ - Client input type: `{ [key: string]: unknown }`
720
+ - Client transport options: None
721
+
722
+ **Outputs**
723
+
724
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
725
+ - OpenAPI response codes: `200`
726
+
727
+ ```ts
728
+ import posthog from "@utdk/posthog";
729
+
730
+ type ConversationsQueuePartialUpdateInput = Parameters<typeof posthog.conversationsQueuePartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
731
+ type ConversationsQueuePartialUpdateOutput = Awaited<ReturnType<typeof posthog.conversationsQueuePartialUpdate>>;
732
+
733
+ const result: ConversationsQueuePartialUpdateOutput = await posthog.conversationsQueuePartialUpdate();
734
+
735
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
736
+ ```
737
+
738
+ ### `posthog.conversationsQueueClearCreate`
739
+
740
+ - **HTTP**: `POST /api/projects/{project_id}/conversations/{conversation}/queue/clear/`
741
+ - **OpenAPI operationId**: `conversations_queue_clear_create`
742
+ - **Path params**: `conversation`
743
+ - **Query params**: None
744
+ - **Response codes**: `200`
745
+ - **Transport options**: None
746
+ - **TypeScript**: [Client interface](../types.ts)
747
+
748
+ **Inputs**
749
+
750
+ - Client input type: `{ [key: string]: unknown }`
751
+ - Client transport options: None
752
+
753
+ **Outputs**
754
+
755
+ - Client return type: `{ id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...`
756
+ - OpenAPI response codes: `200`
757
+
758
+ ```ts
759
+ import posthog from "@utdk/posthog";
760
+
761
+ type ConversationsQueueClearCreateInput = Parameters<typeof posthog.conversationsQueueClearCreate> extends [infer T, ...unknown[]] ? T : undefined;
762
+ type ConversationsQueueClearCreateOutput = Awaited<ReturnType<typeof posthog.conversationsQueueClearCreate>>;
763
+
764
+ const result: ConversationsQueueClearCreateOutput = await posthog.conversationsQueueClearCreate();
765
+
766
+ // Result shape (from schema): { id: string; status: "idle" | "in_progress" | "canceling"; title: string | null; topic: "web_analytics" | "product_analytics" | "session_replay" | "surveys" | "feature_flags" | "experiments" | "error_tracking" | "data_...
767
+ ```
768
+
769
+
770
+ <!-- prompt-hash:
771
+ 8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
772
+ -->