@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.
- package/LICENSE +373 -0
- package/README.md +172 -0
- package/docs/account_relationship_definitions.md +194 -0
- package/docs/accounts.md +380 -0
- package/docs/actions.md +274 -0
- package/docs/activity_logs.md +144 -0
- package/docs/advanced_activity_logs.md +101 -0
- package/docs/agent_platform.md +2525 -0
- package/docs/ai-observability.md +514 -0
- package/docs/alerts.md +444 -0
- package/docs/annotations.md +200 -0
- package/docs/batch_exports.md +2118 -0
- package/docs/business_knowledge.md +468 -0
- package/docs/code-invites.md +72 -0
- package/docs/cohorts.md +412 -0
- package/docs/comments.md +321 -0
- package/docs/conversations.md +695 -0
- package/docs/custom_property_definitions.md +442 -0
- package/docs/custom_property_sources.md +194 -0
- package/docs/customer_analytics.md +442 -0
- package/docs/customer_journeys.md +380 -0
- package/docs/customer_profile_configs.md +380 -0
- package/docs/dashboard_templates.md +258 -0
- package/docs/dashboards.md +1896 -0
- package/docs/data_color_themes.md +380 -0
- package/docs/data_modeling_jobs.md +264 -0
- package/docs/data_warehouse.md +928 -0
- package/docs/dataset_items.md +382 -0
- package/docs/datasets.md +382 -0
- package/docs/desktop_file_system.md +753 -0
- package/docs/desktop_file_system_shortcut.md +244 -0
- package/docs/docs.md +72 -0
- package/docs/early_access_feature.md +194 -0
- package/docs/elements.md +510 -0
- package/docs/endpoints.md +1030 -0
- package/docs/engineering_analytics.md +712 -0
- package/docs/environments.md +881 -0
- package/docs/error_tracking.md +5108 -0
- package/docs/evaluation_runs.md +78 -0
- package/docs/evaluations.md +446 -0
- package/docs/event_definitions.md +425 -0
- package/docs/event_filter.md +280 -0
- package/docs/event_schemas.md +163 -0
- package/docs/events.md +208 -0
- package/docs/experiment_holdouts.md +194 -0
- package/docs/experiment_saved_metrics.md +194 -0
- package/docs/experiments.md +1088 -0
- package/docs/exports.md +256 -0
- package/docs/external_data_schemas.md +752 -0
- package/docs/external_data_sources.md +2296 -0
- package/docs/feature_flags.md +808 -0
- package/docs/field_notes.md +206 -0
- package/docs/file_system.md +880 -0
- package/docs/file_system_shortcut.md +444 -0
- package/docs/flag_value.md +46 -0
- package/docs/groups.md +514 -0
- package/docs/groups_types.md +349 -0
- package/docs/health_issues.md +386 -0
- package/docs/heatmap_screenshots.md +72 -0
- package/docs/heatmaps.md +136 -0
- package/docs/hog_flows.md +1576 -0
- package/docs/hog_function_templates.md +101 -0
- package/docs/hog_functions.md +974 -0
- package/docs/ingestion_warnings_v2.md +40 -0
- package/docs/insight_variables.md +380 -0
- package/docs/insights.md +1722 -0
- package/docs/integrations.md +1954 -0
- package/docs/js-snippet.md +104 -0
- package/docs/live_debugger_breakpoints.md +264 -0
- package/docs/llm_analytics.md +3373 -0
- package/docs/llm_prompts.md +442 -0
- package/docs/llm_skills.md +952 -0
- package/docs/logs.md +2446 -0
- package/docs/managed_viewsets.md +140 -0
- package/docs/marketing_analytics.md +518 -0
- package/docs/max.md +772 -0
- package/docs/max_tools.md +70 -0
- package/docs/mcp_analytics.md +712 -0
- package/docs/mcp_server_installations.md +970 -0
- package/docs/mcp_servers.md +78 -0
- package/docs/mcp_tools.md +82 -0
- package/docs/messaging_templates.md +444 -0
- package/docs/metrics.md +462 -0
- package/docs/notebooks.md +838 -0
- package/docs/object_media_previews.md +228 -0
- package/docs/organizations.md +2958 -0
- package/docs/persons.md +1514 -0
- package/docs/platform_features.md +700 -0
- package/docs/plugin_configs.md +70 -0
- package/docs/product_enablement.md +39 -0
- package/docs/product_tours.md +357 -0
- package/docs/project_secret_api_keys.md +444 -0
- package/docs/property_access_controls.md +200 -0
- package/docs/property_definitions.md +244 -0
- package/docs/query.md +560 -0
- package/docs/quota_limits.md +40 -0
- package/docs/reminders.md +194 -0
- package/docs/replay.md +1020 -0
- package/docs/reverse_proxy.md +200 -0
- package/docs/sandbox-custom-images.md +209 -0
- package/docs/sandbox-environments.md +168 -0
- package/docs/saved.md +392 -0
- package/docs/saved_query_column_annotations.md +224 -0
- package/docs/scheduled_changes.md +200 -0
- package/docs/schema_property_groups.md +194 -0
- package/docs/sdk_health.md +40 -0
- package/docs/session_group_summaries.md +200 -0
- package/docs/session_recordings.md +260 -0
- package/docs/session_summaries.md +200 -0
- package/docs/sessions.md +132 -0
- package/docs/signals.md +1428 -0
- package/docs/single_session_summaries.md +72 -0
- package/docs/streamlit_apps.md +456 -0
- package/docs/subscriptions.md +634 -0
- package/docs/surveys.md +731 -0
- package/docs/taggers.md +446 -0
- package/docs/task-automations.md +200 -0
- package/docs/task-runs.md +654 -0
- package/docs/task_channels.md +136 -0
- package/docs/task_mentions.md +40 -0
- package/docs/tasks.md +776 -0
- package/docs/tracing.md +1186 -0
- package/docs/uploaded_media.md +44 -0
- package/docs/user_home_settings.md +72 -0
- package/docs/user_interview_topics.md +1288 -0
- package/docs/user_interviews.md +444 -0
- package/docs/users.md +1267 -0
- package/docs/vision.md +2022 -0
- package/docs/visual_review.md +816 -0
- package/docs/warehouse_column_annotations.md +224 -0
- package/docs/warehouse_column_statistics.md +80 -0
- package/docs/warehouse_dag.md +40 -0
- package/docs/warehouse_model_paths.md +70 -0
- package/docs/warehouse_saved_queries.md +1056 -0
- package/docs/warehouse_saved_query_folders.md +318 -0
- package/docs/warehouse_tables.md +584 -0
- package/docs/warehouse_view_link.md +456 -0
- package/docs/warehouse_view_links.md +456 -0
- package/docs/web_analytics.md +136 -0
- package/docs/web_analytics_achievements.md +200 -0
- package/docs/web_experiments.md +194 -0
- package/docs/web_vitals.md +74 -0
- package/docs/wizard.md +170 -0
- package/index.ts +22 -0
- package/metadata.ts +41419 -0
- package/openapi.json +297382 -0
- package/overlay.yaml +23 -0
- package/package.json +34 -0
- package/provenance.json +24 -0
- package/research.json +80 -0
- package/types/index.ts +17547 -0
|
@@ -0,0 +1,654 @@
|
|
|
1
|
+
# Task Runs
|
|
2
|
+
|
|
3
|
+
## Operations
|
|
4
|
+
|
|
5
|
+
### `posthog.tasksRunsList`
|
|
6
|
+
|
|
7
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/`
|
|
8
|
+
- **What it does**: List task runs
|
|
9
|
+
- **OpenAPI operationId**: `tasks_runs_list`
|
|
10
|
+
- **Path params**: `task_id`
|
|
11
|
+
- **Query params**: `limit`, `offset`
|
|
12
|
+
- **Response codes**: `200`
|
|
13
|
+
- **Transport options**: None
|
|
14
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
15
|
+
|
|
16
|
+
**Inputs**
|
|
17
|
+
|
|
18
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
19
|
+
- Client transport options: None
|
|
20
|
+
|
|
21
|
+
**Outputs**
|
|
22
|
+
|
|
23
|
+
- Client return type: `{ count: number; next?: string | null; previous?: string | null; results: ({ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "code...`
|
|
24
|
+
- OpenAPI response codes: `200`
|
|
25
|
+
|
|
26
|
+
```ts
|
|
27
|
+
import posthog from "@utdk/posthog";
|
|
28
|
+
|
|
29
|
+
type TasksRunsListInput = Parameters<typeof posthog.tasksRunsList> extends [infer T, ...unknown[]] ? T : undefined;
|
|
30
|
+
type TasksRunsListOutput = Awaited<ReturnType<typeof posthog.tasksRunsList>>;
|
|
31
|
+
|
|
32
|
+
const result: TasksRunsListOutput = await posthog.tasksRunsList();
|
|
33
|
+
|
|
34
|
+
// Result shape (from schema): { count: number; next?: string | null; previous?: string | null; results: ({ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "code...
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### `posthog.tasksRunsCreate`
|
|
38
|
+
|
|
39
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/`
|
|
40
|
+
- **What it does**: Create task run
|
|
41
|
+
- **OpenAPI operationId**: `tasks_runs_create`
|
|
42
|
+
- **Path params**: `task_id`
|
|
43
|
+
- **Query params**: None
|
|
44
|
+
- **Response codes**: `201`, `400`, `429`
|
|
45
|
+
- **Transport options**: None
|
|
46
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
47
|
+
|
|
48
|
+
**Inputs**
|
|
49
|
+
|
|
50
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
51
|
+
- Client transport options: None
|
|
52
|
+
|
|
53
|
+
**Outputs**
|
|
54
|
+
|
|
55
|
+
- Client return type: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
56
|
+
- OpenAPI response codes: `201`, `400`, `429`
|
|
57
|
+
|
|
58
|
+
```ts
|
|
59
|
+
import posthog from "@utdk/posthog";
|
|
60
|
+
|
|
61
|
+
type TasksRunsCreateInput = Parameters<typeof posthog.tasksRunsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
62
|
+
type TasksRunsCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsCreate>>;
|
|
63
|
+
|
|
64
|
+
const result: TasksRunsCreateOutput = await posthog.tasksRunsCreate();
|
|
65
|
+
|
|
66
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### `posthog.tasksRunsRetrieve`
|
|
70
|
+
|
|
71
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/`
|
|
72
|
+
- **What it does**: Get task run
|
|
73
|
+
- **OpenAPI operationId**: `tasks_runs_retrieve`
|
|
74
|
+
- **Path params**: `id`, `task_id`
|
|
75
|
+
- **Query params**: None
|
|
76
|
+
- **Response codes**: `200`, `404`
|
|
77
|
+
- **Transport options**: None
|
|
78
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
79
|
+
|
|
80
|
+
**Inputs**
|
|
81
|
+
|
|
82
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
83
|
+
- Client transport options: None
|
|
84
|
+
|
|
85
|
+
**Outputs**
|
|
86
|
+
|
|
87
|
+
- Client return type: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
88
|
+
- OpenAPI response codes: `200`, `404`
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import posthog from "@utdk/posthog";
|
|
92
|
+
|
|
93
|
+
type TasksRunsRetrieveInput = Parameters<typeof posthog.tasksRunsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
94
|
+
type TasksRunsRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsRetrieve>>;
|
|
95
|
+
|
|
96
|
+
const result: TasksRunsRetrieveOutput = await posthog.tasksRunsRetrieve();
|
|
97
|
+
|
|
98
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### `posthog.tasksRunsPartialUpdate`
|
|
102
|
+
|
|
103
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/tasks/{task_id}/runs/{id}/`
|
|
104
|
+
- **What it does**: Update task run
|
|
105
|
+
- **OpenAPI operationId**: `tasks_runs_partial_update`
|
|
106
|
+
- **Path params**: `id`, `task_id`
|
|
107
|
+
- **Query params**: None
|
|
108
|
+
- **Response codes**: `200`, `400`, `404`
|
|
109
|
+
- **Transport options**: None
|
|
110
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
111
|
+
|
|
112
|
+
**Inputs**
|
|
113
|
+
|
|
114
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
115
|
+
- Client transport options: None
|
|
116
|
+
|
|
117
|
+
**Outputs**
|
|
118
|
+
|
|
119
|
+
- Client return type: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
120
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
import posthog from "@utdk/posthog";
|
|
124
|
+
|
|
125
|
+
type TasksRunsPartialUpdateInput = Parameters<typeof posthog.tasksRunsPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
126
|
+
type TasksRunsPartialUpdateOutput = Awaited<ReturnType<typeof posthog.tasksRunsPartialUpdate>>;
|
|
127
|
+
|
|
128
|
+
const result: TasksRunsPartialUpdateOutput = await posthog.tasksRunsPartialUpdate();
|
|
129
|
+
|
|
130
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### `posthog.tasksRunsAppendLogCreate`
|
|
134
|
+
|
|
135
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/append_log/`
|
|
136
|
+
- **What it does**: Append log entries
|
|
137
|
+
- **OpenAPI operationId**: `tasks_runs_append_log_create`
|
|
138
|
+
- **Path params**: `id`, `task_id`
|
|
139
|
+
- **Query params**: None
|
|
140
|
+
- **Response codes**: `200`, `400`, `404`
|
|
141
|
+
- **Transport options**: None
|
|
142
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
143
|
+
|
|
144
|
+
**Inputs**
|
|
145
|
+
|
|
146
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
147
|
+
- Client transport options: None
|
|
148
|
+
|
|
149
|
+
**Outputs**
|
|
150
|
+
|
|
151
|
+
- Client return type: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
152
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
import posthog from "@utdk/posthog";
|
|
156
|
+
|
|
157
|
+
type TasksRunsAppendLogCreateInput = Parameters<typeof posthog.tasksRunsAppendLogCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
158
|
+
type TasksRunsAppendLogCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsAppendLogCreate>>;
|
|
159
|
+
|
|
160
|
+
const result: TasksRunsAppendLogCreateOutput = await posthog.tasksRunsAppendLogCreate();
|
|
161
|
+
|
|
162
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### `posthog.tasksRunsArtifactsCreate`
|
|
166
|
+
|
|
167
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/artifacts/`
|
|
168
|
+
- **What it does**: Upload artifacts for a task run
|
|
169
|
+
- **OpenAPI operationId**: `tasks_runs_artifacts_create`
|
|
170
|
+
- **Path params**: `id`, `task_id`
|
|
171
|
+
- **Query params**: None
|
|
172
|
+
- **Response codes**: `200`, `400`, `404`
|
|
173
|
+
- **Transport options**: None
|
|
174
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
175
|
+
|
|
176
|
+
**Inputs**
|
|
177
|
+
|
|
178
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
179
|
+
- Client transport options: None
|
|
180
|
+
|
|
181
|
+
**Outputs**
|
|
182
|
+
|
|
183
|
+
- Client return type: `{ artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...`
|
|
184
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
185
|
+
|
|
186
|
+
```ts
|
|
187
|
+
import posthog from "@utdk/posthog";
|
|
188
|
+
|
|
189
|
+
type TasksRunsArtifactsCreateInput = Parameters<typeof posthog.tasksRunsArtifactsCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
190
|
+
type TasksRunsArtifactsCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsArtifactsCreate>>;
|
|
191
|
+
|
|
192
|
+
const result: TasksRunsArtifactsCreateOutput = await posthog.tasksRunsArtifactsCreate();
|
|
193
|
+
|
|
194
|
+
// Result shape (from schema): { artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### `posthog.tasksRunsArtifactsDownloadCreate`
|
|
198
|
+
|
|
199
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/artifacts/download/`
|
|
200
|
+
- **What it does**: Download an artifact through the backend
|
|
201
|
+
- **OpenAPI operationId**: `tasks_runs_artifacts_download_create`
|
|
202
|
+
- **Path params**: `id`, `task_id`
|
|
203
|
+
- **Query params**: None
|
|
204
|
+
- **Response codes**: `200`, `400`, `404`
|
|
205
|
+
- **Transport options**: None
|
|
206
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
207
|
+
|
|
208
|
+
**Inputs**
|
|
209
|
+
|
|
210
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
211
|
+
- Client transport options: None
|
|
212
|
+
|
|
213
|
+
**Outputs**
|
|
214
|
+
|
|
215
|
+
- Client return type: `unknown`
|
|
216
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
217
|
+
|
|
218
|
+
```ts
|
|
219
|
+
import posthog from "@utdk/posthog";
|
|
220
|
+
|
|
221
|
+
type TasksRunsArtifactsDownloadCreateInput = Parameters<typeof posthog.tasksRunsArtifactsDownloadCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
222
|
+
type TasksRunsArtifactsDownloadCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsArtifactsDownloadCreate>>;
|
|
223
|
+
|
|
224
|
+
const result: TasksRunsArtifactsDownloadCreateOutput = await posthog.tasksRunsArtifactsDownloadCreate();
|
|
225
|
+
|
|
226
|
+
// Result shape (from schema): unknown
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### `posthog.tasksRunsArtifactsFinalizeUploadCreate`
|
|
230
|
+
|
|
231
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/artifacts/finalize_upload/`
|
|
232
|
+
- **What it does**: Finalize direct uploads for task run artifacts
|
|
233
|
+
- **OpenAPI operationId**: `tasks_runs_artifacts_finalize_upload_create`
|
|
234
|
+
- **Path params**: `id`, `task_id`
|
|
235
|
+
- **Query params**: None
|
|
236
|
+
- **Response codes**: `200`, `400`, `404`
|
|
237
|
+
- **Transport options**: None
|
|
238
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
239
|
+
|
|
240
|
+
**Inputs**
|
|
241
|
+
|
|
242
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
243
|
+
- Client transport options: None
|
|
244
|
+
|
|
245
|
+
**Outputs**
|
|
246
|
+
|
|
247
|
+
- Client return type: `{ artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...`
|
|
248
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
249
|
+
|
|
250
|
+
```ts
|
|
251
|
+
import posthog from "@utdk/posthog";
|
|
252
|
+
|
|
253
|
+
type TasksRunsArtifactsFinalizeUploadCreateInput = Parameters<typeof posthog.tasksRunsArtifactsFinalizeUploadCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
254
|
+
type TasksRunsArtifactsFinalizeUploadCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsArtifactsFinalizeUploadCreate>>;
|
|
255
|
+
|
|
256
|
+
const result: TasksRunsArtifactsFinalizeUploadCreateOutput = await posthog.tasksRunsArtifactsFinalizeUploadCreate();
|
|
257
|
+
|
|
258
|
+
// Result shape (from schema): { artifacts: ({ id?: string; name: string; type: string; source?: string; size?: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: s...
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### `posthog.tasksRunsArtifactsPrepareUploadCreate`
|
|
262
|
+
|
|
263
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/artifacts/prepare_upload/`
|
|
264
|
+
- **What it does**: Prepare direct uploads for task run artifacts
|
|
265
|
+
- **OpenAPI operationId**: `tasks_runs_artifacts_prepare_upload_create`
|
|
266
|
+
- **Path params**: `id`, `task_id`
|
|
267
|
+
- **Query params**: None
|
|
268
|
+
- **Response codes**: `200`, `400`, `404`
|
|
269
|
+
- **Transport options**: None
|
|
270
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
271
|
+
|
|
272
|
+
**Inputs**
|
|
273
|
+
|
|
274
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
275
|
+
- Client transport options: None
|
|
276
|
+
|
|
277
|
+
**Outputs**
|
|
278
|
+
|
|
279
|
+
- Client return type: `{ artifacts: ({ id: string; name: string; type: string; source?: string; size: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: str...`
|
|
280
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
281
|
+
|
|
282
|
+
```ts
|
|
283
|
+
import posthog from "@utdk/posthog";
|
|
284
|
+
|
|
285
|
+
type TasksRunsArtifactsPrepareUploadCreateInput = Parameters<typeof posthog.tasksRunsArtifactsPrepareUploadCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
286
|
+
type TasksRunsArtifactsPrepareUploadCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsArtifactsPrepareUploadCreate>>;
|
|
287
|
+
|
|
288
|
+
const result: TasksRunsArtifactsPrepareUploadCreateOutput = await posthog.tasksRunsArtifactsPrepareUploadCreate();
|
|
289
|
+
|
|
290
|
+
// Result shape (from schema): { artifacts: ({ id: string; name: string; type: string; source?: string; size: number; content_type?: string; metadata?: { skill_name: string; skill_source: "user" | "repo" | "marketplace" | "codex"; content_sha256: str...
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
### `posthog.tasksRunsArtifactsPresignCreate`
|
|
294
|
+
|
|
295
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/artifacts/presign/`
|
|
296
|
+
- **What it does**: Generate presigned URL for an artifact
|
|
297
|
+
- **OpenAPI operationId**: `tasks_runs_artifacts_presign_create`
|
|
298
|
+
- **Path params**: `id`, `task_id`
|
|
299
|
+
- **Query params**: None
|
|
300
|
+
- **Response codes**: `200`, `400`, `404`
|
|
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: `{ url: string; expires_in: number }`
|
|
312
|
+
- OpenAPI response codes: `200`, `400`, `404`
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
import posthog from "@utdk/posthog";
|
|
316
|
+
|
|
317
|
+
type TasksRunsArtifactsPresignCreateInput = Parameters<typeof posthog.tasksRunsArtifactsPresignCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
318
|
+
type TasksRunsArtifactsPresignCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsArtifactsPresignCreate>>;
|
|
319
|
+
|
|
320
|
+
const result: TasksRunsArtifactsPresignCreateOutput = await posthog.tasksRunsArtifactsPresignCreate();
|
|
321
|
+
|
|
322
|
+
// Result shape (from schema): { url: string; expires_in: number }
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### `posthog.tasksRunsCommandCreate`
|
|
326
|
+
|
|
327
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/command/`
|
|
328
|
+
- **What it does**: Send command to task run
|
|
329
|
+
- **OpenAPI operationId**: `tasks_runs_command_create`
|
|
330
|
+
- **Path params**: `id`, `task_id`
|
|
331
|
+
- **Query params**: None
|
|
332
|
+
- **Response codes**: `200`, `400`, `404`, `502`
|
|
333
|
+
- **Transport options**: None
|
|
334
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
335
|
+
|
|
336
|
+
**Inputs**
|
|
337
|
+
|
|
338
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
339
|
+
- Client transport options: None
|
|
340
|
+
|
|
341
|
+
**Outputs**
|
|
342
|
+
|
|
343
|
+
- Client return type: `{ jsonrpc: string; id?: unknown; result?: { [key: string]: unknown }; error?: { [key: string]: unknown } }`
|
|
344
|
+
- OpenAPI response codes: `200`, `400`, `404`, `502`
|
|
345
|
+
|
|
346
|
+
```ts
|
|
347
|
+
import posthog from "@utdk/posthog";
|
|
348
|
+
|
|
349
|
+
type TasksRunsCommandCreateInput = Parameters<typeof posthog.tasksRunsCommandCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
350
|
+
type TasksRunsCommandCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsCommandCreate>>;
|
|
351
|
+
|
|
352
|
+
const result: TasksRunsCommandCreateOutput = await posthog.tasksRunsCommandCreate();
|
|
353
|
+
|
|
354
|
+
// Result shape (from schema): { jsonrpc: string; id?: unknown; result?: { [key: string]: unknown }; error?: { [key: string]: unknown } }
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
### `posthog.tasksRunsConnectionTokenRetrieve`
|
|
358
|
+
|
|
359
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/connection_token/`
|
|
360
|
+
- **What it does**: Get sandbox connection token
|
|
361
|
+
- **OpenAPI operationId**: `tasks_runs_connection_token_retrieve`
|
|
362
|
+
- **Path params**: `id`, `task_id`
|
|
363
|
+
- **Query params**: None
|
|
364
|
+
- **Response codes**: `200`, `404`
|
|
365
|
+
- **Transport options**: None
|
|
366
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
367
|
+
|
|
368
|
+
**Inputs**
|
|
369
|
+
|
|
370
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
371
|
+
- Client transport options: None
|
|
372
|
+
|
|
373
|
+
**Outputs**
|
|
374
|
+
|
|
375
|
+
- Client return type: `{ token: string }`
|
|
376
|
+
- OpenAPI response codes: `200`, `404`
|
|
377
|
+
|
|
378
|
+
```ts
|
|
379
|
+
import posthog from "@utdk/posthog";
|
|
380
|
+
|
|
381
|
+
type TasksRunsConnectionTokenRetrieveInput = Parameters<typeof posthog.tasksRunsConnectionTokenRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
382
|
+
type TasksRunsConnectionTokenRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsConnectionTokenRetrieve>>;
|
|
383
|
+
|
|
384
|
+
const result: TasksRunsConnectionTokenRetrieveOutput = await posthog.tasksRunsConnectionTokenRetrieve();
|
|
385
|
+
|
|
386
|
+
// Result shape (from schema): { token: string }
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### `posthog.tasksRunsLogsRetrieve`
|
|
390
|
+
|
|
391
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/logs/`
|
|
392
|
+
- **What it does**: Get task run logs
|
|
393
|
+
- **OpenAPI operationId**: `tasks_runs_logs_retrieve`
|
|
394
|
+
- **Path params**: `id`, `task_id`
|
|
395
|
+
- **Query params**: None
|
|
396
|
+
- **Response codes**: `200`, `404`
|
|
397
|
+
- **Transport options**: None
|
|
398
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
399
|
+
|
|
400
|
+
**Inputs**
|
|
401
|
+
|
|
402
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
403
|
+
- Client transport options: None
|
|
404
|
+
|
|
405
|
+
**Outputs**
|
|
406
|
+
|
|
407
|
+
- Client return type: `unknown`
|
|
408
|
+
- OpenAPI response codes: `200`, `404`
|
|
409
|
+
|
|
410
|
+
```ts
|
|
411
|
+
import posthog from "@utdk/posthog";
|
|
412
|
+
|
|
413
|
+
type TasksRunsLogsRetrieveInput = Parameters<typeof posthog.tasksRunsLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
414
|
+
type TasksRunsLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsLogsRetrieve>>;
|
|
415
|
+
|
|
416
|
+
const result: TasksRunsLogsRetrieveOutput = await posthog.tasksRunsLogsRetrieve();
|
|
417
|
+
|
|
418
|
+
// Result shape (from schema): unknown
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### `posthog.tasksRunsRelayMessageCreate`
|
|
422
|
+
|
|
423
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/relay_message/`
|
|
424
|
+
- **What it does**: Relay run message to Slack
|
|
425
|
+
- **OpenAPI operationId**: `tasks_runs_relay_message_create`
|
|
426
|
+
- **Path params**: `id`, `task_id`
|
|
427
|
+
- **Query params**: None
|
|
428
|
+
- **Response codes**: `200`, `404`
|
|
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: `{ status: string; relay_id?: string }`
|
|
440
|
+
- OpenAPI response codes: `200`, `404`
|
|
441
|
+
|
|
442
|
+
```ts
|
|
443
|
+
import posthog from "@utdk/posthog";
|
|
444
|
+
|
|
445
|
+
type TasksRunsRelayMessageCreateInput = Parameters<typeof posthog.tasksRunsRelayMessageCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
446
|
+
type TasksRunsRelayMessageCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsRelayMessageCreate>>;
|
|
447
|
+
|
|
448
|
+
const result: TasksRunsRelayMessageCreateOutput = await posthog.tasksRunsRelayMessageCreate();
|
|
449
|
+
|
|
450
|
+
// Result shape (from schema): { status: string; relay_id?: string }
|
|
451
|
+
```
|
|
452
|
+
|
|
453
|
+
### `posthog.tasksRunsResumeInCloudCreate`
|
|
454
|
+
|
|
455
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/resume_in_cloud/`
|
|
456
|
+
- **What it does**: Resume task run in cloud
|
|
457
|
+
- **OpenAPI operationId**: `tasks_runs_resume_in_cloud_create`
|
|
458
|
+
- **Path params**: `id`, `task_id`
|
|
459
|
+
- **Query params**: None
|
|
460
|
+
- **Response codes**: `200`, `400`, `429`
|
|
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: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
472
|
+
- OpenAPI response codes: `200`, `400`, `429`
|
|
473
|
+
|
|
474
|
+
```ts
|
|
475
|
+
import posthog from "@utdk/posthog";
|
|
476
|
+
|
|
477
|
+
type TasksRunsResumeInCloudCreateInput = Parameters<typeof posthog.tasksRunsResumeInCloudCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
478
|
+
type TasksRunsResumeInCloudCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsResumeInCloudCreate>>;
|
|
479
|
+
|
|
480
|
+
const result: TasksRunsResumeInCloudCreateOutput = await posthog.tasksRunsResumeInCloudCreate();
|
|
481
|
+
|
|
482
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### `posthog.tasksRunsSessionLogsRetrieve`
|
|
486
|
+
|
|
487
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/session_logs/`
|
|
488
|
+
- **What it does**: Get filtered task run session logs
|
|
489
|
+
- **OpenAPI operationId**: `tasks_runs_session_logs_retrieve`
|
|
490
|
+
- **Path params**: `id`, `task_id`
|
|
491
|
+
- **Query params**: `after`, `event_types`, `exclude_types`, `limit`, `offset`
|
|
492
|
+
- **Response codes**: `200`, `404`
|
|
493
|
+
- **Transport options**: None
|
|
494
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
495
|
+
|
|
496
|
+
**Inputs**
|
|
497
|
+
|
|
498
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
499
|
+
- Client transport options: None
|
|
500
|
+
|
|
501
|
+
**Outputs**
|
|
502
|
+
|
|
503
|
+
- Client return type: `unknown`
|
|
504
|
+
- OpenAPI response codes: `200`, `404`
|
|
505
|
+
|
|
506
|
+
```ts
|
|
507
|
+
import posthog from "@utdk/posthog";
|
|
508
|
+
|
|
509
|
+
type TasksRunsSessionLogsRetrieveInput = Parameters<typeof posthog.tasksRunsSessionLogsRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
510
|
+
type TasksRunsSessionLogsRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsSessionLogsRetrieve>>;
|
|
511
|
+
|
|
512
|
+
const result: TasksRunsSessionLogsRetrieveOutput = await posthog.tasksRunsSessionLogsRetrieve();
|
|
513
|
+
|
|
514
|
+
// Result shape (from schema): unknown
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
### `posthog.tasksRunsSetOutputPartialUpdate`
|
|
518
|
+
|
|
519
|
+
- **HTTP**: `PATCH /api/projects/{project_id}/tasks/{task_id}/runs/{id}/set_output/`
|
|
520
|
+
- **What it does**: Set run output
|
|
521
|
+
- **OpenAPI operationId**: `tasks_runs_set_output_partial_update`
|
|
522
|
+
- **Path params**: `id`, `task_id`
|
|
523
|
+
- **Query params**: None
|
|
524
|
+
- **Response codes**: `200`, `404`
|
|
525
|
+
- **Transport options**: None
|
|
526
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
527
|
+
|
|
528
|
+
**Inputs**
|
|
529
|
+
|
|
530
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
531
|
+
- Client transport options: None
|
|
532
|
+
|
|
533
|
+
**Outputs**
|
|
534
|
+
|
|
535
|
+
- Client return type: `{ id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...`
|
|
536
|
+
- OpenAPI response codes: `200`, `404`
|
|
537
|
+
|
|
538
|
+
```ts
|
|
539
|
+
import posthog from "@utdk/posthog";
|
|
540
|
+
|
|
541
|
+
type TasksRunsSetOutputPartialUpdateInput = Parameters<typeof posthog.tasksRunsSetOutputPartialUpdate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
542
|
+
type TasksRunsSetOutputPartialUpdateOutput = Awaited<ReturnType<typeof posthog.tasksRunsSetOutputPartialUpdate>>;
|
|
543
|
+
|
|
544
|
+
const result: TasksRunsSetOutputPartialUpdateOutput = await posthog.tasksRunsSetOutputPartialUpdate();
|
|
545
|
+
|
|
546
|
+
// Result shape (from schema): { id: string; task: string; stage: string | null; branch: string | null; status: string; environment: string; runtime_adapter?: "claude" | "codex" | null; provider?: "anthropic" | "openai" | null; model?: string | null;...
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
### `posthog.tasksRunsStartCreate`
|
|
550
|
+
|
|
551
|
+
- **HTTP**: `POST /api/projects/{project_id}/tasks/{task_id}/runs/{id}/start/`
|
|
552
|
+
- **What it does**: Start task run
|
|
553
|
+
- **OpenAPI operationId**: `tasks_runs_start_create`
|
|
554
|
+
- **Path params**: `id`, `task_id`
|
|
555
|
+
- **Query params**: None
|
|
556
|
+
- **Response codes**: `200`, `400`, `404`, `429`
|
|
557
|
+
- **Transport options**: None
|
|
558
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
559
|
+
|
|
560
|
+
**Inputs**
|
|
561
|
+
|
|
562
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
563
|
+
- Client transport options: None
|
|
564
|
+
|
|
565
|
+
**Outputs**
|
|
566
|
+
|
|
567
|
+
- Client return type: `{ id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...`
|
|
568
|
+
- OpenAPI response codes: `200`, `400`, `404`, `429`
|
|
569
|
+
|
|
570
|
+
```ts
|
|
571
|
+
import posthog from "@utdk/posthog";
|
|
572
|
+
|
|
573
|
+
type TasksRunsStartCreateInput = Parameters<typeof posthog.tasksRunsStartCreate> extends [infer T, ...unknown[]] ? T : undefined;
|
|
574
|
+
type TasksRunsStartCreateOutput = Awaited<ReturnType<typeof posthog.tasksRunsStartCreate>>;
|
|
575
|
+
|
|
576
|
+
const result: TasksRunsStartCreateOutput = await posthog.tasksRunsStartCreate();
|
|
577
|
+
|
|
578
|
+
// Result shape (from schema): { id: string; task_number: number | null; slug: string; title: string; title_manually_set: boolean; description: string; origin_product: string; repository: string | null; github_integration: number | null; github_user_...
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
### `posthog.tasksRunsStreamTokenRetrieve`
|
|
582
|
+
|
|
583
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/stream_token/`
|
|
584
|
+
- **What it does**: Get task run stream read token
|
|
585
|
+
- **OpenAPI operationId**: `tasks_runs_stream_token_retrieve`
|
|
586
|
+
- **Path params**: `id`, `task_id`
|
|
587
|
+
- **Query params**: None
|
|
588
|
+
- **Response codes**: `200`, `404`
|
|
589
|
+
- **Transport options**: None
|
|
590
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
591
|
+
|
|
592
|
+
**Inputs**
|
|
593
|
+
|
|
594
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
595
|
+
- Client transport options: None
|
|
596
|
+
|
|
597
|
+
**Outputs**
|
|
598
|
+
|
|
599
|
+
- Client return type: `{ token: string; stream_base_url: string | null }`
|
|
600
|
+
- OpenAPI response codes: `200`, `404`
|
|
601
|
+
|
|
602
|
+
```ts
|
|
603
|
+
import posthog from "@utdk/posthog";
|
|
604
|
+
|
|
605
|
+
type TasksRunsStreamTokenRetrieveInput = Parameters<typeof posthog.tasksRunsStreamTokenRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
606
|
+
type TasksRunsStreamTokenRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsStreamTokenRetrieve>>;
|
|
607
|
+
|
|
608
|
+
const result: TasksRunsStreamTokenRetrieveOutput = await posthog.tasksRunsStreamTokenRetrieve();
|
|
609
|
+
|
|
610
|
+
// Result shape (from schema): { token: string; stream_base_url: string | null }
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
### `posthog.tasksRunsStreamRetrieve`
|
|
614
|
+
|
|
615
|
+
- **HTTP**: `GET /api/projects/{project_id}/tasks/{task_id}/runs/{id}/stream/`
|
|
616
|
+
- **What it does**: Server-Sent Events stream of task run events. Events carry an `id:` line (a Redis stream id) usable as a resume cursor.
|
|
617
|
+
|
|
618
|
+
The server caps each connection at 900 seconds: it emits `event: end` with `data: {"type": "rotated"}` and closes. This does NOT mean the run finished — reconnect with the `Last-Event-ID` header set to the last received event id to resume without gaps or duplicates. Only treat the stream as complete when the run itself reaches a terminal status.
|
|
619
|
+
|
|
620
|
+
`?start=latest` consumers must also carry `Last-Event-ID` across reconnects: reconnecting without it re-resolves to the then-current latest event, silently skipping anything published while disconnected.
|
|
621
|
+
|
|
622
|
+
**SDK consumers**: do not call the generated fetch wrapper for this path — it will buffer the entire stream. Use the URL builder (`getTasksRunsStreamRetrieveUrl`) with a streaming `fetch`/`EventSource`-style consumer and the `Last-Event-ID` header instead.
|
|
623
|
+
- **OpenAPI operationId**: `tasks_runs_stream_retrieve`
|
|
624
|
+
- **Path params**: `id`, `task_id`
|
|
625
|
+
- **Query params**: `start`
|
|
626
|
+
- **Response codes**: `200`
|
|
627
|
+
- **Transport options**: None
|
|
628
|
+
- **TypeScript**: [Client interface](../types.ts)
|
|
629
|
+
|
|
630
|
+
**Inputs**
|
|
631
|
+
|
|
632
|
+
- Client input type: `{ [key: string]: unknown }`
|
|
633
|
+
- Client transport options: None
|
|
634
|
+
|
|
635
|
+
**Outputs**
|
|
636
|
+
|
|
637
|
+
- Client return type: `string`
|
|
638
|
+
- OpenAPI response codes: `200`
|
|
639
|
+
|
|
640
|
+
```ts
|
|
641
|
+
import posthog from "@utdk/posthog";
|
|
642
|
+
|
|
643
|
+
type TasksRunsStreamRetrieveInput = Parameters<typeof posthog.tasksRunsStreamRetrieve> extends [infer T, ...unknown[]] ? T : undefined;
|
|
644
|
+
type TasksRunsStreamRetrieveOutput = Awaited<ReturnType<typeof posthog.tasksRunsStreamRetrieve>>;
|
|
645
|
+
|
|
646
|
+
const result: TasksRunsStreamRetrieveOutput = await posthog.tasksRunsStreamRetrieve();
|
|
647
|
+
|
|
648
|
+
// Result shape (from schema): string
|
|
649
|
+
```
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<!-- prompt-hash:
|
|
653
|
+
8c3694991a4c289225f05a4e8f1e098cc74d085a088d7dffd82f00d93797b7f8
|
|
654
|
+
-->
|