v0-api 0.1.3 → 0.2.0
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 +133 -132
- package/dist/components.d.cts.map +1 -1
- package/dist/components.d.mts +133 -132
- package/dist/components.d.mts.map +1 -1
- package/dist/components.mjs +44 -44
- package/dist/effect.cjs +10 -10
- package/dist/effect.d.cts +133 -132
- package/dist/effect.d.cts.map +1 -1
- package/dist/effect.d.mts +133 -132
- package/dist/effect.d.mts.map +1 -1
- package/dist/effect.mjs +10 -10
- package/dist/index.cjs +706 -702
- package/dist/index.d.cts +1832 -1822
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +1832 -1822
- package/dist/index.d.mts.map +1 -1
- package/dist/index.d.ts +1832 -1822
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +706 -703
- package/dist/schemas.cjs +674 -670
- package/dist/schemas.d.cts +5 -2
- package/dist/schemas.d.cts.map +1 -1
- package/dist/schemas.d.mts +5 -2
- package/dist/schemas.d.mts.map +1 -1
- package/dist/schemas.mjs +659 -656
- package/dist/types.cjs +3 -3
- package/dist/types.d.cts +1694 -1688
- package/dist/types.d.cts.map +1 -1
- package/dist/types.d.mts +1694 -1688
- 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,14 @@ 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
|
+
metadata?: unknown;
|
|
63
64
|
};
|
|
64
65
|
config?: Partial<FetcherConfig> & {
|
|
65
66
|
client?: typeof client;
|
|
@@ -80,9 +81,9 @@ declare function chatsInit({ config }?: {
|
|
|
80
81
|
* @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
82
|
* @link /chats/{chatId}
|
|
82
83
|
*/
|
|
83
|
-
declare function chatsDelete({ pathParams, config }?: {
|
|
84
|
+
declare function chatsDelete({ pathParams, config, }?: {
|
|
84
85
|
pathParams: {
|
|
85
|
-
|
|
86
|
+
chatId: string;
|
|
86
87
|
};
|
|
87
88
|
config?: Partial<FetcherConfig> & {
|
|
88
89
|
client?: typeof client;
|
|
@@ -93,9 +94,9 @@ declare function chatsDelete({ pathParams, config }?: {
|
|
|
93
94
|
* @description Retrieves the full details of a specific chat using its `chatId`. Includes messages, metadata, and associated configuration.
|
|
94
95
|
* @link /chats/{chatId}
|
|
95
96
|
*/
|
|
96
|
-
declare function chatsGetById({ pathParams, config }?: {
|
|
97
|
+
declare function chatsGetById({ pathParams, config, }?: {
|
|
97
98
|
pathParams: {
|
|
98
|
-
|
|
99
|
+
chatId: string;
|
|
99
100
|
};
|
|
100
101
|
config?: Partial<FetcherConfig> & {
|
|
101
102
|
client?: typeof client;
|
|
@@ -106,9 +107,9 @@ declare function chatsGetById({ pathParams, config }?: {
|
|
|
106
107
|
* @description Updates the metadata of an existing chat using its `chatId`. Supports changes to the chat name and privacy setting.
|
|
107
108
|
* @link /chats/{chatId}
|
|
108
109
|
*/
|
|
109
|
-
declare function chatsUpdate({ pathParams, config }?: {
|
|
110
|
+
declare function chatsUpdate({ pathParams, config, }?: {
|
|
110
111
|
pathParams: {
|
|
111
|
-
|
|
112
|
+
chatId: string;
|
|
112
113
|
};
|
|
113
114
|
config?: Partial<FetcherConfig> & {
|
|
114
115
|
client?: typeof client;
|
|
@@ -119,9 +120,9 @@ declare function chatsUpdate({ pathParams, config }?: {
|
|
|
119
120
|
* @description Marks or unmarks a chat as a favorite using its `chatId`. This helps with organizing and quickly accessing important chats.
|
|
120
121
|
* @link /chats/{chatId}/favorite
|
|
121
122
|
*/
|
|
122
|
-
declare function chatsFavorite({ pathParams, config }?: {
|
|
123
|
+
declare function chatsFavorite({ pathParams, config, }?: {
|
|
123
124
|
pathParams: {
|
|
124
|
-
|
|
125
|
+
chatId: string;
|
|
125
126
|
};
|
|
126
127
|
config?: Partial<FetcherConfig> & {
|
|
127
128
|
client?: typeof client;
|
|
@@ -129,12 +130,12 @@ declare function chatsFavorite({ pathParams, config }?: {
|
|
|
129
130
|
}): Promise<unknown>;
|
|
130
131
|
/**
|
|
131
132
|
* @summary Fork Chat
|
|
132
|
-
* @description Creates a new chat fork (duplicate) from a specific version within
|
|
133
|
+
* @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
134
|
* @link /chats/{chatId}/fork
|
|
134
135
|
*/
|
|
135
|
-
declare function chatsFork({ pathParams, config }?: {
|
|
136
|
+
declare function chatsFork({ pathParams, config, }?: {
|
|
136
137
|
pathParams: {
|
|
137
|
-
|
|
138
|
+
chatId: string;
|
|
138
139
|
};
|
|
139
140
|
config?: Partial<FetcherConfig> & {
|
|
140
141
|
client?: typeof client;
|
|
@@ -145,9 +146,9 @@ declare function chatsFork({ pathParams, config }?: {
|
|
|
145
146
|
* @description Retrieves the v0 project associated with a given chat. Useful for determining the context or scope of a chat session.
|
|
146
147
|
* @link /chats/{chatId}/project
|
|
147
148
|
*/
|
|
148
|
-
declare function projectsGetByChatId({ pathParams, config }?: {
|
|
149
|
+
declare function projectsGetByChatId({ pathParams, config, }?: {
|
|
149
150
|
pathParams: {
|
|
150
|
-
|
|
151
|
+
chatId: string;
|
|
151
152
|
};
|
|
152
153
|
config?: Partial<FetcherConfig> & {
|
|
153
154
|
client?: typeof client;
|
|
@@ -158,13 +159,13 @@ declare function projectsGetByChatId({ pathParams, config }?: {
|
|
|
158
159
|
* @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
160
|
* @link /chats/{chatId}/messages
|
|
160
161
|
*/
|
|
161
|
-
declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
162
|
+
declare function chatsFindMessages({ pathParams, queryParams, config, }?: {
|
|
162
163
|
pathParams: {
|
|
163
|
-
|
|
164
|
+
chatId: string;
|
|
164
165
|
};
|
|
165
166
|
queryParams?: {
|
|
166
|
-
|
|
167
|
-
|
|
167
|
+
limit?: number;
|
|
168
|
+
cursor?: string;
|
|
168
169
|
};
|
|
169
170
|
config?: Partial<FetcherConfig> & {
|
|
170
171
|
client?: typeof client;
|
|
@@ -175,9 +176,9 @@ declare function chatsFindMessages({ pathParams, queryParams, config }?: {
|
|
|
175
176
|
* @description Creates a new message in an existing chat. Triggers a model response using the provided prompt, with optional attachments and configuration settings.
|
|
176
177
|
* @link /chats/{chatId}/messages
|
|
177
178
|
*/
|
|
178
|
-
declare function chatsSendMessage({ pathParams, config }?: {
|
|
179
|
+
declare function chatsSendMessage({ pathParams, config, }?: {
|
|
179
180
|
pathParams: {
|
|
180
|
-
|
|
181
|
+
chatId: string;
|
|
181
182
|
};
|
|
182
183
|
config?: Partial<FetcherConfig> & {
|
|
183
184
|
client?: typeof client;
|
|
@@ -188,10 +189,10 @@ declare function chatsSendMessage({ pathParams, config }?: {
|
|
|
188
189
|
* @description Retrieves detailed information about a specific message within a chat, including content, files, model configuration, and demo URLs.
|
|
189
190
|
* @link /chats/{chatId}/messages/{messageId}
|
|
190
191
|
*/
|
|
191
|
-
declare function chatsGetMessage({ pathParams, config }?: {
|
|
192
|
+
declare function chatsGetMessage({ pathParams, config, }?: {
|
|
192
193
|
pathParams: {
|
|
193
|
-
|
|
194
|
-
|
|
194
|
+
chatId: string;
|
|
195
|
+
messageId: string;
|
|
195
196
|
};
|
|
196
197
|
config?: Partial<FetcherConfig> & {
|
|
197
198
|
client?: typeof client;
|
|
@@ -202,13 +203,13 @@ declare function chatsGetMessage({ pathParams, config }?: {
|
|
|
202
203
|
* @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
204
|
* @link /chats/{chatId}/versions
|
|
204
205
|
*/
|
|
205
|
-
declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
206
|
+
declare function chatsFindVersions({ pathParams, queryParams, config, }?: {
|
|
206
207
|
pathParams: {
|
|
207
|
-
|
|
208
|
+
chatId: string;
|
|
208
209
|
};
|
|
209
210
|
queryParams?: {
|
|
210
|
-
|
|
211
|
-
|
|
211
|
+
limit?: number;
|
|
212
|
+
cursor?: string;
|
|
212
213
|
};
|
|
213
214
|
config?: Partial<FetcherConfig> & {
|
|
214
215
|
client?: typeof client;
|
|
@@ -219,13 +220,13 @@ declare function chatsFindVersions({ pathParams, queryParams, config }?: {
|
|
|
219
220
|
* @description Retrieves detailed information about a specific version of a chat, including all files with their content and lock status.
|
|
220
221
|
* @link /chats/{chatId}/versions/{versionId}
|
|
221
222
|
*/
|
|
222
|
-
declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
223
|
+
declare function chatsGetVersion({ pathParams, queryParams, config, }?: {
|
|
223
224
|
pathParams: {
|
|
224
|
-
|
|
225
|
-
|
|
225
|
+
chatId: string;
|
|
226
|
+
versionId: string;
|
|
226
227
|
};
|
|
227
228
|
queryParams?: {
|
|
228
|
-
|
|
229
|
+
includeDefaultFiles?: "true" | "false";
|
|
229
230
|
};
|
|
230
231
|
config?: Partial<FetcherConfig> & {
|
|
231
232
|
client?: typeof client;
|
|
@@ -236,10 +237,10 @@ declare function chatsGetVersion({ pathParams, queryParams, config }?: {
|
|
|
236
237
|
* @description Updates the source files of a specific chat version (block) manually. This allows editing generated files directly through the API.
|
|
237
238
|
* @link /chats/{chatId}/versions/{versionId}
|
|
238
239
|
*/
|
|
239
|
-
declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
240
|
+
declare function chatsUpdateVersion({ pathParams, config, }?: {
|
|
240
241
|
pathParams: {
|
|
241
|
-
|
|
242
|
-
|
|
242
|
+
chatId: string;
|
|
243
|
+
versionId: string;
|
|
243
244
|
};
|
|
244
245
|
config?: Partial<FetcherConfig> & {
|
|
245
246
|
client?: typeof client;
|
|
@@ -250,14 +251,14 @@ declare function chatsUpdateVersion({ pathParams, config }?: {
|
|
|
250
251
|
* @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
252
|
* @link /chats/{chatId}/versions/{versionId}/download
|
|
252
253
|
*/
|
|
253
|
-
declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
254
|
+
declare function chatsDownloadVersion({ pathParams, queryParams, config, }?: {
|
|
254
255
|
pathParams: {
|
|
255
|
-
|
|
256
|
-
|
|
256
|
+
chatId: string;
|
|
257
|
+
versionId: string;
|
|
257
258
|
};
|
|
258
259
|
queryParams?: {
|
|
259
|
-
|
|
260
|
-
|
|
260
|
+
format?: "zip" | "tarball";
|
|
261
|
+
includeDefaultFiles?: "true" | "false";
|
|
261
262
|
};
|
|
262
263
|
config?: Partial<FetcherConfig> & {
|
|
263
264
|
client?: typeof client;
|
|
@@ -268,10 +269,10 @@ declare function chatsDownloadVersion({ pathParams, queryParams, config }?: {
|
|
|
268
269
|
* @description Deletes source files from a specific chat version (block). Files are removed from the version and a new source version is created.
|
|
269
270
|
* @link /chats/{chatId}/versions/{versionId}/files/delete
|
|
270
271
|
*/
|
|
271
|
-
declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
272
|
+
declare function chatsDeleteVersionFiles({ pathParams, config, }?: {
|
|
272
273
|
pathParams: {
|
|
273
|
-
|
|
274
|
-
|
|
274
|
+
chatId: string;
|
|
275
|
+
versionId: string;
|
|
275
276
|
};
|
|
276
277
|
config?: Partial<FetcherConfig> & {
|
|
277
278
|
client?: typeof client;
|
|
@@ -282,10 +283,10 @@ declare function chatsDeleteVersionFiles({ pathParams, config }?: {
|
|
|
282
283
|
* @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
284
|
* @link /chats/{chatId}/messages/{messageId}/resume
|
|
284
285
|
*/
|
|
285
|
-
declare function chatsResume({ pathParams, config }?: {
|
|
286
|
+
declare function chatsResume({ pathParams, config, }?: {
|
|
286
287
|
pathParams: {
|
|
287
|
-
|
|
288
|
-
|
|
288
|
+
chatId: string;
|
|
289
|
+
messageId: string;
|
|
289
290
|
};
|
|
290
291
|
config?: Partial<FetcherConfig> & {
|
|
291
292
|
client?: typeof client;
|
|
@@ -296,10 +297,10 @@ declare function chatsResume({ pathParams, config }?: {
|
|
|
296
297
|
* @description Stops an in-flight message generation in a chat. Useful for cancelling a streaming response that is still being generated.
|
|
297
298
|
* @link /chats/{chatId}/messages/{messageId}/stop
|
|
298
299
|
*/
|
|
299
|
-
declare function chatsStop({ pathParams, config }?: {
|
|
300
|
+
declare function chatsStop({ pathParams, config, }?: {
|
|
300
301
|
pathParams: {
|
|
301
|
-
|
|
302
|
-
|
|
302
|
+
chatId: string;
|
|
303
|
+
messageId: string;
|
|
303
304
|
};
|
|
304
305
|
config?: Partial<FetcherConfig> & {
|
|
305
306
|
client?: typeof client;
|
|
@@ -310,9 +311,9 @@ declare function chatsStop({ pathParams, config }?: {
|
|
|
310
311
|
* @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
312
|
* @link /chats/{chatId}/tasks/resolve
|
|
312
313
|
*/
|
|
313
|
-
declare function chatsResolveTask({ pathParams, config }?: {
|
|
314
|
+
declare function chatsResolveTask({ pathParams, config, }?: {
|
|
314
315
|
pathParams: {
|
|
315
|
-
|
|
316
|
+
chatId: string;
|
|
316
317
|
};
|
|
317
318
|
config?: Partial<FetcherConfig> & {
|
|
318
319
|
client?: typeof client;
|
|
@@ -323,11 +324,11 @@ declare function chatsResolveTask({ pathParams, config }?: {
|
|
|
323
324
|
* @description Find deployments by project and chat IDs. This will return a list of deployments for the given project and chat IDs.
|
|
324
325
|
* @link /deployments
|
|
325
326
|
*/
|
|
326
|
-
declare function deploymentsFind({ queryParams, config }?: {
|
|
327
|
+
declare function deploymentsFind({ queryParams, config, }?: {
|
|
327
328
|
queryParams?: {
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
329
|
+
projectId?: string;
|
|
330
|
+
chatId?: string;
|
|
331
|
+
versionId?: string;
|
|
331
332
|
};
|
|
332
333
|
config?: Partial<FetcherConfig> & {
|
|
333
334
|
client?: typeof client;
|
|
@@ -348,9 +349,9 @@ declare function deploymentsCreate({ config }?: {
|
|
|
348
349
|
* @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
350
|
* @link /deployments/{deploymentId}
|
|
350
351
|
*/
|
|
351
|
-
declare function deploymentsGetById({ pathParams, config }?: {
|
|
352
|
+
declare function deploymentsGetById({ pathParams, config, }?: {
|
|
352
353
|
pathParams: {
|
|
353
|
-
|
|
354
|
+
deploymentId: string;
|
|
354
355
|
};
|
|
355
356
|
config?: Partial<FetcherConfig> & {
|
|
356
357
|
client?: typeof client;
|
|
@@ -361,9 +362,9 @@ declare function deploymentsGetById({ pathParams, config }?: {
|
|
|
361
362
|
* @description Delete a deployment by ID. This will delete the deployment from Vercel.
|
|
362
363
|
* @link /deployments/{deploymentId}
|
|
363
364
|
*/
|
|
364
|
-
declare function deploymentsDelete({ pathParams, config }?: {
|
|
365
|
+
declare function deploymentsDelete({ pathParams, config, }?: {
|
|
365
366
|
pathParams: {
|
|
366
|
-
|
|
367
|
+
deploymentId: string;
|
|
367
368
|
};
|
|
368
369
|
config?: Partial<FetcherConfig> & {
|
|
369
370
|
client?: typeof client;
|
|
@@ -374,12 +375,12 @@ declare function deploymentsDelete({ pathParams, config }?: {
|
|
|
374
375
|
* @description Retrieves logs for a specific deployment. Supports filtering by timestamp to fetch only recent logs.
|
|
375
376
|
* @link /deployments/{deploymentId}/logs
|
|
376
377
|
*/
|
|
377
|
-
declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
378
|
+
declare function deploymentsFindLogs({ pathParams, queryParams, config, }?: {
|
|
378
379
|
pathParams: {
|
|
379
|
-
|
|
380
|
+
deploymentId: string;
|
|
380
381
|
};
|
|
381
382
|
queryParams?: {
|
|
382
|
-
|
|
383
|
+
since?: number;
|
|
383
384
|
};
|
|
384
385
|
config?: Partial<FetcherConfig> & {
|
|
385
386
|
client?: typeof client;
|
|
@@ -390,9 +391,9 @@ declare function deploymentsFindLogs({ pathParams, queryParams, config }?: {
|
|
|
390
391
|
* @description Retrieves a list of errors that occurred during a specific deployment. Useful for diagnosing and debugging deployment issues.
|
|
391
392
|
* @link /deployments/{deploymentId}/errors
|
|
392
393
|
*/
|
|
393
|
-
declare function deploymentsFindErrors({ pathParams, config }?: {
|
|
394
|
+
declare function deploymentsFindErrors({ pathParams, config, }?: {
|
|
394
395
|
pathParams: {
|
|
395
|
-
|
|
396
|
+
deploymentId: string;
|
|
396
397
|
};
|
|
397
398
|
config?: Partial<FetcherConfig> & {
|
|
398
399
|
client?: typeof client;
|
|
@@ -423,9 +424,9 @@ declare function hooksCreate({ config }?: {
|
|
|
423
424
|
* @description Retrieves the details of a specific webhook using its ID.
|
|
424
425
|
* @link /hooks/{hookId}
|
|
425
426
|
*/
|
|
426
|
-
declare function hooksGetById({ pathParams, config }?: {
|
|
427
|
+
declare function hooksGetById({ pathParams, config, }?: {
|
|
427
428
|
pathParams: {
|
|
428
|
-
|
|
429
|
+
hookId: string;
|
|
429
430
|
};
|
|
430
431
|
config?: Partial<FetcherConfig> & {
|
|
431
432
|
client?: typeof client;
|
|
@@ -436,9 +437,9 @@ declare function hooksGetById({ pathParams, config }?: {
|
|
|
436
437
|
* @description Updates the configuration of an existing webhook, including its name, event subscriptions, or target URL.
|
|
437
438
|
* @link /hooks/{hookId}
|
|
438
439
|
*/
|
|
439
|
-
declare function hooksUpdate({ pathParams, config }?: {
|
|
440
|
+
declare function hooksUpdate({ pathParams, config, }?: {
|
|
440
441
|
pathParams: {
|
|
441
|
-
|
|
442
|
+
hookId: string;
|
|
442
443
|
};
|
|
443
444
|
config?: Partial<FetcherConfig> & {
|
|
444
445
|
client?: typeof client;
|
|
@@ -449,9 +450,9 @@ declare function hooksUpdate({ pathParams, config }?: {
|
|
|
449
450
|
* @description Deletes a webhook based on its ID. This action is irreversible.
|
|
450
451
|
* @link /hooks/{hookId}
|
|
451
452
|
*/
|
|
452
|
-
declare function hooksDelete({ pathParams, config }?: {
|
|
453
|
+
declare function hooksDelete({ pathParams, config, }?: {
|
|
453
454
|
pathParams: {
|
|
454
|
-
|
|
455
|
+
hookId: string;
|
|
455
456
|
};
|
|
456
457
|
config?: Partial<FetcherConfig> & {
|
|
457
458
|
client?: typeof client;
|
|
@@ -502,9 +503,9 @@ declare function projectsCreate({ config }?: {
|
|
|
502
503
|
* @description Retrieves the details of a specific v0 project by its ID.
|
|
503
504
|
* @link /projects/{projectId}
|
|
504
505
|
*/
|
|
505
|
-
declare function projectsGetById({ pathParams, config }?: {
|
|
506
|
+
declare function projectsGetById({ pathParams, config, }?: {
|
|
506
507
|
pathParams: {
|
|
507
|
-
|
|
508
|
+
projectId: string;
|
|
508
509
|
};
|
|
509
510
|
config?: Partial<FetcherConfig> & {
|
|
510
511
|
client?: typeof client;
|
|
@@ -515,9 +516,9 @@ declare function projectsGetById({ pathParams, config }?: {
|
|
|
515
516
|
* @description Updates the metadata of an existing project using its `projectId`. Supports changes to the project name and privacy setting.
|
|
516
517
|
* @link /projects/{projectId}
|
|
517
518
|
*/
|
|
518
|
-
declare function projectsUpdate({ pathParams, config }?: {
|
|
519
|
+
declare function projectsUpdate({ pathParams, config, }?: {
|
|
519
520
|
pathParams: {
|
|
520
|
-
|
|
521
|
+
projectId: string;
|
|
521
522
|
};
|
|
522
523
|
config?: Partial<FetcherConfig> & {
|
|
523
524
|
client?: typeof client;
|
|
@@ -528,12 +529,12 @@ declare function projectsUpdate({ pathParams, config }?: {
|
|
|
528
529
|
* @description Deletes a specific project based on the provided projectId. This operation marks the project as deleted and is irreversible.
|
|
529
530
|
* @link /projects/{projectId}
|
|
530
531
|
*/
|
|
531
|
-
declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
532
|
+
declare function projectsDelete({ pathParams, queryParams, config, }?: {
|
|
532
533
|
pathParams: {
|
|
533
|
-
|
|
534
|
+
projectId: string;
|
|
534
535
|
};
|
|
535
536
|
queryParams?: {
|
|
536
|
-
|
|
537
|
+
deleteAllChats?: "true" | "false";
|
|
537
538
|
};
|
|
538
539
|
config?: Partial<FetcherConfig> & {
|
|
539
540
|
client?: typeof client;
|
|
@@ -544,9 +545,9 @@ declare function projectsDelete({ pathParams, queryParams, config }?: {
|
|
|
544
545
|
* @description Links an existing v0 project to a specific chat. Helps group conversations under a shared project context.
|
|
545
546
|
* @link /projects/{projectId}/assign
|
|
546
547
|
*/
|
|
547
|
-
declare function projectsAssign({ pathParams, config }?: {
|
|
548
|
+
declare function projectsAssign({ pathParams, config, }?: {
|
|
548
549
|
pathParams: {
|
|
549
|
-
|
|
550
|
+
projectId: string;
|
|
550
551
|
};
|
|
551
552
|
config?: Partial<FetcherConfig> & {
|
|
552
553
|
client?: typeof client;
|
|
@@ -557,12 +558,12 @@ declare function projectsAssign({ pathParams, config }?: {
|
|
|
557
558
|
* @description Retrieves all environment variables for a given project.
|
|
558
559
|
* @link /projects/{projectId}/env-vars
|
|
559
560
|
*/
|
|
560
|
-
declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
561
|
+
declare function projectsFindEnvVars({ pathParams, queryParams, config, }?: {
|
|
561
562
|
pathParams: {
|
|
562
|
-
|
|
563
|
+
projectId: string;
|
|
563
564
|
};
|
|
564
565
|
queryParams?: {
|
|
565
|
-
|
|
566
|
+
decrypted?: "true" | "false";
|
|
566
567
|
};
|
|
567
568
|
config?: Partial<FetcherConfig> & {
|
|
568
569
|
client?: typeof client;
|
|
@@ -573,12 +574,12 @@ declare function projectsFindEnvVars({ pathParams, queryParams, config }?: {
|
|
|
573
574
|
* @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
575
|
* @link /projects/{projectId}/env-vars
|
|
575
576
|
*/
|
|
576
|
-
declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
577
|
+
declare function projectsCreateEnvVars({ pathParams, queryParams, config, }?: {
|
|
577
578
|
pathParams: {
|
|
578
|
-
|
|
579
|
+
projectId: string;
|
|
579
580
|
};
|
|
580
581
|
queryParams?: {
|
|
581
|
-
|
|
582
|
+
decrypted?: "true" | "false";
|
|
582
583
|
};
|
|
583
584
|
config?: Partial<FetcherConfig> & {
|
|
584
585
|
client?: typeof client;
|
|
@@ -589,12 +590,12 @@ declare function projectsCreateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
589
590
|
* @description Updates multiple environment variables for a given project. Only the value of each environment variable can be updated.
|
|
590
591
|
* @link /projects/{projectId}/env-vars
|
|
591
592
|
*/
|
|
592
|
-
declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
593
|
+
declare function projectsUpdateEnvVars({ pathParams, queryParams, config, }?: {
|
|
593
594
|
pathParams: {
|
|
594
|
-
|
|
595
|
+
projectId: string;
|
|
595
596
|
};
|
|
596
597
|
queryParams?: {
|
|
597
|
-
|
|
598
|
+
decrypted?: "true" | "false";
|
|
598
599
|
};
|
|
599
600
|
config?: Partial<FetcherConfig> & {
|
|
600
601
|
client?: typeof client;
|
|
@@ -605,9 +606,9 @@ declare function projectsUpdateEnvVars({ pathParams, queryParams, config }?: {
|
|
|
605
606
|
* @description Deletes multiple environment variables for a given project by their IDs.
|
|
606
607
|
* @link /projects/{projectId}/env-vars/delete
|
|
607
608
|
*/
|
|
608
|
-
declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
609
|
+
declare function projectsDeleteEnvVars({ pathParams, config, }?: {
|
|
609
610
|
pathParams: {
|
|
610
|
-
|
|
611
|
+
projectId: string;
|
|
611
612
|
};
|
|
612
613
|
config?: Partial<FetcherConfig> & {
|
|
613
614
|
client?: typeof client;
|
|
@@ -618,13 +619,13 @@ declare function projectsDeleteEnvVars({ pathParams, config }?: {
|
|
|
618
619
|
* @description Retrieves a specific environment variable for a given project by its ID, including its value.
|
|
619
620
|
* @link /projects/{projectId}/env-vars/{environmentVariableId}
|
|
620
621
|
*/
|
|
621
|
-
declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
622
|
+
declare function projectsGetEnvVar({ pathParams, queryParams, config, }?: {
|
|
622
623
|
pathParams: {
|
|
623
|
-
|
|
624
|
-
|
|
624
|
+
projectId: string;
|
|
625
|
+
environmentVariableId: string;
|
|
625
626
|
};
|
|
626
627
|
queryParams?: {
|
|
627
|
-
|
|
628
|
+
decrypted?: "true" | "false";
|
|
628
629
|
};
|
|
629
630
|
config?: Partial<FetcherConfig> & {
|
|
630
631
|
client?: typeof client;
|
|
@@ -635,9 +636,9 @@ declare function projectsGetEnvVar({ pathParams, queryParams, config }?: {
|
|
|
635
636
|
* @description Retrieves rate limit information for a given scope. Useful for monitoring usage limits and avoiding throttling.
|
|
636
637
|
* @link /rate-limits
|
|
637
638
|
*/
|
|
638
|
-
declare function rateLimitsFind({ queryParams, config }?: {
|
|
639
|
+
declare function rateLimitsFind({ queryParams, config, }?: {
|
|
639
640
|
queryParams?: {
|
|
640
|
-
|
|
641
|
+
scope?: string;
|
|
641
642
|
};
|
|
642
643
|
config?: Partial<FetcherConfig> & {
|
|
643
644
|
client?: typeof client;
|
|
@@ -658,9 +659,9 @@ declare function userGet({ config }?: {
|
|
|
658
659
|
* @description Fetches billing usage and quota information for the authenticated user. Can be scoped to a specific context (e.g. project or namespace).
|
|
659
660
|
* @link /user/billing
|
|
660
661
|
*/
|
|
661
|
-
declare function userGetBilling({ queryParams, config }?: {
|
|
662
|
+
declare function userGetBilling({ queryParams, config, }?: {
|
|
662
663
|
queryParams?: {
|
|
663
|
-
|
|
664
|
+
scope?: string;
|
|
664
665
|
};
|
|
665
666
|
config?: Partial<FetcherConfig> & {
|
|
666
667
|
client?: typeof client;
|
|
@@ -691,10 +692,10 @@ declare function userGetScopes({ config }?: {
|
|
|
691
692
|
* @description Restores a block to a specific version.
|
|
692
693
|
* @link /chats/{chatId}/versions/{versionId}/restore
|
|
693
694
|
*/
|
|
694
|
-
declare function chatsRestore({ pathParams, config }?: {
|
|
695
|
+
declare function chatsRestore({ pathParams, config, }?: {
|
|
695
696
|
pathParams: {
|
|
696
|
-
|
|
697
|
-
|
|
697
|
+
chatId: string;
|
|
698
|
+
versionId: string;
|
|
698
699
|
};
|
|
699
700
|
config?: Partial<FetcherConfig> & {
|
|
700
701
|
client?: typeof client;
|
|
@@ -705,15 +706,15 @@ declare function chatsRestore({ pathParams, config }?: {
|
|
|
705
706
|
* @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
707
|
* @link /reports/usage
|
|
707
708
|
*/
|
|
708
|
-
declare function reportsGetUsage({ queryParams, config }?: {
|
|
709
|
+
declare function reportsGetUsage({ queryParams, config, }?: {
|
|
709
710
|
queryParams?: {
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
711
|
+
startDate?: string;
|
|
712
|
+
endDate?: string;
|
|
713
|
+
chatId?: string;
|
|
714
|
+
messageId?: string;
|
|
715
|
+
userId?: string;
|
|
716
|
+
limit?: number;
|
|
717
|
+
cursor?: string;
|
|
717
718
|
};
|
|
718
719
|
config?: Partial<FetcherConfig> & {
|
|
719
720
|
client?: typeof client;
|
|
@@ -724,12 +725,12 @@ declare function reportsGetUsage({ queryParams, config }?: {
|
|
|
724
725
|
* @description Retrieves v0 AI usage events for the authenticated user or active team scope.
|
|
725
726
|
* @link /reports/usage/ai
|
|
726
727
|
*/
|
|
727
|
-
declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
728
|
+
declare function reportsGetAIUsage({ queryParams, config, }?: {
|
|
728
729
|
queryParams?: {
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
730
|
+
start?: string;
|
|
731
|
+
end?: string;
|
|
732
|
+
cursor?: string;
|
|
733
|
+
limit?: number;
|
|
733
734
|
};
|
|
734
735
|
config?: Partial<FetcherConfig> & {
|
|
735
736
|
client?: typeof client;
|
|
@@ -740,10 +741,10 @@ declare function reportsGetAIUsage({ queryParams, config }?: {
|
|
|
740
741
|
* @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
742
|
* @link /reports/user-activity
|
|
742
743
|
*/
|
|
743
|
-
declare function reportsGetUserActivity({ queryParams, config }?: {
|
|
744
|
+
declare function reportsGetUserActivity({ queryParams, config, }?: {
|
|
744
745
|
queryParams?: {
|
|
745
|
-
|
|
746
|
-
|
|
746
|
+
startDate?: string;
|
|
747
|
+
endDate?: string;
|
|
747
748
|
};
|
|
748
749
|
config?: Partial<FetcherConfig> & {
|
|
749
750
|
client?: typeof client;
|
|
@@ -774,9 +775,9 @@ declare function mcpServersCreate({ config }?: {
|
|
|
774
775
|
* @description Retrieves the details of a specific MCP server by its ID.
|
|
775
776
|
* @link /mcp-servers/{mcpServerId}
|
|
776
777
|
*/
|
|
777
|
-
declare function mcpServersGetById({ pathParams, config }?: {
|
|
778
|
+
declare function mcpServersGetById({ pathParams, config, }?: {
|
|
778
779
|
pathParams: {
|
|
779
|
-
|
|
780
|
+
mcpServerId: string;
|
|
780
781
|
};
|
|
781
782
|
config?: Partial<FetcherConfig> & {
|
|
782
783
|
client?: typeof client;
|
|
@@ -787,9 +788,9 @@ declare function mcpServersGetById({ pathParams, config }?: {
|
|
|
787
788
|
* @description Updates the configuration of an existing MCP server, including its name, URL, description, enabled status, and authentication settings.
|
|
788
789
|
* @link /mcp-servers/{mcpServerId}
|
|
789
790
|
*/
|
|
790
|
-
declare function mcpServersUpdate({ pathParams, config }?: {
|
|
791
|
+
declare function mcpServersUpdate({ pathParams, config, }?: {
|
|
791
792
|
pathParams: {
|
|
792
|
-
|
|
793
|
+
mcpServerId: string;
|
|
793
794
|
};
|
|
794
795
|
config?: Partial<FetcherConfig> & {
|
|
795
796
|
client?: typeof client;
|
|
@@ -800,9 +801,9 @@ declare function mcpServersUpdate({ pathParams, config }?: {
|
|
|
800
801
|
* @description Deletes an MCP server based on its ID. This action is irreversible and will also remove any associated OAuth tokens.
|
|
801
802
|
* @link /mcp-servers/{mcpServerId}
|
|
802
803
|
*/
|
|
803
|
-
declare function mcpServersDelete({ pathParams, config }?: {
|
|
804
|
+
declare function mcpServersDelete({ pathParams, config, }?: {
|
|
804
805
|
pathParams: {
|
|
805
|
-
|
|
806
|
+
mcpServerId: string;
|
|
806
807
|
};
|
|
807
808
|
config?: Partial<FetcherConfig> & {
|
|
808
809
|
client?: typeof client;
|
|
@@ -813,9 +814,9 @@ declare function mcpServersDelete({ pathParams, config }?: {
|
|
|
813
814
|
* @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
815
|
* @link /mcp-servers/{mcpServerId}/oauth/authorize
|
|
815
816
|
*/
|
|
816
|
-
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config }?: {
|
|
817
|
+
declare function mcpServersCreateOAuthAuthorizationUrl({ pathParams, config, }?: {
|
|
817
818
|
pathParams: {
|
|
818
|
-
|
|
819
|
+
mcpServerId: string;
|
|
819
820
|
};
|
|
820
821
|
config?: Partial<FetcherConfig> & {
|
|
821
822
|
client?: typeof client;
|