@deepraxis/sdk 0.0.0-stage → 0.1.0-dev.06cf3b8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/LICENSE +202 -0
  2. package/METHODS.md +1198 -0
  3. package/README.md +279 -2
  4. package/dist/automation.d.ts +151 -0
  5. package/dist/automation.js +8 -0
  6. package/dist/core/bindings.d.ts +25 -0
  7. package/dist/core/bindings.js +45 -0
  8. package/dist/core/client.d.ts +15 -0
  9. package/dist/core/client.js +15 -0
  10. package/dist/core/credentials.d.ts +14 -0
  11. package/dist/core/credentials.js +33 -0
  12. package/dist/core/errors.d.ts +38 -0
  13. package/dist/core/errors.js +60 -0
  14. package/dist/core/multipart.d.ts +2 -0
  15. package/dist/core/multipart.js +25 -0
  16. package/dist/core/pagination.d.ts +12 -0
  17. package/dist/core/pagination.js +26 -0
  18. package/dist/core/retry.d.ts +13 -0
  19. package/dist/core/retry.js +56 -0
  20. package/dist/core/sse.d.ts +13 -0
  21. package/dist/core/sse.js +67 -0
  22. package/dist/core/transport.d.ts +36 -0
  23. package/dist/core/transport.js +121 -0
  24. package/dist/generated/client/client.gen.d.ts +2 -0
  25. package/dist/generated/client/client.gen.js +216 -0
  26. package/dist/generated/client/index.d.ts +10 -0
  27. package/dist/generated/client/index.js +6 -0
  28. package/dist/generated/client/types.gen.d.ts +120 -0
  29. package/dist/generated/client/types.gen.js +2 -0
  30. package/dist/generated/client/utils.gen.d.ts +37 -0
  31. package/dist/generated/client/utils.gen.js +228 -0
  32. package/dist/generated/client.gen.d.ts +12 -0
  33. package/dist/generated/client.gen.js +3 -0
  34. package/dist/generated/core/auth.gen.d.ts +25 -0
  35. package/dist/generated/core/auth.gen.js +14 -0
  36. package/dist/generated/core/bodySerializer.gen.d.ts +25 -0
  37. package/dist/generated/core/bodySerializer.gen.js +57 -0
  38. package/dist/generated/core/params.gen.d.ts +43 -0
  39. package/dist/generated/core/params.gen.js +109 -0
  40. package/dist/generated/core/pathSerializer.gen.d.ts +33 -0
  41. package/dist/generated/core/pathSerializer.gen.js +106 -0
  42. package/dist/generated/core/queryKeySerializer.gen.d.ts +18 -0
  43. package/dist/generated/core/queryKeySerializer.gen.js +92 -0
  44. package/dist/generated/core/serverSentEvents.gen.d.ts +71 -0
  45. package/dist/generated/core/serverSentEvents.gen.js +132 -0
  46. package/dist/generated/core/types.gen.d.ts +83 -0
  47. package/dist/generated/core/types.gen.js +2 -0
  48. package/dist/generated/core/utils.gen.d.ts +19 -0
  49. package/dist/generated/core/utils.gen.js +87 -0
  50. package/dist/generated/index.d.ts +2 -0
  51. package/dist/generated/index.js +2 -0
  52. package/dist/generated/sdk.gen.d.ts +2296 -0
  53. package/dist/generated/sdk.gen.js +6897 -0
  54. package/dist/generated/types.gen.d.ts +59064 -0
  55. package/dist/generated/types.gen.js +2 -0
  56. package/dist/helpers/application-publish.d.ts +41 -0
  57. package/dist/helpers/application-publish.js +116 -0
  58. package/dist/index.d.ts +9 -0
  59. package/dist/index.js +5 -0
  60. package/dist/operations.generated.d.ts +11326 -0
  61. package/dist/operations.generated.js +14280 -0
  62. package/dist/resources.generated.d.ts +4217 -0
  63. package/dist/resources.generated.js +763 -0
  64. package/package.json +50 -4
