@deepraxis/sdk 0.1.1-dev.cbec4d1 → 0.1.1-dev.cf193b8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +489 -13
- package/README.md +4 -4
- package/dist/core/credentials.d.ts +12 -3
- package/dist/core/credentials.js +22 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/core/transport.d.ts +1 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +1122 -159
- package/dist/generated/sdk.gen.js +4038 -1236
- package/dist/generated/types.gen.d.ts +59406 -42729
- package/dist/helpers/browser-actions.d.ts +84 -0
- package/dist/helpers/browser-actions.js +141 -0
- package/dist/helpers/browser-connect.d.ts +26 -2
- package/dist/helpers/browser-connect.js +263 -25
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +53 -0
- package/dist/helpers/browser-documentation.d.ts +1 -1
- package/dist/helpers/browser-documentation.js +20 -11
- package/dist/operations.generated.d.ts +35 -16753
- package/dist/operations.generated.js +10844 -4674
- package/dist/resources.generated.d.ts +344 -10
- package/dist/resources.generated.js +304 -8
- package/package.json +2 -2
package/METHODS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SDK methods
|
|
2
2
|
|
|
3
|
-
Generated by `bun run generate`.
|
|
3
|
+
Generated by `bun run generate`. 688 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
4
|
|
|
5
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
6
|
|
|
@@ -103,6 +103,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
103
103
|
| list | GET | `/agent/v1/computers/{computer_id}/files` | no | no |
|
|
104
104
|
| retrieveContent | GET | `/agent/v1/computers/{computer_id}/files/content` | no | no |
|
|
105
105
|
|
|
106
|
+
### agent.computers.files.convert
|
|
107
|
+
|
|
108
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
109
|
+
|---|---|---|---|---|
|
|
110
|
+
| create | POST | `/agent/v1/computers/{computer_id}/files/convert` | no | no |
|
|
111
|
+
|
|
106
112
|
### agent.computers.leases
|
|
107
113
|
|
|
108
114
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -570,12 +576,20 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
570
576
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
571
577
|
|---|---|---|---|---|
|
|
572
578
|
| create | POST | `/browser/v1/sessions` | no | no |
|
|
579
|
+
| frames | GET | `/browser/v1/sessions/{sessionId}/frames` | always | no |
|
|
573
580
|
| list | GET | `/browser/v1/sessions` | no | no |
|
|
574
581
|
| retrieve | GET | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
575
582
|
| retrieveDebug | GET | `/browser/v1/sessions/{sessionId}/debug` | no | no |
|
|
583
|
+
| retrieveFrame | GET | `/browser/v1/sessions/{sessionId}/frame` | no | no |
|
|
576
584
|
| stream | GET | `/browser/v1/sessions/{sessionId}/stream` | always | no |
|
|
577
585
|
| update | POST | `/browser/v1/sessions/{sessionId}` | no | no |
|
|
578
586
|
|
|
587
|
+
### browser.sessions.actions
|
|
588
|
+
|
|
589
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
590
|
+
|---|---|---|---|---|
|
|
591
|
+
| create | POST | `/browser/v1/sessions/{sessionId}/actions` | no | no |
|
|
592
|
+
|
|
579
593
|
### browser.sessions.events
|
|
580
594
|
|
|
581
595
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -786,6 +800,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
786
800
|
|---|---|---|---|---|
|
|
787
801
|
| import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
|
|
788
802
|
|
|
803
|
+
### cut.projects.renders
|
|
804
|
+
|
|
805
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
806
|
+
|---|---|---|---|---|
|
|
807
|
+
| create | POST | `/cut/v1/projects/{project_id}/renders` | no | no |
|
|
808
|
+
|
|
789
809
|
### cut.projects.versions
|
|
790
810
|
|
|
791
811
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -793,6 +813,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
793
813
|
| create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
794
814
|
| list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
|
|
795
815
|
|
|
816
|
+
### cut.renders
|
|
817
|
+
|
|
818
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
819
|
+
|---|---|---|---|---|
|
|
820
|
+
| retrieve | GET | `/cut/v1/renders/{render_id}` | no | no |
|
|
821
|
+
|
|
796
822
|
### cut.versions
|
|
797
823
|
|
|
798
824
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -852,6 +878,213 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
852
878
|
| delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
853
879
|
| update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
|
|
854
880
|
|
|
881
|
+
## devops
|
|
882
|
+
|
|
883
|
+
### devops.changes
|
|
884
|
+
|
|
885
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
886
|
+
|---|---|---|---|---|
|
|
887
|
+
| abandon | POST | `/devops/v1/changes/{id}:abandon` | no | no |
|
|
888
|
+
| markLastSlice | POST | `/devops/v1/changes/{id}:markLastSlice` | no | no |
|
|
889
|
+
| retrieve | GET | `/devops/v1/changes/{id}` | no | no |
|
|
890
|
+
|
|
891
|
+
### devops.environments.checkpoints
|
|
892
|
+
|
|
893
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
894
|
+
|---|---|---|---|---|
|
|
895
|
+
| list | GET | `/devops/v1/environments/{id}/checkpoints` | no | no |
|
|
896
|
+
|
|
897
|
+
### devops.flags
|
|
898
|
+
|
|
899
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
900
|
+
|---|---|---|---|---|
|
|
901
|
+
| archive | POST | `/devops/v1/flags/{id}:archive` | no | no |
|
|
902
|
+
| conclude | POST | `/devops/v1/flags/{id}:conclude` | no | no |
|
|
903
|
+
| retrieve | GET | `/devops/v1/flags/{id}` | no | no |
|
|
904
|
+
| update | PATCH | `/devops/v1/flags/{id}` | no | no |
|
|
905
|
+
|
|
906
|
+
### devops.flags.environments
|
|
907
|
+
|
|
908
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
909
|
+
|---|---|---|---|---|
|
|
910
|
+
| update | PATCH | `/devops/v1/flags/{id}/environments/{environment}` | no | no |
|
|
911
|
+
|
|
912
|
+
### devops.progressiveRollouts
|
|
913
|
+
|
|
914
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
915
|
+
|---|---|---|---|---|
|
|
916
|
+
| create | POST | `/devops/v1/progressive-rollouts` | no | no |
|
|
917
|
+
| pause | POST | `/devops/v1/progressive-rollouts/{id}:pause` | no | no |
|
|
918
|
+
| resume | POST | `/devops/v1/progressive-rollouts/{id}:resume` | no | no |
|
|
919
|
+
| retrieve | GET | `/devops/v1/progressive-rollouts/{id}` | no | no |
|
|
920
|
+
| rollback | POST | `/devops/v1/progressive-rollouts/{id}:rollback` | no | no |
|
|
921
|
+
|
|
922
|
+
### devops.projects
|
|
923
|
+
|
|
924
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
925
|
+
|---|---|---|---|---|
|
|
926
|
+
| list | GET | `/devops/v1/projects` | no | no |
|
|
927
|
+
| retrieve | GET | `/devops/v1/projects/{id}` | no | no |
|
|
928
|
+
| retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
|
|
929
|
+
|
|
930
|
+
### devops.projects.changes
|
|
931
|
+
|
|
932
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
933
|
+
|---|---|---|---|---|
|
|
934
|
+
| create | POST | `/devops/v1/projects/{project}/changes` | no | no |
|
|
935
|
+
| list | GET | `/devops/v1/projects/{project}/changes` | no | no |
|
|
936
|
+
|
|
937
|
+
### devops.projects.environments
|
|
938
|
+
|
|
939
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
940
|
+
|---|---|---|---|---|
|
|
941
|
+
| list | GET | `/devops/v1/projects/{project}/environments` | no | no |
|
|
942
|
+
|
|
943
|
+
### devops.projects.environments.targets
|
|
944
|
+
|
|
945
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
946
|
+
|---|---|---|---|---|
|
|
947
|
+
| deleteState | DELETE | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
948
|
+
| retrieveState | GET | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
949
|
+
|
|
950
|
+
### devops.projects.environments.targets.state
|
|
951
|
+
|
|
952
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
953
|
+
|---|---|---|---|---|
|
|
954
|
+
| create | POST | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state` | no | no |
|
|
955
|
+
| deleteLock | DELETE | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state/lock` | no | no |
|
|
956
|
+
|
|
957
|
+
### devops.projects.environments.targets.state.lock
|
|
958
|
+
|
|
959
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
960
|
+
|---|---|---|---|---|
|
|
961
|
+
| create | POST | `/devops/v1/projects/{project}/environments/{environment}/targets/{target}/state/lock` | no | no |
|
|
962
|
+
|
|
963
|
+
### devops.projects.flags
|
|
964
|
+
|
|
965
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
966
|
+
|---|---|---|---|---|
|
|
967
|
+
| create | POST | `/devops/v1/projects/{project}/flags` | no | no |
|
|
968
|
+
| list | GET | `/devops/v1/projects/{project}/flags` | no | no |
|
|
969
|
+
|
|
970
|
+
### devops.projects.promotions
|
|
971
|
+
|
|
972
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
973
|
+
|---|---|---|---|---|
|
|
974
|
+
| list | GET | `/devops/v1/projects/{project}/promotions` | no | no |
|
|
975
|
+
|
|
976
|
+
### devops.projects.releases
|
|
977
|
+
|
|
978
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
979
|
+
|---|---|---|---|---|
|
|
980
|
+
| create | POST | `/devops/v1/projects/{project}/releases` | no | no |
|
|
981
|
+
| list | GET | `/devops/v1/projects/{project}/releases` | no | no |
|
|
982
|
+
|
|
983
|
+
### devops.projects.targets
|
|
984
|
+
|
|
985
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
986
|
+
|---|---|---|---|---|
|
|
987
|
+
| list | GET | `/devops/v1/projects/{project}/targets` | no | no |
|
|
988
|
+
| refresh | POST | `/devops/v1/projects/{project}/targets:refresh` | no | no |
|
|
989
|
+
|
|
990
|
+
### devops.projects.testCases
|
|
991
|
+
|
|
992
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
993
|
+
|---|---|---|---|---|
|
|
994
|
+
| list | GET | `/devops/v1/projects/{project}/test-cases` | no | no |
|
|
995
|
+
|
|
996
|
+
### devops.projects.testPlans
|
|
997
|
+
|
|
998
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
999
|
+
|---|---|---|---|---|
|
|
1000
|
+
| create | POST | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
1001
|
+
| list | GET | `/devops/v1/projects/{project}/test-plans` | no | no |
|
|
1002
|
+
|
|
1003
|
+
### devops.projects.testReports
|
|
1004
|
+
|
|
1005
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1006
|
+
|---|---|---|---|---|
|
|
1007
|
+
| create | POST | `/devops/v1/projects/{project}/test-reports` | no | no |
|
|
1008
|
+
|
|
1009
|
+
### devops.projects.testRuns
|
|
1010
|
+
|
|
1011
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1012
|
+
|---|---|---|---|---|
|
|
1013
|
+
| create | POST | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
1014
|
+
| list | GET | `/devops/v1/projects/{project}/test-runs` | no | no |
|
|
1015
|
+
|
|
1016
|
+
### devops.projects.testSuites
|
|
1017
|
+
|
|
1018
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1019
|
+
|---|---|---|---|---|
|
|
1020
|
+
| list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
|
|
1021
|
+
|
|
1022
|
+
### devops.promotions
|
|
1023
|
+
|
|
1024
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1025
|
+
|---|---|---|---|---|
|
|
1026
|
+
| approve | POST | `/devops/v1/promotions/{id}:approve` | no | no |
|
|
1027
|
+
| cancel | POST | `/devops/v1/promotions/{id}:cancel` | no | no |
|
|
1028
|
+
| conclude | POST | `/devops/v1/promotions/{id}:conclude` | no | no |
|
|
1029
|
+
| create | POST | `/devops/v1/promotions` | no | no |
|
|
1030
|
+
| retrieve | GET | `/devops/v1/promotions/{id}` | no | no |
|
|
1031
|
+
| retry | POST | `/devops/v1/promotions/{id}:retry` | no | no |
|
|
1032
|
+
|
|
1033
|
+
### devops.promotions.rollouts
|
|
1034
|
+
|
|
1035
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1036
|
+
|---|---|---|---|---|
|
|
1037
|
+
| list | GET | `/devops/v1/promotions/{promotion}/rollouts` | no | no |
|
|
1038
|
+
|
|
1039
|
+
### devops.releases
|
|
1040
|
+
|
|
1041
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1042
|
+
|---|---|---|---|---|
|
|
1043
|
+
| abandon | POST | `/devops/v1/releases/{id}:abandon` | no | no |
|
|
1044
|
+
| retrieve | GET | `/devops/v1/releases/{id}` | no | no |
|
|
1045
|
+
|
|
1046
|
+
### devops.rollouts
|
|
1047
|
+
|
|
1048
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1049
|
+
|---|---|---|---|---|
|
|
1050
|
+
| retrieve | GET | `/devops/v1/rollouts/{id}` | no | no |
|
|
1051
|
+
|
|
1052
|
+
### devops.testCases
|
|
1053
|
+
|
|
1054
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1055
|
+
|---|---|---|---|---|
|
|
1056
|
+
| retrieve | GET | `/devops/v1/test-cases/{id}` | no | no |
|
|
1057
|
+
|
|
1058
|
+
### devops.testPlans
|
|
1059
|
+
|
|
1060
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1061
|
+
|---|---|---|---|---|
|
|
1062
|
+
| delete | DELETE | `/devops/v1/test-plans/{id}` | no | no |
|
|
1063
|
+
| pause | POST | `/devops/v1/test-plans/{id}:pause` | no | no |
|
|
1064
|
+
| resume | POST | `/devops/v1/test-plans/{id}:resume` | no | no |
|
|
1065
|
+
| retrieve | GET | `/devops/v1/test-plans/{id}` | no | no |
|
|
1066
|
+
| update | PATCH | `/devops/v1/test-plans/{id}` | no | no |
|
|
1067
|
+
|
|
1068
|
+
### devops.testRuns
|
|
1069
|
+
|
|
1070
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1071
|
+
|---|---|---|---|---|
|
|
1072
|
+
| cancel | POST | `/devops/v1/test-runs/{id}:cancel` | no | no |
|
|
1073
|
+
| retrieve | GET | `/devops/v1/test-runs/{id}` | no | no |
|
|
1074
|
+
|
|
1075
|
+
### devops.testRuns.executions
|
|
1076
|
+
|
|
1077
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1078
|
+
|---|---|---|---|---|
|
|
1079
|
+
| list | GET | `/devops/v1/test-runs/{run}/executions` | no | no |
|
|
1080
|
+
| retrieve | GET | `/devops/v1/test-runs/{run}/executions/{case}` | no | no |
|
|
1081
|
+
|
|
1082
|
+
### devops.testSuites
|
|
1083
|
+
|
|
1084
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1085
|
+
|---|---|---|---|---|
|
|
1086
|
+
| retrieve | GET | `/devops/v1/test-suites/{id}` | no | no |
|
|
1087
|
+
|
|
855
1088
|
## file
|
|
856
1089
|
|
|
857
1090
|
### file.files
|
|
@@ -968,12 +1201,25 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
968
1201
|
|
|
969
1202
|
## media
|
|
970
1203
|
|
|
1204
|
+
### media.assets
|
|
1205
|
+
|
|
1206
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1207
|
+
|---|---|---|---|---|
|
|
1208
|
+
| edit | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | no | no |
|
|
1209
|
+
| lineage | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | no | no |
|
|
1210
|
+
|
|
971
1211
|
### media.generation.capabilities
|
|
972
1212
|
|
|
973
1213
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
974
1214
|
|---|---|---|---|---|
|
|
975
1215
|
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
976
1216
|
|
|
1217
|
+
### media.images
|
|
1218
|
+
|
|
1219
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1220
|
+
|---|---|---|---|---|
|
|
1221
|
+
| generate | POST | `/media/v1/libraries/{library_id}/images/generations` | no | no |
|
|
1222
|
+
|
|
977
1223
|
### media.libraries
|
|
978
1224
|
|
|
979
1225
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -983,6 +1229,8 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
983
1229
|
| list | GET | `/media/v1/libraries` | no | yes |
|
|
984
1230
|
| restore | POST | `/media/v1/libraries/{library_id}/restore` | no | no |
|
|
985
1231
|
| retrieve | GET | `/media/v1/libraries/{library_id}` | no | no |
|
|
1232
|
+
| retrieveDefault | GET | `/media/v1/libraries/default` | no | no |
|
|
1233
|
+
| setDefault | PUT | `/media/v1/libraries/default` | no | no |
|
|
986
1234
|
| update | PATCH | `/media/v1/libraries/{library_id}` | no | no |
|
|
987
1235
|
|
|
988
1236
|
### media.libraries.assets
|
|
@@ -1045,12 +1293,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1045
1293
|
|---|---|---|---|---|
|
|
1046
1294
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
1047
1295
|
|
|
1048
|
-
### media.libraries.generations
|
|
1049
|
-
|
|
1050
|
-
| Method | HTTP | Path | Streaming | Pagination |
|
|
1051
|
-
|---|---|---|---|---|
|
|
1052
|
-
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1053
|
-
|
|
1054
1296
|
### media.libraries.jobs
|
|
1055
1297
|
|
|
1056
1298
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1059,12 +1301,6 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1059
1301
|
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
1060
1302
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
1061
1303
|
|
|
1062
|
-
### media.libraries.jobs.outputs.save
|
|
1063
|
-
|
|
1064
|
-
| Method | HTTP | Path | Streaming | Pagination |
|
|
1065
|
-
|---|---|---|---|---|
|
|
1066
|
-
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1067
|
-
|
|
1068
1304
|
### media.libraries.purge
|
|
1069
1305
|
|
|
1070
1306
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1102,6 +1338,18 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1102
1338
|
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1103
1339
|
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1104
1340
|
|
|
1341
|
+
### media.speech
|
|
1342
|
+
|
|
1343
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1344
|
+
|---|---|---|---|---|
|
|
1345
|
+
| create | POST | `/media/v1/libraries/{library_id}/audio/speech` | no | no |
|
|
1346
|
+
|
|
1347
|
+
### media.videos
|
|
1348
|
+
|
|
1349
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1350
|
+
|---|---|---|---|---|
|
|
1351
|
+
| generate | POST | `/media/v1/libraries/{library_id}/videos/generations` | no | no |
|
|
1352
|
+
|
|
1105
1353
|
## meta
|
|
1106
1354
|
|
|
1107
1355
|
### meta.docs
|
|
@@ -1251,6 +1499,58 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1251
1499
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
1252
1500
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
1253
1501
|
|
|
1502
|
+
## ontology
|
|
1503
|
+
|
|
1504
|
+
### ontology.changesets
|
|
1505
|
+
|
|
1506
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1507
|
+
|---|---|---|---|---|
|
|
1508
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1509
|
+
|
|
1510
|
+
### ontology.nodes
|
|
1511
|
+
|
|
1512
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1513
|
+
|---|---|---|---|---|
|
|
1514
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1515
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1516
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1517
|
+
| retrieveNeighborhood | GET | `/ontology/v1/nodes/{node_id}/neighborhood` | no | no |
|
|
1518
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1519
|
+
|
|
1520
|
+
### ontology.nodes.merge
|
|
1521
|
+
|
|
1522
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1523
|
+
|---|---|---|---|---|
|
|
1524
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1525
|
+
|
|
1526
|
+
### ontology.relations
|
|
1527
|
+
|
|
1528
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1529
|
+
|---|---|---|---|---|
|
|
1530
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1531
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1532
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1533
|
+
|
|
1534
|
+
### ontology.relations.invalidate
|
|
1535
|
+
|
|
1536
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1537
|
+
|---|---|---|---|---|
|
|
1538
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1539
|
+
|
|
1540
|
+
### ontology.search
|
|
1541
|
+
|
|
1542
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1543
|
+
|---|---|---|---|---|
|
|
1544
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1545
|
+
|
|
1546
|
+
### ontology.types
|
|
1547
|
+
|
|
1548
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1549
|
+
|---|---|---|---|---|
|
|
1550
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1551
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1552
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1553
|
+
|
|
1254
1554
|
## organization
|
|
1255
1555
|
|
|
1256
1556
|
### organization.charges
|
|
@@ -1307,6 +1607,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1307
1607
|
|
|
1308
1608
|
## sandbox
|
|
1309
1609
|
|
|
1610
|
+
### sandbox.events.sandboxes
|
|
1611
|
+
|
|
1612
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1613
|
+
|---|---|---|---|---|
|
|
1614
|
+
| retrieve | GET | `/sandbox/v1/events/sandboxes/{sandboxID}` | no | no |
|
|
1615
|
+
|
|
1310
1616
|
### sandbox.sandboxes
|
|
1311
1617
|
|
|
1312
1618
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1447,6 +1753,167 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1447
1753
|
|---|---|---|---|---|
|
|
1448
1754
|
| create | POST | `/search/v1/search` | no | no |
|
|
1449
1755
|
|
|
1756
|
+
## studio
|
|
1757
|
+
|
|
1758
|
+
### studio.codexes
|
|
1759
|
+
|
|
1760
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1761
|
+
|---|---|---|---|---|
|
|
1762
|
+
| create | POST | `/studio/v1/codexes` | no | no |
|
|
1763
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}` | no | no |
|
|
1764
|
+
| list | GET | `/studio/v1/codexes` | no | no |
|
|
1765
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}` | no | no |
|
|
1766
|
+
| update | PATCH | `/studio/v1/codexes/{codex}` | no | no |
|
|
1767
|
+
|
|
1768
|
+
### studio.codexes.entries
|
|
1769
|
+
|
|
1770
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1771
|
+
|---|---|---|---|---|
|
|
1772
|
+
| create | POST | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1773
|
+
| delete | DELETE | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1774
|
+
| list | GET | `/studio/v1/codexes/{codex}/entries` | no | no |
|
|
1775
|
+
| retrieve | GET | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1776
|
+
| update | PATCH | `/studio/v1/codexes/{codex}/entries/{entry}` | no | no |
|
|
1777
|
+
|
|
1778
|
+
### studio.genres
|
|
1779
|
+
|
|
1780
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1781
|
+
|---|---|---|---|---|
|
|
1782
|
+
| list | GET | `/studio/v1/genres` | no | no |
|
|
1783
|
+
| retrieve | GET | `/studio/v1/genres/{genre}` | no | no |
|
|
1784
|
+
|
|
1785
|
+
### studio.platforms
|
|
1786
|
+
|
|
1787
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1788
|
+
|---|---|---|---|---|
|
|
1789
|
+
| list | GET | `/studio/v1/platforms` | no | no |
|
|
1790
|
+
| retrieve | GET | `/studio/v1/platforms/{platform}` | no | no |
|
|
1791
|
+
|
|
1792
|
+
### studio.styles
|
|
1793
|
+
|
|
1794
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1795
|
+
|---|---|---|---|---|
|
|
1796
|
+
| create | POST | `/studio/v1/styles` | no | no |
|
|
1797
|
+
| delete | DELETE | `/studio/v1/styles/{style}` | no | no |
|
|
1798
|
+
| list | GET | `/studio/v1/styles` | no | no |
|
|
1799
|
+
| retrieve | GET | `/studio/v1/styles/{style}` | no | no |
|
|
1800
|
+
| update | PATCH | `/studio/v1/styles/{style}` | no | no |
|
|
1801
|
+
|
|
1802
|
+
### studio.templates
|
|
1803
|
+
|
|
1804
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1805
|
+
|---|---|---|---|---|
|
|
1806
|
+
| create | POST | `/studio/v1/templates` | no | no |
|
|
1807
|
+
| delete | DELETE | `/studio/v1/templates/{template}` | no | no |
|
|
1808
|
+
| list | GET | `/studio/v1/templates` | no | no |
|
|
1809
|
+
| retrieve | GET | `/studio/v1/templates/{template}` | no | no |
|
|
1810
|
+
|
|
1811
|
+
### studio.themes
|
|
1812
|
+
|
|
1813
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1814
|
+
|---|---|---|---|---|
|
|
1815
|
+
| create | POST | `/studio/v1/themes` | no | no |
|
|
1816
|
+
| delete | DELETE | `/studio/v1/themes/{theme}` | no | no |
|
|
1817
|
+
| list | GET | `/studio/v1/themes` | no | no |
|
|
1818
|
+
| retrieve | GET | `/studio/v1/themes/{theme}` | no | no |
|
|
1819
|
+
| update | PATCH | `/studio/v1/themes/{theme}` | no | no |
|
|
1820
|
+
|
|
1821
|
+
### studio.works
|
|
1822
|
+
|
|
1823
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1824
|
+
|---|---|---|---|---|
|
|
1825
|
+
| create | POST | `/studio/v1/works` | no | no |
|
|
1826
|
+
| list | GET | `/studio/v1/works` | no | no |
|
|
1827
|
+
| resolve | GET | `/studio/v1/works:resolve` | no | no |
|
|
1828
|
+
| retrieve | GET | `/studio/v1/works/{work}` | no | no |
|
|
1829
|
+
| update | PATCH | `/studio/v1/works/{work}` | no | no |
|
|
1830
|
+
|
|
1831
|
+
### studio.works.drafts
|
|
1832
|
+
|
|
1833
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1834
|
+
|---|---|---|---|---|
|
|
1835
|
+
| create | POST | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1836
|
+
| list | GET | `/studio/v1/works/{work}/drafts` | no | no |
|
|
1837
|
+
| rebase | POST | `/studio/v1/works/{work}/drafts/{draft}:rebase` | no | no |
|
|
1838
|
+
| retrieve | GET | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1839
|
+
| retrieveExport | GET | `/studio/v1/works/{work}/drafts/{draft}/export` | no | no |
|
|
1840
|
+
| retrieveOutline | GET | `/studio/v1/works/{work}/drafts/{draft}/outline` | no | no |
|
|
1841
|
+
| retrieveReview | GET | `/studio/v1/works/{work}/drafts/{draft}/review` | no | no |
|
|
1842
|
+
| update | PATCH | `/studio/v1/works/{work}/drafts/{draft}` | no | no |
|
|
1843
|
+
| updateBrief | PATCH | `/studio/v1/works/{work}/drafts/{draft}/brief` | no | no |
|
|
1844
|
+
|
|
1845
|
+
### studio.works.drafts.renditions
|
|
1846
|
+
|
|
1847
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1848
|
+
|---|---|---|---|---|
|
|
1849
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/renditions` | no | no |
|
|
1850
|
+
|
|
1851
|
+
### studio.works.drafts.status
|
|
1852
|
+
|
|
1853
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1854
|
+
|---|---|---|---|---|
|
|
1855
|
+
| list | GET | `/studio/v1/works/{work}/drafts/{draft}/status` | no | no |
|
|
1856
|
+
|
|
1857
|
+
### studio.works.drafts.units
|
|
1858
|
+
|
|
1859
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1860
|
+
|---|---|---|---|---|
|
|
1861
|
+
| batchCreate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchCreate` | no | no |
|
|
1862
|
+
| batchUpdate | POST | `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | no | no |
|
|
1863
|
+
| create | POST | `/studio/v1/works/{work}/drafts/{draft}/units` | no | no |
|
|
1864
|
+
|
|
1865
|
+
### studio.works.renditions
|
|
1866
|
+
|
|
1867
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1868
|
+
|---|---|---|---|---|
|
|
1869
|
+
| delete | DELETE | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1870
|
+
| list | GET | `/studio/v1/works/{work}/renditions` | no | no |
|
|
1871
|
+
| publish | POST | `/studio/v1/works/{work}/renditions/{rendition}:publish` | no | no |
|
|
1872
|
+
| render | POST | `/studio/v1/works/{work}/renditions/{rendition}:render` | no | no |
|
|
1873
|
+
| retrieve | GET | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1874
|
+
| retrieveContent | GET | `/studio/v1/works/{work}/renditions/{rendition}/content` | no | no |
|
|
1875
|
+
| update | PATCH | `/studio/v1/works/{work}/renditions/{rendition}` | no | no |
|
|
1876
|
+
|
|
1877
|
+
### studio.works.reviewSettings
|
|
1878
|
+
|
|
1879
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1880
|
+
|---|---|---|---|---|
|
|
1881
|
+
| retrieve | GET | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1882
|
+
| update | PATCH | `/studio/v1/works/{work}/review-settings` | no | no |
|
|
1883
|
+
|
|
1884
|
+
### studio.works.reviewers
|
|
1885
|
+
|
|
1886
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1887
|
+
|---|---|---|---|---|
|
|
1888
|
+
| create | POST | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1889
|
+
| delete | DELETE | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1890
|
+
| list | GET | `/studio/v1/works/{work}/reviewers` | no | no |
|
|
1891
|
+
| update | PATCH | `/studio/v1/works/{work}/reviewers/{agent}` | no | no |
|
|
1892
|
+
|
|
1893
|
+
### studio.works.reviews
|
|
1894
|
+
|
|
1895
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1896
|
+
|---|---|---|---|---|
|
|
1897
|
+
| cancel | POST | `/studio/v1/works/{work}/reviews/{review}:cancel` | no | no |
|
|
1898
|
+
| create | POST | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1899
|
+
| list | GET | `/studio/v1/works/{work}/reviews` | no | no |
|
|
1900
|
+
| retrieve | GET | `/studio/v1/works/{work}/reviews/{review}` | no | no |
|
|
1901
|
+
|
|
1902
|
+
### studio.works.units
|
|
1903
|
+
|
|
1904
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1905
|
+
|---|---|---|---|---|
|
|
1906
|
+
| move | POST | `/studio/v1/works/{work}/units/{unit}:move` | no | no |
|
|
1907
|
+
| retrieve | GET | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1908
|
+
| retrieveContext | GET | `/studio/v1/works/{work}/units/{unit}/context` | no | no |
|
|
1909
|
+
| update | PATCH | `/studio/v1/works/{work}/units/{unit}` | no | no |
|
|
1910
|
+
|
|
1911
|
+
### studio.works.units.blocks
|
|
1912
|
+
|
|
1913
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1914
|
+
|---|---|---|---|---|
|
|
1915
|
+
| patch | POST | `/studio/v1/works/{work}/units/{unit}/blocks:patch` | no | no |
|
|
1916
|
+
|
|
1450
1917
|
## ticket
|
|
1451
1918
|
|
|
1452
1919
|
### ticket.activity
|
|
@@ -1495,6 +1962,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1495
1962
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1496
1963
|
|---|---|---|---|---|
|
|
1497
1964
|
| list | GET | `/ticket/v1/repositories` | no | no |
|
|
1965
|
+
| update | PATCH | `/ticket/v1/repositories/{id}` | no | no |
|
|
1498
1966
|
|
|
1499
1967
|
### ticket.tickets
|
|
1500
1968
|
|
|
@@ -1686,11 +2154,19 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1686
2154
|
| crm.properties.archive | CRM DELETE archives the resource rather than permanently deleting it; expose the archive product verb. |
|
|
1687
2155
|
| database.databases.rest.create | The final parameter identifies a table collection; POST inserts rows rather than updating the table. |
|
|
1688
2156
|
| file.uploads.createSigned | Signed upload creation returns a one-time local PUT URL; ADR-039 names this operation uploads.createSigned. |
|
|
2157
|
+
| media.libraries.retrieveDefault | ADR-094 §9 names the default-library read libraries.retrieveDefault; the URL names a reference rather than an id, so the path-derived name would otherwise read as retrieving a library called default. |
|
|
2158
|
+
| media.libraries.setDefault | ADR-094 §9 names the default-library write libraries.setDefault; the URL has no library id because the organization owns one default library, so the path alone cannot say which. |
|
|
2159
|
+
| media.assets.edit | ADR-094 §9 names the edit write assets.edit; an edit acts on the addressed asset and returns a Job, so the URL nesting under a library is a mount rather than an SDK resource level. |
|
|
2160
|
+
| media.assets.lineage | ADR-094 §9 names the edit-tree read assets.lineage; lineage is the product verb and the URL nesting under a library is a mount, not an SDK resource level. |
|
|
2161
|
+
| media.speech.create | ADR-094 §1/§9 names speech synthesis speech.create; the URL says audio/speech because that is the artifact the caller gets back, and the path alone would derive a speech collection create under an audio level that is not an SDK resource. |
|
|
2162
|
+
| media.images.generate | ADR-094 §9 names image generation images.generate; the URL mounts it under a library, but generation is an operation on images and the path alone would derive a generations collection create. |
|
|
2163
|
+
| media.videos.generate | ADR-094 §2/§9 names video generation videos.generate beside images.generate; the URL mounts it under a library, but generation is an operation on videos and the path alone would derive a generations collection create. The unqualified videos resource is the video lane, distinct from the batch and legacy job resources. |
|
|
1689
2164
|
| meta.docs.search | Documentation keyword search is an operation on docs, not a nested collection. |
|
|
1690
2165
|
| sandbox.sandboxes.commands.run | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1691
2166
|
| sandbox.sandboxes.files.remove | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1692
2167
|
| sandbox.sandboxes.files.read | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
1693
2168
|
| sandbox.sandboxes.files.write | Sandbox data operations use the E2B SDK verb while preserving URL resource nesting. |
|
|
2169
|
+
| studio.works.reviewSettings.retrieve | A work has one review-settings singleton; the segment ends in s only because English writes it that way, so the collection rule would derive reviewSettings.list for a read that returns the settings object itself. |
|
|
1694
2170
|
| vault.oauth.retrieveClientMetadata | The literal .json filename otherwise introduces a dot inside a method identifier. |
|
|
1695
2171
|
|
|
1696
2172
|
## SDK parameter aliases
|
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Models, agents, sandboxes, search, data and automation, typed end to end.**
|
|
6
6
|
|
|
7
|
-
The official TypeScript SDK for [
|
|
7
|
+
The official TypeScript SDK for [Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
|
|
8
8
|
|
|
9
9
|
[](https://www.npmjs.com/package/@deepraxis/sdk)
|
|
10
10
|
[](https://bundlephobia.com/package/@deepraxis/sdk)
|
|
@@ -33,7 +33,7 @@ console.log(completion.choices[0]?.message.content);
|
|
|
33
33
|
## Why this SDK
|
|
34
34
|
|
|
35
35
|
- **The whole platform, one client.** About 350 operations across models, agents, sandboxes,
|
|
36
|
-
|
|
36
|
+
browsers, web search, databases, knowledge bases, files, media, automation and hosted
|
|
37
37
|
applications, generated from the same contract as the API.
|
|
38
38
|
- **Types from the contract.** Every path, query, body and response is typed, including the
|
|
39
39
|
events of each stream, so your editor knows what comes back.
|
|
@@ -122,7 +122,7 @@ conversation with it, on its own machine.
|
|
|
122
122
|
```ts
|
|
123
123
|
const { sandboxes } = praxis.sandbox;
|
|
124
124
|
const sandbox = await sandboxes.create({
|
|
125
|
-
body: { templateID: 'base' },
|
|
125
|
+
body: { templateID: 'base', autoPause: false }, // ends at its timeout; autoPause: true keeps a long-lived computer
|
|
126
126
|
});
|
|
127
127
|
const result = await sandboxes.commands.run({
|
|
128
128
|
path: { sandbox_id: sandbox.sandboxID },
|
|
@@ -276,5 +276,5 @@ sandboxes, search, data, automation and the rest of the platform.
|
|
|
276
276
|
|
|
277
277
|
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). Copyright 2026 南京深度实践人工智能科技有限公司 (Deepractice).
|
|
278
278
|
|
|
279
|
-
"Praxis"
|
|
279
|
+
"Praxis" and "Deepraxis" are trademarks of Deepractice; the license does not grant
|
|
280
280
|
rights to use them.
|