@deepraxis/sdk 0.0.0-stage → 0.1.0-dev.ea77ce8

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