package/METHODS.md ADDED
@@ -0,0 +1,1198 @@
1
+ # SDK methods
2
+
3
+ Generated by `bun run generate`. 365 HTTP operations, plus product aliases. Version segments and path parameters are omitted from resource names. Inputs use typed `{ path, query, body, headers }` options. Collections form nested resource objects; POST actions retain their verb. Naming rules are documented in `scripts/resources.ts`; semantic exceptions and aliases with reasons are in `scripts/naming-overrides.ts`.
4
+
5
+ `always` returns an AsyncIterable; `optional` streams with `{ stream: true }`; `yes` pagination returns a Page. Only `{ data, next_cursor }` + `cursor` query contracts are automatically paginated.
6
+
7
+ Multipart request bodies expand plain objects into bracketed fields (for example, `praxis[expires_in_seconds]`); arrays repeat the same field name, files remain file parts, and null/undefined values are omitted.
8
+
9
+ ## agent
10
+
11
+ ### agent.agents
12
+
13
+ | Method | HTTP | Path | Streaming | Pagination |
14
+ |---|---|---|---|---|
15
+ | archive | POST | `/agent/v1/agents/{agent_id}/archive` | no | no |
16
+ | create | POST | `/agent/v1/agents` | no | no |
17
+ | list | GET | `/agent/v1/agents` | no | no |
18
+ | retrieve | GET | `/agent/v1/agents/{agent_id}` | no | no |
19
+ | update | POST | `/agent/v1/agents/{agent_id}` | no | no |
20
+
21
+ ### agent.agents.endUsers
22
+
23
+ | Method | HTTP | Path | Streaming | Pagination |
24
+ |---|---|---|---|---|
25
+ | delete | DELETE | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
26
+ | list | GET | `/agent/v1/agents/{agent_id}/end_users` | no | no |
27
+ | retrieve | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}` | no | no |
28
+ | retrieveDeletion | GET | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion` | no | no |
29
+
30
+ ### agent.agents.endUsers.block
31
+
32
+ | Method | HTTP | Path | Streaming | Pagination |
33
+ |---|---|---|---|---|
34
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block` | no | no |
35
+
36
+ ### agent.agents.endUsers.revokeTokens
37
+
38
+ | Method | HTTP | Path | Streaming | Pagination |
39
+ |---|---|---|---|---|
40
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens` | no | no |
41
+
42
+ ### agent.agents.endUsers.unblock
43
+
44
+ | Method | HTTP | Path | Streaming | Pagination |
45
+ |---|---|---|---|---|
46
+ | create | POST | `/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock` | no | no |
47
+
48
+ ### agent.agents.versions
49
+
50
+ | Method | HTTP | Path | Streaming | Pagination |
51
+ |---|---|---|---|---|
52
+ | list | GET | `/agent/v1/agents/{agent_id}/versions` | no | no |
53
+
54
+ ### agent.computers
55
+
56
+ | Method | HTTP | Path | Streaming | Pagination |
57
+ |---|---|---|---|---|
58
+ | archive | POST | `/agent/v1/computers/{computer_id}/archive` | no | no |
59
+ | connect | POST | `/agent/v1/computers/{computer_id}/connect` | no | no |
60
+ | create | POST | `/agent/v1/computers` | no | no |
61
+ | delete | DELETE | `/agent/v1/computers/{computer_id}` | no | no |
62
+ | list | GET | `/agent/v1/computers` | no | no |
63
+ | retrieve | GET | `/agent/v1/computers/{computer_id}` | no | no |
64
+ | update | POST | `/agent/v1/computers/{computer_id}` | no | no |
65
+
66
+ ### agent.computers.attachments
67
+
68
+ | Method | HTTP | Path | Streaming | Pagination |
69
+ |---|---|---|---|---|
70
+ | create | POST | `/agent/v1/computers/{computer_id}/attachments` | no | no |
71
+
72
+ ### agent.computers.files
73
+
74
+ | Method | HTTP | Path | Streaming | Pagination |
75
+ |---|---|---|---|---|
76
+ | list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
77
+ | retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
78
+
79
+ ### agent.computers.leases
80
+
81
+ | Method | HTTP | Path | Streaming | Pagination |
82
+ |---|---|---|---|---|
83
+ | delete | DELETE | `/agent/v1/computers/{computer_id}/leases/{lease_id}` | no | no |
84
+
85
+ ### agent.computers.leases.renew
86
+
87
+ | Method | HTTP | Path | Streaming | Pagination |
88
+ |---|---|---|---|---|
89
+ | create | POST | `/agent/v1/computers/{computer_id}/leases/{lease_id}/renew` | no | no |
90
+
91
+ ### agent.deploymentRuns
92
+
93
+ | Method | HTTP | Path | Streaming | Pagination |
94
+ |---|---|---|---|---|
95
+ | list | GET | `/agent/v1/deployment_runs` | no | no |
96
+ | retrieve | GET | `/agent/v1/deployment_runs/{deployment_run_id}` | no | no |
97
+
98
+ ### agent.deployments
99
+
100
+ | Method | HTTP | Path | Streaming | Pagination |
101
+ |---|---|---|---|---|
102
+ | archive | POST | `/agent/v1/deployments/{deployment_id}/archive` | no | no |
103
+ | create | POST | `/agent/v1/deployments` | no | no |
104
+ | list | GET | `/agent/v1/deployments` | no | no |
105
+ | pause | POST | `/agent/v1/deployments/{deployment_id}/pause` | no | no |
106
+ | retrieve | GET | `/agent/v1/deployments/{deployment_id}` | no | no |
107
+ | update | POST | `/agent/v1/deployments/{deployment_id}` | no | no |
108
+
109
+ ### agent.deployments.run
110
+
111
+ | Method | HTTP | Path | Streaming | Pagination |
112
+ |---|---|---|---|---|
113
+ | create | POST | `/agent/v1/deployments/{deployment_id}/run` | no | no |
114
+
115
+ ### agent.deployments.unpause
116
+
117
+ | Method | HTTP | Path | Streaming | Pagination |
118
+ |---|---|---|---|---|
119
+ | create | POST | `/agent/v1/deployments/{deployment_id}/unpause` | no | no |
120
+
121
+ ### agent.embed
122
+
123
+ | Method | HTTP | Path | Streaming | Pagination |
124
+ |---|---|---|---|---|
125
+ | retrieveAppearance | GET | `/agent/v1/embed/appearance` | no | no |
126
+
127
+ ### agent.embed.exchange
128
+
129
+ | Method | HTTP | Path | Streaming | Pagination |
130
+ |---|---|---|---|---|
131
+ | create | POST | `/agent/v1/embed/exchange` | no | no |
132
+
133
+ ### agent.embedTokens
134
+
135
+ | Method | HTTP | Path | Streaming | Pagination |
136
+ |---|---|---|---|---|
137
+ | create | POST | `/agent/v1/embed_tokens` | no | no |
138
+ | list | GET | `/agent/v1/embed_tokens` | no | no |
139
+
140
+ ### agent.embedTokens.anonymous
141
+
142
+ | Method | HTTP | Path | Streaming | Pagination |
143
+ |---|---|---|---|---|
144
+ | create | POST | `/agent/v1/embed_tokens/anonymous` | no | no |
145
+
146
+ ### agent.embedTokens.revoke
147
+
148
+ | Method | HTTP | Path | Streaming | Pagination |
149
+ |---|---|---|---|---|
150
+ | create | POST | `/agent/v1/embed_tokens/{id}/revoke` | no | no |
151
+
152
+ ### agent.environments
153
+
154
+ | Method | HTTP | Path | Streaming | Pagination |
155
+ |---|---|---|---|---|
156
+ | archive | POST | `/agent/v1/environments/{environment_id}/archive` | no | no |
157
+ | create | POST | `/agent/v1/environments` | no | no |
158
+ | list | GET | `/agent/v1/environments` | no | no |
159
+ | retrieve | GET | `/agent/v1/environments/{environment_id}` | no | no |
160
+ | update | POST | `/agent/v1/environments/{environment_id}` | no | no |
161
+
162
+ ### agent.sessions
163
+
164
+ | Method | HTTP | Path | Streaming | Pagination |
165
+ |---|---|---|---|---|
166
+ | archive | POST | `/agent/v1/sessions/{session_id}/archive` | no | no |
167
+ | compact | POST | `/agent/v1/sessions/{session_id}/compact` | no | no |
168
+ | create | POST | `/agent/v1/sessions` | no | no |
169
+ | fork | POST | `/agent/v1/sessions/{session_id}/fork` | no | no |
170
+ | list | GET | `/agent/v1/sessions` | no | no |
171
+ | retrieve | GET | `/agent/v1/sessions/{session_id}` | no | no |
172
+ | retrieveCompact | GET | `/agent/v1/sessions/{session_id}/compact/{operation_id}` | no | no |
173
+ | retrieveContext | GET | `/agent/v1/sessions/{session_id}/context` | no | no |
174
+ | update | POST | `/agent/v1/sessions/{session_id}` | no | no |
175
+
176
+ ### agent.sessions.backgroundTasks
177
+
178
+ | Method | HTTP | Path | Streaming | Pagination |
179
+ |---|---|---|---|---|
180
+ | list | GET | `/agent/v1/sessions/{session_id}/background_tasks` | no | no |
181
+ | retrieveOutput | GET | `/agent/v1/sessions/{session_id}/background_tasks/{task_id}/output` | no | no |
182
+ | stop | POST | `/agent/v1/sessions/{session_id}/background_tasks/{task_id}/stop` | no | no |
183
+
184
+ ### agent.sessions.compactions
185
+
186
+ | Method | HTTP | Path | Streaming | Pagination |
187
+ |---|---|---|---|---|
188
+ | list | GET | `/agent/v1/sessions/{session_id}/compactions` | no | no |
189
+
190
+ ### agent.sessions.events
191
+
192
+ | Method | HTTP | Path | Streaming | Pagination |
193
+ |---|---|---|---|---|
194
+ | list | GET | `/agent/v1/sessions/{session_id}/events` | no | no |
195
+ | send | POST | `/agent/v1/sessions/{session_id}/events` | no | no |
196
+ | stream | GET | `/agent/v1/sessions/{session_id}/events/stream` | always | no |
197
+
198
+ ### agent.sessions.resources
199
+
200
+ | Method | HTTP | Path | Streaming | Pagination |
201
+ |---|---|---|---|---|
202
+ | create | POST | `/agent/v1/sessions/{session_id}/resources` | no | no |
203
+ | delete | DELETE | `/agent/v1/sessions/{session_id}/resources/{resource_id}` | no | no |
204
+ | list | GET | `/agent/v1/sessions/{session_id}/resources` | no | no |
205
+ | retrieve | GET | `/agent/v1/sessions/{session_id}/resources/{resource_id}` | no | no |
206
+
207
+ ### agent.sessions.runs
208
+
209
+ | Method | HTTP | Path | Streaming | Pagination |
210
+ |---|---|---|---|---|
211
+ | deleteFeedback | DELETE | `/agent/v1/sessions/{session_id}/runs/{run_id}/feedback` | no | no |
212
+
213
+ ### agent.sessions.runs.feedback
214
+
215
+ | Method | HTTP | Path | Streaming | Pagination |
216
+ |---|---|---|---|---|
217
+ | create | POST | `/agent/v1/sessions/{session_id}/runs/{run_id}/feedback` | no | no |
218
+
219
+ ### agent.sessions.threads
220
+
221
+ | Method | HTTP | Path | Streaming | Pagination |
222
+ |---|---|---|---|---|
223
+ | archive | POST | `/agent/v1/sessions/{session_id}/threads/{thread_id}/archive` | no | no |
224
+ | list | GET | `/agent/v1/sessions/{session_id}/threads` | no | no |
225
+ | retrieve | GET | `/agent/v1/sessions/{session_id}/threads/{thread_id}` | no | no |
226
+ | stream | GET | `/agent/v1/sessions/{session_id}/threads/{thread_id}/stream` | always | no |
227
+
228
+ ### agent.sessions.threads.events
229
+
230
+ | Method | HTTP | Path | Streaming | Pagination |
231
+ |---|---|---|---|---|
232
+ | list | GET | `/agent/v1/sessions/{session_id}/threads/{thread_id}/events` | no | no |
233
+
234
+ ### agent.toolsets
235
+
236
+ | Method | HTTP | Path | Streaming | Pagination |
237
+ |---|---|---|---|---|
238
+ | list | GET | `/agent/v1/toolsets` | no | no |
239
+
240
+ ## application
241
+
242
+ ### application.assets.upload
243
+
244
+ | Method | HTTP | Path | Streaming | Pagination |
245
+ |---|---|---|---|---|
246
+ | create | POST | `/application/v1/assets/upload` | no | no |
247
+
248
+ ### application.subdomain
249
+
250
+ | Method | HTTP | Path | Streaming | Pagination |
251
+ |---|---|---|---|---|
252
+ | retrieve | GET | `/application/v1/subdomain` | no | no |
253
+ | update | PUT | `/application/v1/subdomain` | no | no |
254
+
255
+ ### application.workers
256
+
257
+ | Method | HTTP | Path | Streaming | Pagination |
258
+ |---|---|---|---|---|
259
+ | create | POST | `/application/v1/workers` | no | no |
260
+ | delete | DELETE | `/application/v1/workers/{worker_id}` | no | no |
261
+ | list | GET | `/application/v1/workers` | no | yes |
262
+ | restore | POST | `/application/v1/workers/{worker_id}/restore` | no | no |
263
+ | retrieve | GET | `/application/v1/workers/{worker_id}` | no | no |
264
+ | update | PATCH | `/application/v1/workers/{worker_id}` | no | no |
265
+
266
+ ### application.workers.assetsUploadSession
267
+
268
+ | Method | HTTP | Path | Streaming | Pagination |
269
+ |---|---|---|---|---|
270
+ | create | POST | `/application/v1/workers/{worker_id}/assets-upload-session` | no | no |
271
+
272
+ ### application.workers.components
273
+
274
+ | Method | HTTP | Path | Streaming | Pagination |
275
+ |---|---|---|---|---|
276
+ | list | GET | `/application/v1/workers/{worker_id}/components` | no | no |
277
+
278
+ ### application.workers.deployments
279
+
280
+ | Method | HTTP | Path | Streaming | Pagination |
281
+ |---|---|---|---|---|
282
+ | create | POST | `/application/v1/workers/{worker_id}/deployments` | no | no |
283
+ | list | GET | `/application/v1/workers/{worker_id}/deployments` | no | yes |
284
+ | retrieve | GET | `/application/v1/workers/{worker_id}/deployments/{deployment_id}` | no | no |
285
+
286
+ ### application.workers.events
287
+
288
+ | Method | HTTP | Path | Streaming | Pagination |
289
+ |---|---|---|---|---|
290
+ | list | GET | `/application/v1/workers/{worker_id}/events` | no | no |
291
+
292
+ ### application.workers.grants
293
+
294
+ | Method | HTTP | Path | Streaming | Pagination |
295
+ |---|---|---|---|---|
296
+ | create | POST | `/application/v1/workers/{worker_id}/grants` | no | no |
297
+ | delete | DELETE | `/application/v1/workers/{worker_id}/grants/{grant_id}` | no | no |
298
+ | list | GET | `/application/v1/workers/{worker_id}/grants` | no | no |
299
+
300
+ ### application.workers.secrets
301
+
302
+ | Method | HTTP | Path | Streaming | Pagination |
303
+ |---|---|---|---|---|
304
+ | delete | DELETE | `/application/v1/workers/{worker_id}/secrets/{name}` | no | no |
305
+ | list | GET | `/application/v1/workers/{worker_id}/secrets` | no | no |
306
+ | update | PUT | `/application/v1/workers/{worker_id}/secrets/{name}` | no | no |
307
+
308
+ ### application.workers.versions
309
+
310
+ | Method | HTTP | Path | Streaming | Pagination |
311
+ |---|---|---|---|---|
312
+ | create | POST | `/application/v1/workers/{worker_id}/versions` | no | no |
313
+ | list | GET | `/application/v1/workers/{worker_id}/versions` | no | yes |
314
+ | retrieve | GET | `/application/v1/workers/{worker_id}/versions/{version_id}` | no | no |
315
+
316
+ ## automation
317
+
318
+ ### automation.actions
319
+
320
+ | Method | HTTP | Path | Streaming | Pagination |
321
+ |---|---|---|---|---|
322
+ | archive | POST | `/automation/v1/actions/{ns}/{name}/archive` | no | no |
323
+ | create | POST | `/automation/v1/actions` | no | no |
324
+ | list | GET | `/automation/v1/actions` | no | yes |
325
+ | restore | POST | `/automation/v1/actions/{ns}/{name}/restore` | no | no |
326
+ | retrieve | GET | `/automation/v1/actions/{ns}/{name}` | no | no |
327
+ | rollback | POST | `/automation/v1/actions/{ns}/{name}/rollback` | no | no |
328
+ | update | PUT | `/automation/v1/actions/{ns}/{name}` | no | no |
329
+
330
+ ### automation.actions.dependents
331
+
332
+ | Method | HTTP | Path | Streaming | Pagination |
333
+ |---|---|---|---|---|
334
+ | list | GET | `/automation/v1/actions/{ns}/{name}/dependents` | no | yes |
335
+
336
+ ### automation.actions.invocations
337
+
338
+ | Method | HTTP | Path | Streaming | Pagination |
339
+ |---|---|---|---|---|
340
+ | list | GET | `/automation/v1/actions/{ns}/{name}/invocations` | no | yes |
341
+
342
+ ### automation.actions.revisions
343
+
344
+ | Method | HTTP | Path | Streaming | Pagination |
345
+ |---|---|---|---|---|
346
+ | list | GET | `/automation/v1/actions/{ns}/{name}/revisions` | no | yes |
347
+ | retrieve | GET | `/automation/v1/actions/{ns}/{name}/revisions/{revision}` | no | no |
348
+
349
+ ### automation.hooks
350
+
351
+ | Method | HTTP | Path | Streaming | Pagination |
352
+ |---|---|---|---|---|
353
+ | send | POST | `/automation/v1/hooks/{trigger_id}/{token}` | no | no |
354
+
355
+ ### automation.resolve
356
+
357
+ | Method | HTTP | Path | Streaming | Pagination |
358
+ |---|---|---|---|---|
359
+ | retrieve | GET | `/automation/v1/resolve` | no | no |
360
+
361
+ ### automation.runs
362
+
363
+ | Method | HTTP | Path | Streaming | Pagination |
364
+ |---|---|---|---|---|
365
+ | cancel | POST | `/automation/v1/runs/{id}/cancel` | no | no |
366
+ | create | POST | `/automation/v1/runs` | no | no |
367
+ | events | GET | `/automation/v1/runs/{id}/events` | always | no |
368
+ | list | GET | `/automation/v1/runs` | no | yes |
369
+ | logs | GET | `/automation/v1/runs/{id}/logs` | always | no |
370
+ | rerun | POST | `/automation/v1/runs/{id}/rerun` | no | no |
371
+ | resume | POST | `/automation/v1/runs/{id}/resume` | no | no |
372
+ | retrieve | GET | `/automation/v1/runs/{id}` | no | no |
373
+ | retrieveSource | GET | `/automation/v1/runs/{id}/source` | no | no |
374
+ | suspend | POST | `/automation/v1/runs/{id}/suspend` | no | no |
375
+
376
+ ### automation.runs.artifacts
377
+
378
+ | Method | HTTP | Path | Streaming | Pagination |
379
+ |---|---|---|---|---|
380
+ | list | GET | `/automation/v1/runs/{id}/artifacts` | no | yes |
381
+
382
+ ### automation.runs.calls
383
+
384
+ | Method | HTTP | Path | Streaming | Pagination |
385
+ |---|---|---|---|---|
386
+ | list | GET | `/automation/v1/runs/{id}/calls` | no | yes |
387
+
388
+ ### automation.runs.tasks
389
+
390
+ | Method | HTTP | Path | Streaming | Pagination |
391
+ |---|---|---|---|---|
392
+ | list | GET | `/automation/v1/runs/{id}/tasks` | no | yes |
393
+
394
+ ### automation.runs.waits
395
+
396
+ | Method | HTTP | Path | Streaming | Pagination |
397
+ |---|---|---|---|---|
398
+ | complete | POST | `/automation/v1/runs/{id}/waits/{wait_id}/complete` | no | no |
399
+ | list | GET | `/automation/v1/runs/{id}/waits` | no | yes |
400
+
401
+ ### automation.scripts
402
+
403
+ | Method | HTTP | Path | Streaming | Pagination |
404
+ |---|---|---|---|---|
405
+ | archive | POST | `/automation/v1/scripts/{ns}/{name}/archive` | no | no |
406
+ | create | POST | `/automation/v1/scripts` | no | no |
407
+ | list | GET | `/automation/v1/scripts` | no | yes |
408
+ | restore | POST | `/automation/v1/scripts/{ns}/{name}/restore` | no | no |
409
+ | retrieve | GET | `/automation/v1/scripts/{ns}/{name}` | no | no |
410
+ | update | PATCH | `/automation/v1/scripts/{ns}/{name}` | no | no |
411
+
412
+ ### automation.scripts.distTags
413
+
414
+ | Method | HTTP | Path | Streaming | Pagination |
415
+ |---|---|---|---|---|
416
+ | delete | DELETE | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
417
+ | list | GET | `/automation/v1/scripts/{ns}/{name}/dist-tags` | no | no |
418
+ | set | PUT | `/automation/v1/scripts/{ns}/{name}/dist-tags/{tag}` | no | no |
419
+
420
+ ### automation.scripts.versions
421
+
422
+ | Method | HTTP | Path | Streaming | Pagination |
423
+ |---|---|---|---|---|
424
+ | create (alias: publish) | POST | `/automation/v1/scripts/{ns}/{name}/versions` | no | no |
425
+ | deprecate | POST | `/automation/v1/scripts/{ns}/{name}/versions/{version}/deprecate` | no | no |
426
+ | list | GET | `/automation/v1/scripts/{ns}/{name}/versions` | no | yes |
427
+ | retrieve | GET | `/automation/v1/scripts/{ns}/{name}/versions/{version}` | no | no |
428
+
429
+ ### automation.targets
430
+
431
+ | Method | HTTP | Path | Streaming | Pagination |
432
+ |---|---|---|---|---|
433
+ | list | GET | `/automation/v1/targets` | no | yes |
434
+
435
+ ### automation.triggers
436
+
437
+ | Method | HTTP | Path | Streaming | Pagination |
438
+ |---|---|---|---|---|
439
+ | create | POST | `/automation/v1/triggers` | no | no |
440
+ | delete | DELETE | `/automation/v1/triggers/{id}` | no | no |
441
+ | fire | POST | `/automation/v1/triggers/{id}/fire` | no | no |
442
+ | list | GET | `/automation/v1/triggers` | no | yes |
443
+ | pause | POST | `/automation/v1/triggers/{id}/pause` | no | no |
444
+ | preview | POST | `/automation/v1/triggers/preview` | no | no |
445
+ | resume | POST | `/automation/v1/triggers/{id}/resume` | no | no |
446
+ | retrieve | GET | `/automation/v1/triggers/{id}` | no | no |
447
+ | rotateWebhook | POST | `/automation/v1/triggers/{id}/rotate-webhook` | no | no |
448
+ | update | PATCH | `/automation/v1/triggers/{id}` | no | no |
449
+
450
+ ### automation.triggers.firings
451
+
452
+ | Method | HTTP | Path | Streaming | Pagination |
453
+ |---|---|---|---|---|
454
+ | list | GET | `/automation/v1/triggers/{id}/firings` | no | yes |
455
+
456
+ ### automation.validate
457
+
458
+ | Method | HTTP | Path | Streaming | Pagination |
459
+ |---|---|---|---|---|
460
+ | create | POST | `/automation/v1/validate` | no | no |
461
+
462
+ ### automation.workflows
463
+
464
+ | Method | HTTP | Path | Streaming | Pagination |
465
+ |---|---|---|---|---|
466
+ | archive | POST | `/automation/v1/workflows/{ns}/{name}/archive` | no | no |
467
+ | create | POST | `/automation/v1/workflows` | no | no |
468
+ | list | GET | `/automation/v1/workflows` | no | yes |
469
+ | restore | POST | `/automation/v1/workflows/{ns}/{name}/restore` | no | no |
470
+ | retrieve | GET | `/automation/v1/workflows/{ns}/{name}` | no | no |
471
+ | update | PATCH | `/automation/v1/workflows/{ns}/{name}` | no | no |
472
+
473
+ ### automation.workflows.distTags
474
+
475
+ | Method | HTTP | Path | Streaming | Pagination |
476
+ |---|---|---|---|---|
477
+ | delete | DELETE | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
478
+ | list | GET | `/automation/v1/workflows/{ns}/{name}/dist-tags` | no | no |
479
+ | set | PUT | `/automation/v1/workflows/{ns}/{name}/dist-tags/{tag}` | no | no |
480
+
481
+ ### automation.workflows.versions
482
+
483
+ | Method | HTTP | Path | Streaming | Pagination |
484
+ |---|---|---|---|---|
485
+ | create (alias: publish) | POST | `/automation/v1/workflows/{ns}/{name}/versions` | no | no |
486
+ | deprecate | POST | `/automation/v1/workflows/{ns}/{name}/versions/{version}/deprecate` | no | no |
487
+ | list | GET | `/automation/v1/workflows/{ns}/{name}/versions` | no | yes |
488
+ | retrieve | GET | `/automation/v1/workflows/{ns}/{name}/versions/{version}` | no | no |
489
+
490
+ ## browser
491
+
492
+ ### browser.connect
493
+
494
+ | Method | HTTP | Path | Streaming | Pagination |
495
+ |---|---|---|---|---|
496
+ | retrieve | GET | `/browser/v1/connect` | no | no |
497
+
498
+ ### browser.contexts
499
+
500
+ | Method | HTTP | Path | Streaming | Pagination |
501
+ |---|---|---|---|---|
502
+ | create | POST | `/browser/v1/contexts` | no | no |
503
+ | delete | DELETE | `/browser/v1/contexts/{contextId}` | no | no |
504
+ | list | GET | `/browser/v1/contexts` | no | no |
505
+ | retrieve | GET | `/browser/v1/contexts/{contextId}` | no | no |
506
+ | update | PUT | `/browser/v1/contexts/{contextId}` | no | no |
507
+
508
+ ### browser.live
509
+
510
+ | Method | HTTP | Path | Streaming | Pagination |
511
+ |---|---|---|---|---|
512
+ | retrieve | GET | `/browser/v1/live/{sessionId}/{pageId}` | no | no |
513
+
514
+ ### browser.seleniumUnsupported
515
+
516
+ | Method | HTTP | Path | Streaming | Pagination |
517
+ |---|---|---|---|---|
518
+ | retrieve | GET | `/browser/v1/selenium-unsupported` | no | no |
519
+
520
+ ### browser.sessions
521
+
522
+ | Method | HTTP | Path | Streaming | Pagination |
523
+ |---|---|---|---|---|
524
+ | create | POST | `/browser/v1/sessions` | no | no |
525
+ | list | GET | `/browser/v1/sessions` | no | no |
526
+ | retrieve | GET | `/browser/v1/sessions/{sessionId}` | no | no |
527
+ | retrieveDebug | GET | `/browser/v1/sessions/{sessionId}/debug` | no | no |
528
+ | stream | GET | `/browser/v1/sessions/{sessionId}/stream` | always | no |
529
+ | update | POST | `/browser/v1/sessions/{sessionId}` | no | no |
530
+
531
+ ### browser.sessions.events
532
+
533
+ | Method | HTTP | Path | Streaming | Pagination |
534
+ |---|---|---|---|---|
535
+ | list | GET | `/browser/v1/sessions/{sessionId}/events` | no | no |
536
+
537
+ ### browser.sessions.handoff
538
+
539
+ | Method | HTTP | Path | Streaming | Pagination |
540
+ |---|---|---|---|---|
541
+ | complete | POST | `/browser/v1/sessions/{sessionId}/handoff/complete` | no | no |
542
+ | create | POST | `/browser/v1/sessions/{sessionId}/handoff` | no | no |
543
+
544
+ ### browser.sessions.viewer
545
+
546
+ | Method | HTTP | Path | Streaming | Pagination |
547
+ |---|---|---|---|---|
548
+ | create | POST | `/browser/v1/sessions/{sessionId}/viewer` | no | no |
549
+
550
+ ## database
551
+
552
+ ### database.databases
553
+
554
+ | Method | HTTP | Path | Streaming | Pagination |
555
+ |---|---|---|---|---|
556
+ | create | POST | `/database/v1/databases` | no | no |
557
+ | delete | DELETE | `/database/v1/databases/{database_id}` | no | no |
558
+ | list | GET | `/database/v1/databases` | no | yes |
559
+ | restore | POST | `/database/v1/databases/{database_id}/restore` | no | no |
560
+ | retrieve | GET | `/database/v1/databases/{database_id}` | no | no |
561
+ | update | PATCH | `/database/v1/databases/{database_id}` | no | no |
562
+
563
+ ### database.databases.events
564
+
565
+ | Method | HTTP | Path | Streaming | Pagination |
566
+ |---|---|---|---|---|
567
+ | list | GET | `/database/v1/databases/{database_id}/events` | no | no |
568
+
569
+ ### database.databases.purge
570
+
571
+ | Method | HTTP | Path | Streaming | Pagination |
572
+ |---|---|---|---|---|
573
+ | create | POST | `/database/v1/databases/{database_id}/purge` | no | no |
574
+
575
+ ### database.databases.rest
576
+
577
+ | Method | HTTP | Path | Streaming | Pagination |
578
+ |---|---|---|---|---|
579
+ | create | POST | `/database/v1/databases/{database_id}/rest/{table}` | no | no |
580
+ | delete | DELETE | `/database/v1/databases/{database_id}/rest/{table}` | no | no |
581
+ | head | HEAD | `/database/v1/databases/{database_id}/rest/{table}` | no | no |
582
+ | retrieve | GET | `/database/v1/databases/{database_id}/rest/{table}` | no | no |
583
+ | update | PATCH | `/database/v1/databases/{database_id}/rest/{table}` | no | no |
584
+
585
+ ### database.databases.tables
586
+
587
+ | Method | HTTP | Path | Streaming | Pagination |
588
+ |---|---|---|---|---|
589
+ | create | POST | `/database/v1/databases/{database_id}/tables` | no | no |
590
+ | delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}` | no | no |
591
+ | list | GET | `/database/v1/databases/{database_id}/tables` | no | no |
592
+ | retrieve | GET | `/database/v1/databases/{database_id}/tables/{table}` | no | no |
593
+ | update | PATCH | `/database/v1/databases/{database_id}/tables/{table}` | no | no |
594
+
595
+ ### database.databases.tables.fields
596
+
597
+ | Method | HTTP | Path | Streaming | Pagination |
598
+ |---|---|---|---|---|
599
+ | create | POST | `/database/v1/databases/{database_id}/tables/{table}/fields` | no | no |
600
+ | delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
601
+ | update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
602
+
603
+ ## file
604
+
605
+ ### file.files
606
+
607
+ | Method | HTTP | Path | Streaming | Pagination |
608
+ |---|---|---|---|---|
609
+ | create | POST | `/file/v1/files` | no | no |
610
+ | delete | DELETE | `/file/v1/files/{file_id}` | no | no |
611
+ | list | GET | `/file/v1/files` | no | no |
612
+ | retrieve | GET | `/file/v1/files/{file_id}` | no | no |
613
+ | retrieveContent | GET | `/file/v1/files/{file_id}/content` | no | no |
614
+
615
+ ## knowledge
616
+
617
+ ### knowledge.vectorStores
618
+
619
+ | Method | HTTP | Path | Streaming | Pagination |
620
+ |---|---|---|---|---|
621
+ | create | POST | `/knowledge/v1/vector_stores` | no | no |
622
+ | delete | DELETE | `/knowledge/v1/vector_stores/{vector_store_id}` | no | no |
623
+ | list | GET | `/knowledge/v1/vector_stores` | no | no |
624
+ | restore | POST | `/knowledge/v1/vector_stores/{vector_store_id}/restore` | no | no |
625
+ | retrieve | GET | `/knowledge/v1/vector_stores/{vector_store_id}` | no | no |
626
+ | update | POST | `/knowledge/v1/vector_stores/{vector_store_id}` | no | no |
627
+
628
+ ### knowledge.vectorStores.events
629
+
630
+ | Method | HTTP | Path | Streaming | Pagination |
631
+ |---|---|---|---|---|
632
+ | list | GET | `/knowledge/v1/vector_stores/{vector_store_id}/events` | no | no |
633
+
634
+ ### knowledge.vectorStores.fileBatches
635
+
636
+ | Method | HTTP | Path | Streaming | Pagination |
637
+ |---|---|---|---|---|
638
+ | cancel | POST | `/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel` | no | no |
639
+ | create | POST | `/knowledge/v1/vector_stores/{vector_store_id}/file_batches` | no | no |
640
+ | retrieve | GET | `/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}` | no | no |
641
+
642
+ ### knowledge.vectorStores.fileBatches.files
643
+
644
+ | Method | HTTP | Path | Streaming | Pagination |
645
+ |---|---|---|---|---|
646
+ | list | GET | `/knowledge/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files` | no | no |
647
+
648
+ ### knowledge.vectorStores.files
649
+
650
+ | Method | HTTP | Path | Streaming | Pagination |
651
+ |---|---|---|---|---|
652
+ | create | POST | `/knowledge/v1/vector_stores/{vector_store_id}/files` | no | no |
653
+ | delete | DELETE | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}` | no | no |
654
+ | list | GET | `/knowledge/v1/vector_stores/{vector_store_id}/files` | no | no |
655
+ | retrieve | GET | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}` | no | no |
656
+ | retrieveContent | GET | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/content` | no | no |
657
+ | update | POST | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}` | no | no |
658
+
659
+ ### knowledge.vectorStores.files.retry
660
+
661
+ | Method | HTTP | Path | Streaming | Pagination |
662
+ |---|---|---|---|---|
663
+ | create | POST | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/retry` | no | no |
664
+
665
+ ### knowledge.vectorStores.files.segments
666
+
667
+ | Method | HTTP | Path | Streaming | Pagination |
668
+ |---|---|---|---|---|
669
+ | list | GET | `/knowledge/v1/vector_stores/{vector_store_id}/files/{file_id}/segments` | no | no |
670
+
671
+ ### knowledge.vectorStores.purge
672
+
673
+ | Method | HTTP | Path | Streaming | Pagination |
674
+ |---|---|---|---|---|
675
+ | create | POST | `/knowledge/v1/vector_stores/{vector_store_id}/purge` | no | no |
676
+
677
+ ### knowledge.vectorStores.search
678
+
679
+ | Method | HTTP | Path | Streaming | Pagination |
680
+ |---|---|---|---|---|
681
+ | create | POST | `/knowledge/v1/vector_stores/{vector_store_id}/search` | no | no |
682
+
683
+ ### knowledge.vectorStores.segments
684
+
685
+ | Method | HTTP | Path | Streaming | Pagination |
686
+ |---|---|---|---|---|
687
+ | retrieve | GET | `/knowledge/v1/vector_stores/{vector_store_id}/segments/{chunk_id}` | no | no |
688
+
689
+ ## media
690
+
691
+ ### media.libraries
692
+
693
+ | Method | HTTP | Path | Streaming | Pagination |
694
+ |---|---|---|---|---|
695
+ | create | POST | `/media/v1/libraries` | no | no |
696
+ | delete | DELETE | `/media/v1/libraries/{library_id}` | no | no |
697
+ | list | GET | `/media/v1/libraries` | no | yes |
698
+ | restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
699
+ | retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
700
+ | update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
701
+
702
+ ### media.libraries.assets
703
+
704
+ | Method | HTTP | Path | Streaming | Pagination |
705
+ |---|---|---|---|---|
706
+ | batch | POST | `/media/v1/libraries/{library_id}/assets:batch` | no | no |
707
+ | create | POST | `/media/v1/libraries/{library_id}/assets` | no | no |
708
+ | delete | DELETE | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
709
+ | list | GET | `/media/v1/libraries/{library_id}/assets` | no | yes |
710
+ | retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
711
+ | update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
712
+
713
+ ### media.libraries.assets.import
714
+
715
+ | Method | HTTP | Path | Streaming | Pagination |
716
+ |---|---|---|---|---|
717
+ | create | POST | `/media/v1/libraries/{library_id}/assets/import` | no | no |
718
+
719
+ ### media.libraries.assets.reprocess
720
+
721
+ | Method | HTTP | Path | Streaming | Pagination |
722
+ |---|---|---|---|---|
723
+ | create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess` | no | no |
724
+
725
+ ### media.libraries.assets.understandings
726
+
727
+ | Method | HTTP | Path | Streaming | Pagination |
728
+ |---|---|---|---|---|
729
+ | list | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/understandings` | no | yes |
730
+
731
+ ### media.libraries.batches
732
+
733
+ | Method | HTTP | Path | Streaming | Pagination |
734
+ |---|---|---|---|---|
735
+ | create | POST | `/media/v1/libraries/{library_id}/batches` | no | no |
736
+ | retrieve | GET | `/media/v1/libraries/{library_id}/batches/{job_id}` | no | no |
737
+
738
+ ### media.libraries.events
739
+
740
+ | Method | HTTP | Path | Streaming | Pagination |
741
+ |---|---|---|---|---|
742
+ | list | GET | `/media/v1/libraries/{library_id}/events` | no | no |
743
+
744
+ ### media.libraries.folders
745
+
746
+ | Method | HTTP | Path | Streaming | Pagination |
747
+ |---|---|---|---|---|
748
+ | list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
749
+
750
+ ### media.libraries.jobs
751
+
752
+ | Method | HTTP | Path | Streaming | Pagination |
753
+ |---|---|---|---|---|
754
+ | retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
755
+
756
+ ### media.libraries.purge
757
+
758
+ | Method | HTTP | Path | Streaming | Pagination |
759
+ |---|---|---|---|---|
760
+ | create | POST | `/media/v1/libraries/{library_id}/purge` | no | no |
761
+
762
+ ### media.libraries.search
763
+
764
+ | Method | HTTP | Path | Streaming | Pagination |
765
+ |---|---|---|---|---|
766
+ | create | POST | `/media/v1/libraries/{library_id}/search` | no | no |
767
+
768
+ ### media.libraries.search.expression
769
+
770
+ | Method | HTTP | Path | Streaming | Pagination |
771
+ |---|---|---|---|---|
772
+ | create | POST | `/media/v1/libraries/{library_id}/search/expression` | no | no |
773
+
774
+ ### media.libraries.search.semantic
775
+
776
+ | Method | HTTP | Path | Streaming | Pagination |
777
+ |---|---|---|---|---|
778
+ | create | POST | `/media/v1/libraries/{library_id}/search/semantic` | no | no |
779
+
780
+ ### media.libraries.search.visual
781
+
782
+ | Method | HTTP | Path | Streaming | Pagination |
783
+ |---|---|---|---|---|
784
+ | create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
785
+
786
+ ## meta
787
+
788
+ ### meta.health
789
+
790
+ | Method | HTTP | Path | Streaming | Pagination |
791
+ |---|---|---|---|---|
792
+ | retrieve | GET | `/meta/v1/health` | no | no |
793
+
794
+ ### meta.methods
795
+
796
+ | Method | HTTP | Path | Streaming | Pagination |
797
+ |---|---|---|---|---|
798
+ | list | GET | `/meta/v1/methods` | no | no |
799
+ | retrieve | GET | `/meta/v1/methods/{name}` | no | no |
800
+
801
+ ## model
802
+
803
+ ### model.audio.speech
804
+
805
+ | Method | HTTP | Path | Streaming | Pagination |
806
+ |---|---|---|---|---|
807
+ | create | POST | `/model/v1/audio/speech` | no | no |
808
+
809
+ ### model.audio.transcriptions
810
+
811
+ | Method | HTTP | Path | Streaming | Pagination |
812
+ |---|---|---|---|---|
813
+ | create | POST | `/model/v1/audio/transcriptions` | no | no |
814
+
815
+ ### model.chat.completions
816
+
817
+ | Method | HTTP | Path | Streaming | Pagination |
818
+ |---|---|---|---|---|
819
+ | create | POST | `/model/v1/chat/completions` | optional | no |
820
+
821
+ ### model.conversations
822
+
823
+ | Method | HTTP | Path | Streaming | Pagination |
824
+ |---|---|---|---|---|
825
+ | create | POST | `/model/v1/conversations` | no | no |
826
+ | delete | DELETE | `/model/v1/conversations/{conversation_id}` | no | no |
827
+ | retrieve | GET | `/model/v1/conversations/{conversation_id}` | no | no |
828
+ | update | POST | `/model/v1/conversations/{conversation_id}` | no | no |
829
+
830
+ ### model.conversations.items
831
+
832
+ | Method | HTTP | Path | Streaming | Pagination |
833
+ |---|---|---|---|---|
834
+ | create | POST | `/model/v1/conversations/{conversation_id}/items` | no | no |
835
+ | delete | DELETE | `/model/v1/conversations/{conversation_id}/items/{item_id}` | no | no |
836
+ | list | GET | `/model/v1/conversations/{conversation_id}/items` | no | no |
837
+ | retrieve | GET | `/model/v1/conversations/{conversation_id}/items/{item_id}` | no | no |
838
+
839
+ ### model.embeddings
840
+
841
+ | Method | HTTP | Path | Streaming | Pagination |
842
+ |---|---|---|---|---|
843
+ | create | POST | `/model/v1/embeddings` | no | no |
844
+
845
+ ### model.generation
846
+
847
+ | Method | HTTP | Path | Streaming | Pagination |
848
+ |---|---|---|---|---|
849
+ | retrieve | GET | `/model/v1/generation` | no | no |
850
+
851
+ ### model.images.edits
852
+
853
+ | Method | HTTP | Path | Streaming | Pagination |
854
+ |---|---|---|---|---|
855
+ | create | POST | `/model/v1/images/edits` | no | no |
856
+
857
+ ### model.images.generations
858
+
859
+ | Method | HTTP | Path | Streaming | Pagination |
860
+ |---|---|---|---|---|
861
+ | create | POST | `/model/v1/images/generations` | no | no |
862
+
863
+ ### model.messages
864
+
865
+ | Method | HTTP | Path | Streaming | Pagination |
866
+ |---|---|---|---|---|
867
+ | countTokens | POST | `/model/v1/messages/count_tokens` | no | no |
868
+ | create | POST | `/model/v1/messages` | optional | no |
869
+
870
+ ### model.models
871
+
872
+ | Method | HTTP | Path | Streaming | Pagination |
873
+ |---|---|---|---|---|
874
+ | list | GET | `/model/v1/models` | no | no |
875
+ | retrieve | GET | `/model/v1/models/{model}` | no | no |
876
+
877
+ ### model.ocr
878
+
879
+ | Method | HTTP | Path | Streaming | Pagination |
880
+ |---|---|---|---|---|
881
+ | create | POST | `/model/v1/ocr` | no | no |
882
+
883
+ ### model.rerank
884
+
885
+ | Method | HTTP | Path | Streaming | Pagination |
886
+ |---|---|---|---|---|
887
+ | create | POST | `/model/v1/rerank` | no | no |
888
+
889
+ ### model.responses
890
+
891
+ | Method | HTTP | Path | Streaming | Pagination |
892
+ |---|---|---|---|---|
893
+ | cancel | POST | `/model/v1/responses/{response_id}/cancel` | no | no |
894
+ | compact | POST | `/model/v1/responses/compact` | no | no |
895
+ | create | POST | `/model/v1/responses` | optional | no |
896
+ | delete | DELETE | `/model/v1/responses/{response_id}` | no | no |
897
+ | retrieve | GET | `/model/v1/responses/{response_id}` | no | no |
898
+
899
+ ### model.responses.inputItems
900
+
901
+ | Method | HTTP | Path | Streaming | Pagination |
902
+ |---|---|---|---|---|
903
+ | list | GET | `/model/v1/responses/{response_id}/input_items` | no | no |
904
+
905
+ ### model.responses.inputTokens
906
+
907
+ | Method | HTTP | Path | Streaming | Pagination |
908
+ |---|---|---|---|---|
909
+ | create | POST | `/model/v1/responses/input_tokens` | no | no |
910
+
911
+ ### model.videos
912
+
913
+ | Method | HTTP | Path | Streaming | Pagination |
914
+ |---|---|---|---|---|
915
+ | create | POST | `/model/v1/videos` | no | no |
916
+ | delete | DELETE | `/model/v1/videos/{video_id}` | no | no |
917
+ | list | GET | `/model/v1/videos` | no | no |
918
+ | remix | POST | `/model/v1/videos/{video_id}/remix` | no | no |
919
+ | retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
920
+ | retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
921
+
922
+ ## organization
923
+
924
+ ### organization.charges
925
+
926
+ | Method | HTTP | Path | Streaming | Pagination |
927
+ |---|---|---|---|---|
928
+ | list | GET | `/organization/v1/charges` | no | no |
929
+
930
+ ### organization.costs
931
+
932
+ | Method | HTTP | Path | Streaming | Pagination |
933
+ |---|---|---|---|---|
934
+ | list | GET | `/organization/v1/costs` | no | no |
935
+
936
+ ### organization.events
937
+
938
+ | Method | HTTP | Path | Streaming | Pagination |
939
+ |---|---|---|---|---|
940
+ | list | GET | `/organization/v1/events` | no | no |
941
+ | retrieve | GET | `/organization/v1/events/{id}` | no | no |
942
+
943
+ ### organization.feedback
944
+
945
+ | Method | HTTP | Path | Streaming | Pagination |
946
+ |---|---|---|---|---|
947
+ | create | POST | `/organization/v1/feedback` | no | no |
948
+ | list | GET | `/organization/v1/feedback` | no | no |
949
+ | retrieve | GET | `/organization/v1/feedback/{id}` | no | no |
950
+
951
+ ### organization.feedback.counts
952
+
953
+ | Method | HTTP | Path | Streaming | Pagination |
954
+ |---|---|---|---|---|
955
+ | list | GET | `/organization/v1/feedback/counts` | no | no |
956
+
957
+ ### organization.feedback.messages
958
+
959
+ | Method | HTTP | Path | Streaming | Pagination |
960
+ |---|---|---|---|---|
961
+ | create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
962
+ | list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
963
+
964
+ ### organization.usage
965
+
966
+ | Method | HTTP | Path | Streaming | Pagination |
967
+ |---|---|---|---|---|
968
+ | list | GET | `/organization/v1/usage` | no | no |
969
+
970
+ ## sandbox
971
+
972
+ ### sandbox.sandboxes
973
+
974
+ | Method | HTTP | Path | Streaming | Pagination |
975
+ |---|---|---|---|---|
976
+ | connect | POST | `/sandbox/v1/sandboxes/{sandboxID}/connect` | no | no |
977
+ | create | POST | `/sandbox/v1/sandboxes` | no | no |
978
+ | delete | DELETE | `/sandbox/v1/sandboxes/{sandboxID}` | no | no |
979
+ | extend | POST | `/sandbox/v1/sandboxes/{sandboxID}/extend` | no | no |
980
+ | fork | POST | `/sandbox/v1/sandboxes/{sandboxID}/fork` | no | no |
981
+ | list | GET | `/sandbox/v1/sandboxes` | no | no |
982
+ | pause | POST | `/sandbox/v1/sandboxes/{sandboxID}/pause` | no | no |
983
+ | retrieve | GET | `/sandbox/v1/sandboxes/{sandboxID}` | no | no |
984
+ | timeout | POST | `/sandbox/v1/sandboxes/{sandboxID}/timeout` | no | no |
985
+ | update | PATCH | `/sandbox/v1/sandboxes/{sandboxID}` | no | no |
986
+ | updateNetwork | PUT | `/sandbox/v1/sandboxes/{sandboxID}/network` | no | no |
987
+
988
+ ### sandbox.sandboxes.commands
989
+
990
+ | Method | HTTP | Path | Streaming | Pagination |
991
+ |---|---|---|---|---|
992
+ | run | POST | `/sandbox/v1/sandboxes/{sandbox_id}/commands` | no | no |
993
+
994
+ ### sandbox.sandboxes.files
995
+
996
+ | Method | HTTP | Path | Streaming | Pagination |
997
+ |---|---|---|---|---|
998
+ | list | GET | `/sandbox/v1/sandboxes/{sandbox_id}/files:list` | no | no |
999
+ | makeDir | POST | `/sandbox/v1/sandboxes/{sandbox_id}/files:makeDir` | no | no |
1000
+ | read | GET | `/sandbox/v1/sandboxes/{sandbox_id}/files` | no | no |
1001
+ | remove | DELETE | `/sandbox/v1/sandboxes/{sandbox_id}/files` | no | no |
1002
+ | write | PUT | `/sandbox/v1/sandboxes/{sandbox_id}/files` | no | no |
1003
+
1004
+ ### sandbox.sandboxes.logs
1005
+
1006
+ | Method | HTTP | Path | Streaming | Pagination |
1007
+ |---|---|---|---|---|
1008
+ | list | GET | `/sandbox/v1/sandboxes/{sandboxID}/logs` | no | no |
1009
+
1010
+ ### sandbox.sandboxes.metrics
1011
+
1012
+ | Method | HTTP | Path | Streaming | Pagination |
1013
+ |---|---|---|---|---|
1014
+ | list | GET | `/sandbox/v1/sandboxes/{sandboxID}/metrics` | no | no |
1015
+
1016
+ ### sandbox.sandboxes.processes
1017
+
1018
+ | Method | HTTP | Path | Streaming | Pagination |
1019
+ |---|---|---|---|---|
1020
+ | list | GET | `/sandbox/v1/sandboxes/{sandboxID}/processes` | no | no |
1021
+ | retrieveOutput | GET | `/sandbox/v1/sandboxes/{sandboxID}/processes/{processID}/output` | no | no |
1022
+
1023
+ ### sandbox.sandboxes.snapshots
1024
+
1025
+ | Method | HTTP | Path | Streaming | Pagination |
1026
+ |---|---|---|---|---|
1027
+ | create | POST | `/sandbox/v1/sandboxes/{sandboxID}/snapshots` | no | no |
1028
+
1029
+ ### sandbox.sandboxes.upgrade
1030
+
1031
+ | Method | HTTP | Path | Streaming | Pagination |
1032
+ |---|---|---|---|---|
1033
+ | create | POST | `/sandbox/v1/sandboxes/{sandboxID}/upgrade` | no | no |
1034
+
1035
+ ### sandbox.snapshots
1036
+
1037
+ | Method | HTTP | Path | Streaming | Pagination |
1038
+ |---|---|---|---|---|
1039
+ | delete | DELETE | `/sandbox/v1/snapshots/{snapshotID}` | no | no |
1040
+ | list | GET | `/sandbox/v1/snapshots` | no | no |
1041
+
1042
+ ### sandbox.templates
1043
+
1044
+ | Method | HTTP | Path | Streaming | Pagination |
1045
+ |---|---|---|---|---|
1046
+ | list | GET | `/sandbox/v1/templates` | no | no |
1047
+
1048
+ ### sandbox.volumes
1049
+
1050
+ | Method | HTTP | Path | Streaming | Pagination |
1051
+ |---|---|---|---|---|
1052
+ | create | POST | `/sandbox/v1/volumes` | no | no |
1053
+ | delete | DELETE | `/sandbox/v1/volumes/{volumeID}` | no | no |
1054
+ | list | GET | `/sandbox/v1/volumes` | no | no |
1055
+ | retrieve | GET | `/sandbox/v1/volumes/{volumeID}` | no | no |
1056
+
1057
+ ## search
1058
+
1059
+ ### search.crawl
1060
+
1061
+ | Method | HTTP | Path | Streaming | Pagination |
1062
+ |---|---|---|---|---|
1063
+ | create | POST | `/search/v1/crawl` | no | no |
1064
+
1065
+ ### search.extract
1066
+
1067
+ | Method | HTTP | Path | Streaming | Pagination |
1068
+ |---|---|---|---|---|
1069
+ | create | POST | `/search/v1/extract` | no | no |
1070
+
1071
+ ### search.map
1072
+
1073
+ | Method | HTTP | Path | Streaming | Pagination |
1074
+ |---|---|---|---|---|
1075
+ | create | POST | `/search/v1/map` | no | no |
1076
+
1077
+ ### search.search
1078
+
1079
+ | Method | HTTP | Path | Streaming | Pagination |
1080
+ |---|---|---|---|---|
1081
+ | create | POST | `/search/v1/search` | no | no |
1082
+
1083
+ ## vault
1084
+
1085
+ ### vault.authorizations
1086
+
1087
+ | Method | HTTP | Path | Streaming | Pagination |
1088
+ |---|---|---|---|---|
1089
+ | create | POST | `/vault/v1/authorizations` | no | no |
1090
+ | retrieve | GET | `/vault/v1/authorizations/{authorization_id}` | no | no |
1091
+ | retrieveCallback | GET | `/vault/v1/authorizations/callback` | no | no |
1092
+
1093
+ ### vault.connect
1094
+
1095
+ | Method | HTTP | Path | Streaming | Pagination |
1096
+ |---|---|---|---|---|
1097
+ | retrieve | GET | `/vault/v1/connect/{token}` | no | no |
1098
+
1099
+ ### vault.connect.continue
1100
+
1101
+ | Method | HTTP | Path | Streaming | Pagination |
1102
+ |---|---|---|---|---|
1103
+ | create | POST | `/vault/v1/connect/{token}/continue` | no | no |
1104
+
1105
+ ### vault.connect.deny
1106
+
1107
+ | Method | HTTP | Path | Streaming | Pagination |
1108
+ |---|---|---|---|---|
1109
+ | create | POST | `/vault/v1/connect/{token}/deny` | no | no |
1110
+
1111
+ ### vault.oauth
1112
+
1113
+ | Method | HTTP | Path | Streaming | Pagination |
1114
+ |---|---|---|---|---|
1115
+ | retrieveClientMetadata | GET | `/vault/v1/oauth/client.json` | no | no |
1116
+
1117
+ ### vault.settings.returnUrls
1118
+
1119
+ | Method | HTTP | Path | Streaming | Pagination |
1120
+ |---|---|---|---|---|
1121
+ | list | GET | `/vault/v1/settings/return_urls` | no | no |
1122
+ | update | PUT | `/vault/v1/settings/return_urls` | no | no |
1123
+
1124
+ ### vault.templates
1125
+
1126
+ | Method | HTTP | Path | Streaming | Pagination |
1127
+ |---|---|---|---|---|
1128
+ | list | GET | `/vault/v1/templates` | no | no |
1129
+
1130
+ ### vault.vaults
1131
+
1132
+ | Method | HTTP | Path | Streaming | Pagination |
1133
+ |---|---|---|---|---|
1134
+ | archive | POST | `/vault/v1/vaults/{vault_id}/archive` | no | no |
1135
+ | check | POST | `/vault/v1/vaults:check` | no | no |
1136
+ | create | POST | `/vault/v1/vaults` | no | no |
1137
+ | delete | DELETE | `/vault/v1/vaults/{vault_id}` | no | no |
1138
+ | list | GET | `/vault/v1/vaults` | no | yes |
1139
+ | retrieve | GET | `/vault/v1/vaults/{vault_id}` | no | no |
1140
+ | update | POST | `/vault/v1/vaults/{vault_id}` | no | no |
1141
+
1142
+ ### vault.vaults.events
1143
+
1144
+ | Method | HTTP | Path | Streaming | Pagination |
1145
+ |---|---|---|---|---|
1146
+ | list | GET | `/vault/v1/vaults/{vault_id}/events` | no | yes |
1147
+
1148
+ ### vault.vaults.secrets
1149
+
1150
+ | Method | HTTP | Path | Streaming | Pagination |
1151
+ |---|---|---|---|---|
1152
+ | archive | POST | `/vault/v1/vaults/{vault_id}/secrets/{secret}/archive` | no | no |
1153
+ | create | POST | `/vault/v1/vaults/{vault_id}/secrets` | no | no |
1154
+ | delete | DELETE | `/vault/v1/vaults/{vault_id}/secrets/{secret}` | no | no |
1155
+ | import | POST | `/vault/v1/vaults/{vault_id}/secrets:import` | no | no |
1156
+ | list | GET | `/vault/v1/vaults/{vault_id}/secrets` | no | yes |
1157
+ | retrieve | GET | `/vault/v1/vaults/{vault_id}/secrets/{secret}` | no | no |
1158
+ | update | POST | `/vault/v1/vaults/{vault_id}/secrets/{secret}` | no | no |
1159
+
1160
+ ### vault.vaults.secrets.refresh
1161
+
1162
+ | Method | HTTP | Path | Streaming | Pagination |
1163
+ |---|---|---|---|---|
1164
+ | create | POST | `/vault/v1/vaults/{vault_id}/secrets/{secret}/refresh` | no | no |
1165
+
1166
+ ### vault.vaults.secrets.validate
1167
+
1168
+ | Method | HTTP | Path | Streaming | Pagination |
1169
+ |---|---|---|---|---|
1170
+ | create | POST | `/vault/v1/vaults/{vault_id}/secrets/{secret}/validate` | no | no |
1171
+
1172
+ ## Semantic exceptions and aliases
1173
+
1174
+ | Operation | Reason |
1175
+ |---|---|
1176
+ | agent.sessions.events.send | Events submit session input; the product verb is send rather than create. |
1177
+ | automation.hooks.send | Delivers a payload to a trigger's secret webhook URL; it sends an event rather than updating a hook resource. |
1178
+ | automation.scripts.distTags.set | A dist-tag assigns a version to a name; use npm vocabulary set rather than update. |
1179
+ | automation.scripts.versions.create / publish | Creating a script version publishes it; publish is a product alias of versions.create. |
1180
+ | automation.workflows.distTags.set | Workflow dist-tags use the same npm-style assignment vocabulary as script dist-tags. |
1181
+ | automation.workflows.versions.create / publish | Creating a workflow version publishes it; publish is a product alias of versions.create. |
1182
+ | database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
1183
+ | sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1184
+ | sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1185
+ | sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1186
+ | sandbox.sandboxes.files.write | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
1187
+ | vault.oauth.retrieveClientMetadata | The literal .json filename otherwise introduces a dot inside a method identifier. |
1188
+
1189
+ ## SDK parameter aliases
1190
+
1191
+ | Method | SDK argument | Wire parameter |
1192
+ |---|---|---|
1193
+ | agent.sessions.resources.delete | query.query_session_id | query.session_id |
1194
+ | agent.sessions.resources.retrieve | query.query_session_id | query.session_id |
1195
+ | agent.sessions.threads.retrieve | query.query_session_id | query.session_id |
1196
+ | agent.sessions.threads.archive | query.query_session_id | query.session_id |
1197
+ | agent.sessions.threads.events.list | query.query_session_id | query.session_id |
1198
+ | agent.sessions.threads.stream | query.query_session_id | query.session_id |