v0-api 0.1.3 → 0.1.4
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/README.md +68 -0
- package/dist/components.cjs +44 -44
- package/dist/components.d.cts +132 -132
- package/dist/components.d.mts +132 -132
- package/dist/components.mjs +44 -44
- package/dist/effect.cjs +10 -10
- package/dist/effect.d.cts +132 -132
- package/dist/effect.d.mts +132 -132
- package/dist/effect.mjs +10 -10
- package/dist/index.cjs +699 -699
- package/dist/index.d.cts +1797 -1813
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +1797 -1813
- package/dist/index.d.mts.map +1 -1
- package/dist/index.d.ts +1797 -1813
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +699 -699
- package/dist/schemas.cjs +667 -667
- package/dist/schemas.mjs +652 -652
- package/dist/types.cjs +3 -3
- package/dist/types.d.cts +1665 -1681
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +1665 -1681
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +3 -3
- package/package.json +4 -4
package/dist/components.d.mts
CHANGED
|
@@ -34,9 +34,9 @@ type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
|
|
|
34
34
|
declare function client<TData, TError, TBody, THeaders, TQueryParams, TPathParams>({ url, method, body, headers, queryParams, signal, token, baseUrl, fetchImpl, }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams>): Promise<TData>;
|
|
35
35
|
|
|
36
36
|
/**
|
|
37
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
38
|
-
* Do not edit manually.
|
|
39
|
-
*/
|
|
37
|
+
* Generated by Kubb (https://kubb.dev/).
|
|
38
|
+
* Do not edit manually.
|
|
39
|
+
*/
|
|
40
40
|
|
|
41
41
|
/**
|
|
42
42
|
* @summary Create Chat
|
|
@@ -53,13 +53,13 @@ declare function chatsCreate({ config }?: {
|
|
|
53
53
|
* @description Retrieves a list of existing chats, with support for pagination and filtering by favorite status, Vercel project, or Git branch. Helps manage and navigate chat history.
|
|
54
54
|
* @link /chats
|
|
55
55
|
*/
|
|
56
|
-
declare function chatsFind({ queryParams, config }?: {
|
|
56
|
+
declare function chatsFind({ queryParams, config, }?: {
|
|
57
57
|
queryParams?: {
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
58
|
+
limit?: number;
|
|
59
|
+
offset?: number;
|
|
60
|
+
isFavorite?: "true" | "false";
|
|
61
|
+
vercelProjectId?: string;
|
|
62
|
+
branch?: string;
|
|
63
63
|
};
|
|
64
64
|
config?: Partial<FetcherConfig> & {
|
|
65
65
|
client?: typeof client;
|
|
@@ -80,9 +80,9 @@ declare function chatsInit({ config }?: {
|
|
|
80
80
|
* @description Deletes a specific chat based on the provided chatId. The chat and its contents are moved to trash and stop being retrievable immediately, then retained for 30 days before being permanently removed.
|
|
81
81
|
* @link /chats/{chatId}
|
|
82
82
|
*/
|
|
83
|
-
declare function chatsDelete({ pathParams, config }?: {
|
|
83
|
+
declare function chatsDelete({ pathParams, config, }?: {
|
|
84
84
|
pathParams: {
|
|
85
|
-
|
|
85
|
+
chatId: string;
|
|
86
86
|
};
|
|
87
87
|
config?: Partial<FetcherConfig> & {
|
|
88
88
|
client?: typeof client;
|
|
@@ -93,9 +93,9 @@ declare function chatsDelete({ pathParams, config }?: {
|
|
|
93
93
|
* @description Retrieves the full details of a specific chat using its `chatId`. Includes messages, metadata, and associated configuration.
|
|
94
94
|
* @link /chats/{chatId}
|
|
95
95
|
*/
|
|
96
|
-
declare function chatsGetById({ pathParams, config }?: {
|
|
96
|
+
declare function chatsGetById({ pathParams, config, }?: {
|
|
97
97
|
pathParams: {
|
|
98
|
-
|
|
98
|
+
chatId: string;
|
|
99
99
|
};
|
|
100
100
|
config?: Partial<FetcherConfig> & {
|
|
101
101
|
client?: typeof client;
|
|
@@ -106,9 +106,9 @@ declare function chatsGetById({ pathParams, config }?: {
|
|
|
106
106
|
* @description Updates the metadata of an existing chat using its `chatId`. Supports changes to the chat name and privacy setting.
|
|
107
107
|
* @link /chats/{chatId}
|
|
108
108
|
*/
|
|
109
|
-
declare function chatsUpdate({ pathParams, config }?: {
|
|
109
|
+
declare function chatsUpdate({ pathParams, config, }?: {
|
|
110
110
|
pathParams: {
|
|
111
|
-
|
|
111
|
+
chatId: string;
|
|
112
112
|
};
|
|
113
113
|
config?: Partial<FetcherConfig> & {
|
|
114
114
|
client?: typeof client;
|
|
@@ -119,9 +119,9 @@ declare function chatsUpdate({ pathParams, config }?: {
|
|
|
119
119
|
* @description Marks or unmarks a chat as a favorite using its `chatId`. This helps with organizing and quickly accessing important chats.
|
|
120
120
|
* @link /chats/{chatId}/favorite
|
|
121
121
|
*/
|
|
122
|
-
declare function chatsFavorite({ pathParams, config }?: {
|
|
122
|
+
declare function chatsFavorite({ pathParams, config, }?: {
|
|
123
123
|
pathParams: {
|
|
124
|
-
|
|
124
|
+
chatId: string;
|
|
125
125
|
};
|
|
126
126
|
config?: Partial<FetcherConfig> & {
|
|
127
127
|
client?: typeof client;
|
|
@@ -129,12 +129,12 @@ declare function chatsFavorite({ pathParams, config }?: {
|
|
|
129
129
|
}): Promise<unknown>;
|
|
130
130
|
/**
|
|
131
131
|
* @summary Fork Chat
|
|
132
|
-
* @description Creates a new chat fork (duplicate) from a specific version within
|
|
132
|
+
* @description Creates a new chat fork (duplicate) from a specific version within a chat created through Platform API v1. To duplicate chats created in v0 web or Platform API v2, use POST /v2/chats/{chatId}/duplicate.
|
|
133
133
|
* @link /chats/{chatId}/fork
|
|
134
134
|
*/
|
|
135
|
-
declare function chatsFork({ pathParams, config }?: {
|
|
135
|
+
declare function chatsFork({ pathParams, config, }?: {
|
|
136
136
|
pathParams: {
|
|
137
|
-
|
|
137
|
+
chatId: string;
|
|
138
138
|
};
|
|
139
139
|
config?: Partial<FetcherConfig> & {
|
|
140
140
|
client?: typeof client;
|
|
@@ -145,9 +145,9 @@ declare function chatsFork({ pathParams, config }?: {
|
|
|
145
145
|
* @description Retrieves the v0 project associated with a given chat. Useful for determining the context or scope of a chat session.
|
|
146
146
|
* @link /chats/{chatId}/project
|
|
147
147
|
*/
|
|
148
|
-
declare function projectsGetByChatId({ pathParams, config }?: {
|
|
148
|
+
declare function projectsGetByChatId({ pathParams, config, }?: {
|
|
149
149
|
pathParams: {
|
|
150
|
-
|
|
150
|
+
chatId: string;
|
|
151
151
|
};
|
|
152
152
|
config?: Partial<FetcherConfig> & {
|
|
153
153
|
client?: typeof client;
|
|
@@ -158,13 +158,13 @@ declare function projectsGetByChatId({ pathParams, config }?: {
|
|
|
158
158
|
* @description Retrieves a list of all messages for a specific chat, ordered by creation date (newest first). Supports cursor-based pagination and includes message content, role, and type information.
|
|
159
159
|
* @link /chats/{chatId}/messages
|
|
160
160
|
*/
|
|
161
|
-
declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
161
|
+
declare function chatsFindMessages({ pathParams, queryParams, config, }?: {
|
|
162
162
|
pathParams: {
|
|
163
|
-
|
|
163
|
+
chatId: string;
|
|
164
164
|
};
|
|
165
165
|
queryParams?: {
|
|
166
|
-
|
|
167
|
-
|
|
166
|
+
limit?: number;
|
|
167
|
+
cursor?: string;
|
|
168
168
|
};
|
|
169
169
|
config?: Partial<FetcherConfig> & {
|
|
170
170
|
client?: typeof client;
|
|
@@ -175,9 +175,9 @@ declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
|
175
175
|
* @description Creates a new message in an existing chat. Triggers a model response using the provided prompt, with optional attachments and configuration settings.
|
|
176
176
|
* @link /chats/{chatId}/messages
|
|
177
177
|
*/
|
|
178
|
-
declare function chatsSendMessage({ pathParams, config }?: {
|
|
178
|
+
declare function chatsSendMessage({ pathParams, config, }?: {
|
|
179
179
|
pathParams: {
|
|
180
|
-
|
|
180
|
+
chatId: string;
|
|
181
181
|
};
|
|
182
182
|
config?: Partial<FetcherConfig> & {
|
|
183
183
|
client?: typeof client;
|
|
@@ -188,10 +188,10 @@ declare function chatsSendMessage({ pathParams, config }?: {
|
|
|
188
188
|
* @description Retrieves detailed information about a specific message within a chat, including content, files, model configuration, and demo URLs.
|
|
189
189
|
* @link /chats/{chatId}/messages/{messageId}
|
|
190
190
|
*/
|
|
191
|
-
declare function chatsGetMessage({ pathParams, config }?: {
|
|
191
|
+
declare function chatsGetMessage({ pathParams, config, }?: {
|
|
192
192
|
pathParams: {
|
|
193
|
-
|
|
194
|
-
|
|
193
|
+
chatId: string;
|
|
194
|
+
messageId: string;
|
|
195
195
|
};
|
|
196
196
|
config?: Partial<FetcherConfig> & {
|
|
197
197
|
client?: typeof client;
|
|
@@ -202,13 +202,13 @@ declare function chatsGetMessage({ pathParams, config }?: {
|
|
|
202
202
|
* @description Retrieves a list of all versions (iterations) for a specific chat, ordered by creation date (newest first). Supports cursor-based pagination and includes version status and demo URLs.
|
|
203
203
|
* @link /chats/{chatId}/versions
|
|
204
204
|
*/
|
|
205
|
-
declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
205
|
+
declare function chatsFindVersions({ pathParams, queryParams, config, }?: {
|
|
206
206
|
pathParams: {
|
|
207
|
-
|
|
207
|
+
chatId: string;
|
|
208
208
|
};
|
|
209
209
|
queryParams?: {
|
|
210
|
-
|
|
211
|
-
|
|
210
|
+
limit?: number;
|
|
211
|
+
cursor?: string;
|
|
212
212
|
};
|
|
213
213
|
config?: Partial<FetcherConfig> & {
|
|
214
214
|
client?: typeof client;
|
|
@@ -219,13 +219,13 @@ declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
|
219
219
|
* @description Retrieves detailed information about a specific version of a chat, including all files with their content and lock status.
|
|
220
220
|
* @link /chats/{chatId}/versions/{versionId}
|
|
221
221
|
*/
|
|
222
|
-
declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
222
|
+
declare function chatsGetVersion({ pathParams, queryParams, config, }?: {
|
|
223
223
|
pathParams: {
|
|
224
|
-
|
|
225
|
-
|
|
224
|
+
chatId: string;
|
|
225
|
+
versionId: string;
|
|
226
226
|
};
|
|
227
227
|
queryParams?: {
|
|
228
|
-
|
|
228
|
+
includeDefaultFiles?: "true" | "false";
|
|
229
229
|
};
|
|
230
230
|
config?: Partial<FetcherConfig> & {
|
|
231
231
|
client?: typeof client;
|
|
@@ -236,10 +236,10 @@ declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
|
236
236
|
* @description Updates the source files of a specific chat version (block) manually. This allows editing generated files directly through the API.
|
|
237
237
|
* @link /chats/{chatId}/versions/{versionId}
|
|
238
238
|
*/
|
|
239
|
-
declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
239
|
+
declare function chatsUpdateVersion({ pathParams, config, }?: {
|
|
240
240
|
pathParams: {
|
|
241
|
-
|
|
242
|
-
|
|
241
|
+
chatId: string;
|
|
242
|
+
versionId: string;
|
|
243
243
|
};
|
|
244
244
|
config?: Partial<FetcherConfig> & {
|
|
245
245
|
client?: typeof client;
|
|
@@ -250,14 +250,14 @@ declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
|
250
250
|
* @description Download all files for a specific chat version as a zip or tarball archive. Use includeDefaultFiles=true to include all deployment files (package.json, configuration files, etc.) or false/omitted to return only the generated source files.
|
|
251
251
|
* @link /chats/{chatId}/versions/{versionId}/download
|
|
252
252
|
*/
|
|
253
|
-
declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
253
|
+
declare function chatsDownloadVersion({ pathParams, queryParams, config, }?: {
|
|
254
254
|
pathParams: {
|
|
255
|
-
|
|
256
|
-
|
|
255
|
+
chatId: string;
|
|
256
|
+
versionId: string;
|
|
257
257
|
};
|
|
258
258
|
queryParams?: {
|
|
259
|
-
|
|
260
|
-
|
|
259
|
+
format?: "zip" | "tarball";
|
|
260
|
+
includeDefaultFiles?: "true" | "false";
|
|
261
261
|
};
|
|
262
262
|
config?: Partial<FetcherConfig> & {
|
|
263
263
|
client?: typeof client;
|
|
@@ -268,10 +268,10 @@ declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
|
268
268
|
* @description Deletes source files from a specific chat version (block). Files are removed from the version and a new source version is created.
|
|
269
269
|
* @link /chats/{chatId}/versions/{versionId}/files/delete
|
|
270
270
|
*/
|
|
271
|
-
declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
271
|
+
declare function chatsDeleteVersionFiles({ pathParams, config, }?: {
|
|
272
272
|
pathParams: {
|
|
273
|
-
|
|
274
|
-
|
|
273
|
+
chatId: string;
|
|
274
|
+
versionId: string;
|
|
275
275
|
};
|
|
276
276
|
config?: Partial<FetcherConfig> & {
|
|
277
277
|
client?: typeof client;
|
|
@@ -282,10 +282,10 @@ declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
|
282
282
|
* @description Reconnects to an active assistant message stream and returns it as Server-Sent Events. This does not restart or continue a stopped generation.
|
|
283
283
|
* @link /chats/{chatId}/messages/{messageId}/resume
|
|
284
284
|
*/
|
|
285
|
-
declare function chatsResume({ pathParams, config }?: {
|
|
285
|
+
declare function chatsResume({ pathParams, config, }?: {
|
|
286
286
|
pathParams: {
|
|
287
|
-
|
|
288
|
-
|
|
287
|
+
chatId: string;
|
|
288
|
+
messageId: string;
|
|
289
289
|
};
|
|
290
290
|
config?: Partial<FetcherConfig> & {
|
|
291
291
|
client?: typeof client;
|
|
@@ -296,10 +296,10 @@ declare function chatsResume({ pathParams, config }?: {
|
|
|
296
296
|
* @description Stops an in-flight message generation in a chat. Useful for cancelling a streaming response that is still being generated.
|
|
297
297
|
* @link /chats/{chatId}/messages/{messageId}/stop
|
|
298
298
|
*/
|
|
299
|
-
declare function chatsStop({ pathParams, config }?: {
|
|
299
|
+
declare function chatsStop({ pathParams, config, }?: {
|
|
300
300
|
pathParams: {
|
|
301
|
-
|
|
302
|
-
|
|
301
|
+
chatId: string;
|
|
302
|
+
messageId: string;
|
|
303
303
|
};
|
|
304
304
|
config?: Partial<FetcherConfig> & {
|
|
305
305
|
client?: typeof client;
|
|
@@ -310,9 +310,9 @@ declare function chatsStop({ pathParams, config }?: {
|
|
|
310
310
|
* @description Resolves a pending task in a chat, continuing the conversation. The latest message in the active chat fork must be an assistant message currently blocked on a matching task (integration setup, plan approval, question answers, or permission grants).
|
|
311
311
|
* @link /chats/{chatId}/tasks/resolve
|
|
312
312
|
*/
|
|
313
|
-
declare function chatsResolveTask({ pathParams, config }?: {
|
|
313
|
+
declare function chatsResolveTask({ pathParams, config, }?: {
|
|
314
314
|
pathParams: {
|
|
315
|
-
|
|
315
|
+
chatId: string;
|
|
316
316
|
};
|
|
317
317
|
config?: Partial<FetcherConfig> & {
|
|
318
318
|
client?: typeof client;
|
|
@@ -323,11 +323,11 @@ declare function chatsResolveTask({ pathParams, config }?: {
|
|
|
323
323
|
* @description Find deployments by project and chat IDs. This will return a list of deployments for the given project and chat IDs.
|
|
324
324
|
* @link /deployments
|
|
325
325
|
*/
|
|
326
|
-
declare function deploymentsFind({ queryParams, config }?: {
|
|
326
|
+
declare function deploymentsFind({ queryParams, config, }?: {
|
|
327
327
|
queryParams?: {
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
328
|
+
projectId?: string;
|
|
329
|
+
chatId?: string;
|
|
330
|
+
versionId?: string;
|
|
331
331
|
};
|
|
332
332
|
config?: Partial<FetcherConfig> & {
|
|
333
333
|
client?: typeof client;
|
|
@@ -348,9 +348,9 @@ declare function deploymentsCreate({ config }?: {
|
|
|
348
348
|
* @description Get a deployment by ID. This will return the details of the deployment, including the inspector URL, chat ID, project ID, version ID, API URL, and web URL.
|
|
349
349
|
* @link /deployments/{deploymentId}
|
|
350
350
|
*/
|
|
351
|
-
declare function deploymentsGetById({ pathParams, config }?: {
|
|
351
|
+
declare function deploymentsGetById({ pathParams, config, }?: {
|
|
352
352
|
pathParams: {
|
|
353
|
-
|
|
353
|
+
deploymentId: string;
|
|
354
354
|
};
|
|
355
355
|
config?: Partial<FetcherConfig> & {
|
|
356
356
|
client?: typeof client;
|
|
@@ -361,9 +361,9 @@ declare function deploymentsGetById({ pathParams, config }?: {
|
|
|
361
361
|
* @description Delete a deployment by ID. This will delete the deployment from Vercel.
|
|
362
362
|
* @link /deployments/{deploymentId}
|
|
363
363
|
*/
|
|
364
|
-
declare function deploymentsDelete({ pathParams, config }?: {
|
|
364
|
+
declare function deploymentsDelete({ pathParams, config, }?: {
|
|
365
365
|
pathParams: {
|
|
366
|
-
|
|
366
|
+
deploymentId: string;
|
|
367
367
|
};
|
|
368
368
|
config?: Partial<FetcherConfig> & {
|
|
369
369
|
client?: typeof client;
|
|
@@ -374,12 +374,12 @@ declare function deploymentsDelete({ pathParams, config }?: {
|
|
|
374
374
|
* @description Retrieves logs for a specific deployment. Supports filtering by timestamp to fetch only recent logs.
|
|
375
375
|
* @link /deployments/{deploymentId}/logs
|
|
376
376
|
*/
|
|
377
|
-
declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
377
|
+
declare function deploymentsFindLogs({ pathParams, queryParams, config, }?: {
|
|
378
378
|
pathParams: {
|
|
379
|
-
|
|
379
|
+
deploymentId: string;
|
|
380
380
|
};
|
|
381
381
|
queryParams?: {
|
|
382
|
-
|
|
382
|
+
since?: number;
|
|
383
383
|
};
|
|
384
384
|
config?: Partial<FetcherConfig> & {
|
|
385
385
|
client?: typeof client;
|
|
@@ -390,9 +390,9 @@ declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
|
390
390
|
* @description Retrieves a list of errors that occurred during a specific deployment. Useful for diagnosing and debugging deployment issues.
|
|
391
391
|
* @link /deployments/{deploymentId}/errors
|
|
392
392
|
*/
|
|
393
|
-
declare function deploymentsFindErrors({ pathParams, config }?: {
|
|
393
|
+
declare function deploymentsFindErrors({ pathParams, config, }?: {
|
|
394
394
|
pathParams: {
|
|
395
|
-
|
|
395
|
+
deploymentId: string;
|
|
396
396
|
};
|
|
397
397
|
config?: Partial<FetcherConfig> & {
|
|
398
398
|
client?: typeof client;
|
|
@@ -423,9 +423,9 @@ declare function hooksCreate({ config }?: {
|
|
|
423
423
|
* @description Retrieves the details of a specific webhook using its ID.
|
|
424
424
|
* @link /hooks/{hookId}
|
|
425
425
|
*/
|
|
426
|
-
declare function hooksGetById({ pathParams, config }?: {
|
|
426
|
+
declare function hooksGetById({ pathParams, config, }?: {
|
|
427
427
|
pathParams: {
|
|
428
|
-
|
|
428
|
+
hookId: string;
|
|
429
429
|
};
|
|
430
430
|
config?: Partial<FetcherConfig> & {
|
|
431
431
|
client?: typeof client;
|
|
@@ -436,9 +436,9 @@ declare function hooksGetById({ pathParams, config }?: {
|
|
|
436
436
|
* @description Updates the configuration of an existing webhook, including its name, event subscriptions, or target URL.
|
|
437
437
|
* @link /hooks/{hookId}
|
|
438
438
|
*/
|
|
439
|
-
declare function hooksUpdate({ pathParams, config }?: {
|
|
439
|
+
declare function hooksUpdate({ pathParams, config, }?: {
|
|
440
440
|
pathParams: {
|
|
441
|
-
|
|
441
|
+
hookId: string;
|
|
442
442
|
};
|
|
443
443
|
config?: Partial<FetcherConfig> & {
|
|
444
444
|
client?: typeof client;
|
|
@@ -449,9 +449,9 @@ declare function hooksUpdate({ pathParams, config }?: {
|
|
|
449
449
|
* @description Deletes a webhook based on its ID. This action is irreversible.
|
|
450
450
|
* @link /hooks/{hookId}
|
|
451
451
|
*/
|
|
452
|
-
declare function hooksDelete({ pathParams, config }?: {
|
|
452
|
+
declare function hooksDelete({ pathParams, config, }?: {
|
|
453
453
|
pathParams: {
|
|
454
|
-
|
|
454
|
+
hookId: string;
|
|
455
455
|
};
|
|
456
456
|
config?: Partial<FetcherConfig> & {
|
|
457
457
|
client?: typeof client;
|
|
@@ -502,9 +502,9 @@ declare function projectsCreate({ config }?: {
|
|
|
502
502
|
* @description Retrieves the details of a specific v0 project by its ID.
|
|
503
503
|
* @link /projects/{projectId}
|
|
504
504
|
*/
|
|
505
|
-
declare function projectsGetById({ pathParams, config }?: {
|
|
505
|
+
declare function projectsGetById({ pathParams, config, }?: {
|
|
506
506
|
pathParams: {
|
|
507
|
-
|
|
507
|
+
projectId: string;
|
|
508
508
|
};
|
|
509
509
|
config?: Partial<FetcherConfig> & {
|
|
510
510
|
client?: typeof client;
|
|
@@ -515,9 +515,9 @@ declare function projectsGetById({ pathParams, config }?: {
|
|
|
515
515
|
* @description Updates the metadata of an existing project using its `projectId`. Supports changes to the project name and privacy setting.
|
|
516
516
|
* @link /projects/{projectId}
|
|
517
517
|
*/
|
|
518
|
-
declare function projectsUpdate({ pathParams, config }?: {
|
|
518
|
+
declare function projectsUpdate({ pathParams, config, }?: {
|
|
519
519
|
pathParams: {
|
|
520
|
-
|
|
520
|
+
projectId: string;
|
|
521
521
|
};
|
|
522
522
|
config?: Partial<FetcherConfig> & {
|
|
523
523
|
client?: typeof client;
|
|
@@ -528,12 +528,12 @@ declare function projectsUpdate({ pathParams, config }?: {
|
|
|
528
528
|
* @description Deletes a specific project based on the provided projectId. This operation marks the project as deleted and is irreversible.
|
|
529
529
|
* @link /projects/{projectId}
|
|
530
530
|
*/
|
|
531
|
-
declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
531
|
+
declare function projectsDelete({ pathParams, queryParams, config, }?: {
|
|
532
532
|
pathParams: {
|
|
533
|
-
|
|
533
|
+
projectId: string;
|
|
534
534
|
};
|
|
535
535
|
queryParams?: {
|
|
536
|
-
|
|
536
|
+
deleteAllChats?: "true" | "false";
|
|
537
537
|
};
|
|
538
538
|
config?: Partial<FetcherConfig> & {
|
|
539
539
|
client?: typeof client;
|
|
@@ -544,9 +544,9 @@ declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
|
544
544
|
* @description Links an existing v0 project to a specific chat. Helps group conversations under a shared project context.
|
|
545
545
|
* @link /projects/{projectId}/assign
|
|
546
546
|
*/
|
|
547
|
-
declare function projectsAssign({ pathParams, config }?: {
|
|
547
|
+
declare function projectsAssign({ pathParams, config, }?: {
|
|
548
548
|
pathParams: {
|
|
549
|
-
|
|
549
|
+
projectId: string;
|
|
550
550
|
};
|
|
551
551
|
config?: Partial<FetcherConfig> & {
|
|
552
552
|
client?: typeof client;
|
|
@@ -557,12 +557,12 @@ declare function projectsAssign({ pathParams, config }?: {
|
|
|
557
557
|
* @description Retrieves all environment variables for a given project.
|
|
558
558
|
* @link /projects/{projectId}/env-vars
|
|
559
559
|
*/
|
|
560
|
-
declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
560
|
+
declare function projectsFindEnvVars({ pathParams, queryParams, config, }?: {
|
|
561
561
|
pathParams: {
|
|
562
|
-
|
|
562
|
+
projectId: string;
|
|
563
563
|
};
|
|
564
564
|
queryParams?: {
|
|
565
|
-
|
|
565
|
+
decrypted?: "true" | "false";
|
|
566
566
|
};
|
|
567
567
|
config?: Partial<FetcherConfig> & {
|
|
568
568
|
client?: typeof client;
|
|
@@ -573,12 +573,12 @@ declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
|
573
573
|
* @description Creates new environment variables for a given project. This endpoint will fail if any of the specified environment variable keys already exist, unless upsert is set to true.
|
|
574
574
|
* @link /projects/{projectId}/env-vars
|
|
575
575
|
*/
|
|
576
|
-
declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
576
|
+
declare function projectsCreateEnvVars({ pathParams, queryParams, config, }?: {
|
|
577
577
|
pathParams: {
|
|
578
|
-
|
|
578
|
+
projectId: string;
|
|
579
579
|
};
|
|
580
580
|
queryParams?: {
|
|
581
|
-
|
|
581
|
+
decrypted?: "true" | "false";
|
|
582
582
|
};
|
|
583
583
|
config?: Partial<FetcherConfig> & {
|
|
584
584
|
client?: typeof client;
|
|
@@ -589,12 +589,12 @@ declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
589
589
|
* @description Updates multiple environment variables for a given project. Only the value of each environment variable can be updated.
|
|
590
590
|
* @link /projects/{projectId}/env-vars
|
|
591
591
|
*/
|
|
592
|
-
declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
592
|
+
declare function projectsUpdateEnvVars({ pathParams, queryParams, config, }?: {
|
|
593
593
|
pathParams: {
|
|
594
|
-
|
|
594
|
+
projectId: string;
|
|
595
595
|
};
|
|
596
596
|
queryParams?: {
|
|
597
|
-
|
|
597
|
+
decrypted?: "true" | "false";
|
|
598
598
|
};
|
|
599
599
|
config?: Partial<FetcherConfig> & {
|
|
600
600
|
client?: typeof client;
|
|
@@ -605,9 +605,9 @@ declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
605
605
|
* @description Deletes multiple environment variables for a given project by their IDs.
|
|
606
606
|
* @link /projects/{projectId}/env-vars/delete
|
|
607
607
|
*/
|
|
608
|
-
declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
608
|
+
declare function projectsDeleteEnvVars({ pathParams, config, }?: {
|
|
609
609
|
pathParams: {
|
|
610
|
-
|
|
610
|
+
projectId: string;
|
|
611
611
|
};
|
|
612
612
|
config?: Partial<FetcherConfig> & {
|
|
613
613
|
client?: typeof client;
|
|
@@ -618,13 +618,13 @@ declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
|
618
618
|
* @description Retrieves a specific environment variable for a given project by its ID, including its value.
|
|
619
619
|
* @link /projects/{projectId}/env-vars/{environmentVariableId}
|
|
620
620
|
*/
|
|
621
|
-
declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
621
|
+
declare function projectsGetEnvVar({ pathParams, queryParams, config, }?: {
|
|
622
622
|
pathParams: {
|
|
623
|
-
|
|
624
|
-
|
|
623
|
+
projectId: string;
|
|
624
|
+
environmentVariableId: string;
|
|
625
625
|
};
|
|
626
626
|
queryParams?: {
|
|
627
|
-
|
|
627
|
+
decrypted?: "true" | "false";
|
|
628
628
|
};
|
|
629
629
|
config?: Partial<FetcherConfig> & {
|
|
630
630
|
client?: typeof client;
|
|
@@ -635,9 +635,9 @@ declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
|
635
635
|
* @description Retrieves rate limit information for a given scope. Useful for monitoring usage limits and avoiding throttling.
|
|
636
636
|
* @link /rate-limits
|
|
637
637
|
*/
|
|
638
|
-
declare function rateLimitsFind({ queryParams, config }?: {
|
|
638
|
+
declare function rateLimitsFind({ queryParams, config, }?: {
|
|
639
639
|
queryParams?: {
|
|
640
|
-
|
|
640
|
+
scope?: string;
|
|
641
641
|
};
|
|
642
642
|
config?: Partial<FetcherConfig> & {
|
|
643
643
|
client?: typeof client;
|
|
@@ -658,9 +658,9 @@ declare function userGet({ config }?: {
|
|
|
658
658
|
* @description Fetches billing usage and quota information for the authenticated user. Can be scoped to a specific context (e.g. project or namespace).
|
|
659
659
|
* @link /user/billing
|
|
660
660
|
*/
|
|
661
|
-
declare function userGetBilling({ queryParams, config }?: {
|
|
661
|
+
declare function userGetBilling({ queryParams, config, }?: {
|
|
662
662
|
queryParams?: {
|
|
663
|
-
|
|
663
|
+
scope?: string;
|
|
664
664
|
};
|
|
665
665
|
config?: Partial<FetcherConfig> & {
|
|
666
666
|
client?: typeof client;
|
|
@@ -691,10 +691,10 @@ declare function userGetScopes({ config }?: {
|
|
|
691
691
|
* @description Restores a block to a specific version.
|
|
692
692
|
* @link /chats/{chatId}/versions/{versionId}/restore
|
|
693
693
|
*/
|
|
694
|
-
declare function chatsRestore({ pathParams, config }?: {
|
|
694
|
+
declare function chatsRestore({ pathParams, config, }?: {
|
|
695
695
|
pathParams: {
|
|
696
|
-
|
|
697
|
-
|
|
696
|
+
chatId: string;
|
|
697
|
+
versionId: string;
|
|
698
698
|
};
|
|
699
699
|
config?: Partial<FetcherConfig> & {
|
|
700
700
|
client?: typeof client;
|
|
@@ -705,15 +705,15 @@ declare function chatsRestore({ pathParams, config }?: {
|
|
|
705
705
|
* @description Retrieves detailed usage events for the authenticated user or team, including costs, event types, models used, and metadata. Shows the same data as displayed in the usage dashboard. Can be filtered by chatId to show usage for a specific chat, or by userId to show usage for a specific user.
|
|
706
706
|
* @link /reports/usage
|
|
707
707
|
*/
|
|
708
|
-
declare function reportsGetUsage({ queryParams, config }?: {
|
|
708
|
+
declare function reportsGetUsage({ queryParams, config, }?: {
|
|
709
709
|
queryParams?: {
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
710
|
+
startDate?: string;
|
|
711
|
+
endDate?: string;
|
|
712
|
+
chatId?: string;
|
|
713
|
+
messageId?: string;
|
|
714
|
+
userId?: string;
|
|
715
|
+
limit?: number;
|
|
716
|
+
cursor?: string;
|
|
717
717
|
};
|
|
718
718
|
config?: Partial<FetcherConfig> & {
|
|
719
719
|
client?: typeof client;
|
|
@@ -724,12 +724,12 @@ declare function reportsGetUsage({ queryParams, config }?: {
|
|
|
724
724
|
* @description Retrieves v0 AI usage events for the authenticated user or active team scope.
|
|
725
725
|
* @link /reports/usage/ai
|
|
726
726
|
*/
|
|
727
|
-
declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
727
|
+
declare function reportsGetAIUsage({ queryParams, config, }?: {
|
|
728
728
|
queryParams?: {
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
729
|
+
start?: string;
|
|
730
|
+
end?: string;
|
|
731
|
+
cursor?: string;
|
|
732
|
+
limit?: number;
|
|
733
733
|
};
|
|
734
734
|
config?: Partial<FetcherConfig> & {
|
|
735
735
|
client?: typeof client;
|
|
@@ -740,10 +740,10 @@ declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
|
740
740
|
* @description Retrieves aggregated user activity data for team members, including chat counts, message counts, and activity timestamps. Only available for Enterprise teams with OWNER or BILLING role. Shows the same data as displayed in the Usage settings for Enterprise teams.
|
|
741
741
|
* @link /reports/user-activity
|
|
742
742
|
*/
|
|
743
|
-
declare function reportsGetUserActivity({ queryParams, config }?: {
|
|
743
|
+
declare function reportsGetUserActivity({ queryParams, config, }?: {
|
|
744
744
|
queryParams?: {
|
|
745
|
-
|
|
746
|
-
|
|
745
|
+
startDate?: string;
|
|
746
|
+
endDate?: string;
|
|
747
747
|
};
|
|
748
748
|
config?: Partial<FetcherConfig> & {
|
|
749
749
|
client?: typeof client;
|
|
@@ -774,9 +774,9 @@ declare function mcpServersCreate({ config }?: {
|
|
|
774
774
|
* @description Retrieves the details of a specific MCP server by its ID.
|
|
775
775
|
* @link /mcp-servers/{mcpServerId}
|
|
776
776
|
*/
|
|
777
|
-
declare function mcpServersGetById({ pathParams, config }?: {
|
|
777
|
+
declare function mcpServersGetById({ pathParams, config, }?: {
|
|
778
778
|
pathParams: {
|
|
779
|
-
|
|
779
|
+
mcpServerId: string;
|
|
780
780
|
};
|
|
781
781
|
config?: Partial<FetcherConfig> & {
|
|
782
782
|
client?: typeof client;
|
|
@@ -787,9 +787,9 @@ declare function mcpServersGetById({ pathParams, config }?: {
|
|
|
787
787
|
* @description Updates the configuration of an existing MCP server, including its name, URL, description, enabled status, and authentication settings.
|
|
788
788
|
* @link /mcp-servers/{mcpServerId}
|
|
789
789
|
*/
|
|
790
|
-
declare function mcpServersUpdate({ pathParams, config }?: {
|
|
790
|
+
declare function mcpServersUpdate({ pathParams, config, }?: {
|
|
791
791
|
pathParams: {
|
|
792
|
-
|
|
792
|
+
mcpServerId: string;
|
|
793
793
|
};
|
|
794
794
|
config?: Partial<FetcherConfig> & {
|
|
795
795
|
client?: typeof client;
|
|
@@ -800,9 +800,9 @@ declare function mcpServersUpdate({ pathParams, config }?: {
|
|
|
800
800
|
* @description Deletes an MCP server based on its ID. This action is irreversible and will also remove any associated OAuth tokens.
|
|
801
801
|
* @link /mcp-servers/{mcpServerId}
|
|
802
802
|
*/
|
|
803
|
-
declare function mcpServersDelete({ pathParams, config }?: {
|
|
803
|
+
declare function mcpServersDelete({ pathParams, config, }?: {
|
|
804
804
|
pathParams: {
|
|
805
|
-
|
|
805
|
+
mcpServerId: string;
|
|
806
806
|
};
|
|
807
807
|
config?: Partial<FetcherConfig> & {
|
|
808
808
|
client?: typeof client;
|
|
@@ -813,9 +813,9 @@ declare function mcpServersDelete({ pathParams, config }?: {
|
|
|
813
813
|
* @description Creates an OAuth authorization URL for an OAuth MCP server. Redirect the user to the returned URL, and the Platform API OAuth callback will store the resulting tokens before redirecting to your returnUrl.
|
|
814
814
|
* @link /mcp-servers/{mcpServerId}/oauth/authorize
|
|
815
815
|
*/
|
|
816
|
-
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config }?: {
|
|
816
|
+
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config, }?: {
|
|
817
817
|
pathParams: {
|
|
818
|
-
|
|
818
|
+
mcpServerId: string;
|
|
819
819
|
};
|
|
820
820
|
config?: Partial<FetcherConfig> & {
|
|
821
821
|
client?: typeof client;
|