@deepraxis/sdk 0.0.0-stage → 0.1.0-dev.13103a0

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