@deepraxis/sdk 0.1.1-dev.ea9c801 → 0.1.1-dev.eaacee7

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  # SDK methods
2
2
 
3
- Generated by `bun run generate`. 522 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`.
3
+ Generated by `bun run generate`. 567 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 |
@@ -786,6 +792,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
786
792
  |---|---|---|---|---|
787
793
  | import | POST | `/cut/v1/projects/{project_id}/media:import` | no | no |
788
794
 
795
+ ### cut.projects.renders
796
+
797
+ | Method | HTTP | Path | Streaming | Pagination |
798
+ |---|---|---|---|---|
799
+ | create | POST | `/cut/v1/projects/{project_id}/renders` | no | no |
800
+
789
801
  ### cut.projects.versions
790
802
 
791
803
  | Method | HTTP | Path | Streaming | Pagination |
@@ -793,6 +805,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
793
805
  | create | POST | `/cut/v1/projects/{project_id}/versions` | no | no |
794
806
  | list | GET | `/cut/v1/projects/{project_id}/versions` | no | no |
795
807
 
808
+ ### cut.renders
809
+
810
+ | Method | HTTP | Path | Streaming | Pagination |
811
+ |---|---|---|---|---|
812
+ | retrieve | GET | `/cut/v1/renders/{render_id}` | no | no |
813
+
796
814
  ### cut.versions
797
815
 
798
816
  | Method | HTTP | Path | Streaming | Pagination |
@@ -852,6 +870,82 @@ Multipart request bodies expand plain objects into bracketed fields (for example
852
870
  | delete | DELETE | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
853
871
  | update | PATCH | `/database/v1/databases/{database_id}/tables/{table}/fields/{field}` | no | no |
854
872
 
873
+ ## devops
874
+
875
+ ### devops.projects
876
+
877
+ | Method | HTTP | Path | Streaming | Pagination |
878
+ |---|---|---|---|---|
879
+ | retrieveTestCatalog | GET | `/devops/v1/projects/{project}/test-catalog` | no | no |
880
+
881
+ ### devops.projects.testCases
882
+
883
+ | Method | HTTP | Path | Streaming | Pagination |
884
+ |---|---|---|---|---|
885
+ | list | GET | `/devops/v1/projects/{project}/test-cases` | no | no |
886
+
887
+ ### devops.projects.testPlans
888
+
889
+ | Method | HTTP | Path | Streaming | Pagination |
890
+ |---|---|---|---|---|
891
+ | create | POST | `/devops/v1/projects/{project}/test-plans` | no | no |
892
+ | list | GET | `/devops/v1/projects/{project}/test-plans` | no | no |
893
+
894
+ ### devops.projects.testReports
895
+
896
+ | Method | HTTP | Path | Streaming | Pagination |
897
+ |---|---|---|---|---|
898
+ | create | POST | `/devops/v1/projects/{project}/test-reports` | no | no |
899
+
900
+ ### devops.projects.testRuns
901
+
902
+ | Method | HTTP | Path | Streaming | Pagination |
903
+ |---|---|---|---|---|
904
+ | create | POST | `/devops/v1/projects/{project}/test-runs` | no | no |
905
+ | list | GET | `/devops/v1/projects/{project}/test-runs` | no | no |
906
+
907
+ ### devops.projects.testSuites
908
+
909
+ | Method | HTTP | Path | Streaming | Pagination |
910
+ |---|---|---|---|---|
911
+ | list | GET | `/devops/v1/projects/{project}/test-suites` | no | no |
912
+
913
+ ### devops.testCases
914
+
915
+ | Method | HTTP | Path | Streaming | Pagination |
916
+ |---|---|---|---|---|
917
+ | retrieve | GET | `/devops/v1/test-cases/{id}` | no | no |
918
+
919
+ ### devops.testPlans
920
+
921
+ | Method | HTTP | Path | Streaming | Pagination |
922
+ |---|---|---|---|---|
923
+ | delete | DELETE | `/devops/v1/test-plans/{id}` | no | no |
924
+ | pause | POST | `/devops/v1/test-plans/{id}:pause` | no | no |
925
+ | resume | POST | `/devops/v1/test-plans/{id}:resume` | no | no |
926
+ | retrieve | GET | `/devops/v1/test-plans/{id}` | no | no |
927
+ | update | PATCH | `/devops/v1/test-plans/{id}` | no | no |
928
+
929
+ ### devops.testRuns
930
+
931
+ | Method | HTTP | Path | Streaming | Pagination |
932
+ |---|---|---|---|---|
933
+ | cancel | POST | `/devops/v1/test-runs/{id}:cancel` | no | no |
934
+ | retrieve | GET | `/devops/v1/test-runs/{id}` | no | no |
935
+
936
+ ### devops.testRuns.executions
937
+
938
+ | Method | HTTP | Path | Streaming | Pagination |
939
+ |---|---|---|---|---|
940
+ | list | GET | `/devops/v1/test-runs/{run}/executions` | no | no |
941
+ | retrieve | GET | `/devops/v1/test-runs/{run}/executions/{case}` | no | no |
942
+
943
+ ### devops.testSuites
944
+
945
+ | Method | HTTP | Path | Streaming | Pagination |
946
+ |---|---|---|---|---|
947
+ | retrieve | GET | `/devops/v1/test-suites/{id}` | no | no |
948
+
855
949
  ## file
856
950
 
857
951
  ### file.files
@@ -884,6 +978,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
884
978
  | complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
885
979
  | create | POST | `/file/v1/uploads` | no | no |
886
980
  | createSigned | POST | `/file/v1/uploads/signed` | no | no |
981
+ | retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
887
982
 
888
983
  ### file.uploads.parts
889
984
 
@@ -967,6 +1062,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
967
1062
 
968
1063
  ## media
969
1064
 
1065
+ ### media.generation.capabilities
1066
+
1067
+ | Method | HTTP | Path | Streaming | Pagination |
1068
+ |---|---|---|---|---|
1069
+ | list | GET | `/media/v1/generation/capabilities` | no | no |
1070
+
970
1071
  ### media.libraries
971
1072
 
972
1073
  | Method | HTTP | Path | Streaming | Pagination |
@@ -989,6 +1090,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
989
1090
  | retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
990
1091
  | update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
991
1092
 
1093
+ ### media.libraries.assets.frames
1094
+
1095
+ | Method | HTTP | Path | Streaming | Pagination |
1096
+ |---|---|---|---|---|
1097
+ | create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
1098
+
992
1099
  ### media.libraries.assets.import
993
1100
 
994
1101
  | Method | HTTP | Path | Streaming | Pagination |
@@ -1032,12 +1139,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1032
1139
  |---|---|---|---|---|
1033
1140
  | list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
1034
1141
 
1142
+ ### media.libraries.generations
1143
+
1144
+ | Method | HTTP | Path | Streaming | Pagination |
1145
+ |---|---|---|---|---|
1146
+ | create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
1147
+
1035
1148
  ### media.libraries.jobs
1036
1149
 
1037
1150
  | Method | HTTP | Path | Streaming | Pagination |
1038
1151
  |---|---|---|---|---|
1152
+ | cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
1153
+ | list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
1039
1154
  | retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
1040
1155
 
1156
+ ### media.libraries.jobs.outputs.save
1157
+
1158
+ | Method | HTTP | Path | Streaming | Pagination |
1159
+ |---|---|---|---|---|
1160
+ | create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
1161
+
1041
1162
  ### media.libraries.purge
1042
1163
 
1043
1164
  | Method | HTTP | Path | Streaming | Pagination |
@@ -1068,6 +1189,13 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1068
1189
  |---|---|---|---|---|
1069
1190
  | create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
1070
1191
 
1192
+ ### media.libraries.understandings
1193
+
1194
+ | Method | HTTP | Path | Streaming | Pagination |
1195
+ |---|---|---|---|---|
1196
+ | list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
1197
+ | retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
1198
+
1071
1199
  ## meta
1072
1200
 
1073
1201
  ### meta.docs
@@ -1217,6 +1345,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
1217
1345
  | retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
1218
1346
  | retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
1219
1347
 
1348
+ ## ontology
1349
+
1350
+ ### ontology.changesets
1351
+
1352
+ | Method | HTTP | Path | Streaming | Pagination |
1353
+ |---|---|---|---|---|
1354
+ | create | POST | `/ontology/v1/changesets` | no | no |
1355
+
1356
+ ### ontology.nodes
1357
+
1358
+ | Method | HTTP | Path | Streaming | Pagination |
1359
+ |---|---|---|---|---|
1360
+ | create | POST | `/ontology/v1/nodes` | no | no |
1361
+ | list | GET | `/ontology/v1/nodes` | no | yes |
1362
+ | retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
1363
+ | update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
1364
+
1365
+ ### ontology.nodes.merge
1366
+
1367
+ | Method | HTTP | Path | Streaming | Pagination |
1368
+ |---|---|---|---|---|
1369
+ | create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
1370
+
1371
+ ### ontology.relations
1372
+
1373
+ | Method | HTTP | Path | Streaming | Pagination |
1374
+ |---|---|---|---|---|
1375
+ | create | POST | `/ontology/v1/relations` | no | no |
1376
+ | list | GET | `/ontology/v1/relations` | no | yes |
1377
+ | retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
1378
+
1379
+ ### ontology.relations.invalidate
1380
+
1381
+ | Method | HTTP | Path | Streaming | Pagination |
1382
+ |---|---|---|---|---|
1383
+ | create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
1384
+
1385
+ ### ontology.search
1386
+
1387
+ | Method | HTTP | Path | Streaming | Pagination |
1388
+ |---|---|---|---|---|
1389
+ | create | POST | `/ontology/v1/search` | no | no |
1390
+
1391
+ ### ontology.types
1392
+
1393
+ | Method | HTTP | Path | Streaming | Pagination |
1394
+ |---|---|---|---|---|
1395
+ | create | POST | `/ontology/v1/types` | no | no |
1396
+ | list | GET | `/ontology/v1/types` | no | no |
1397
+ | retrieve | GET | `/ontology/v1/types/{name}` | no | no |
1398
+
1220
1399
  ## organization
1221
1400
 
1222
1401
  ### organization.charges
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 [知行云 Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
7
+ The official TypeScript SDK for [Praxis](https://deepraxis.com), the cloud where AI agents are built, run and hosted.
8
8
 
9
9
  [![npm](https://img.shields.io/npm/v/@deepraxis/sdk?label=npm&color=2e8555)](https://www.npmjs.com/package/@deepraxis/sdk)
10
10
  [![Bundle size](https://img.shields.io/bundlephobia/minzip/@deepraxis/sdk?color=2e8555)](https://bundlephobia.com/package/@deepraxis/sdk)
@@ -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", "知行云" and "Deepraxis" are trademarks of Deepractice; the license does not grant
279
+ "Praxis" and "Deepraxis" are trademarks of Deepractice; the license does not grant
280
280
  rights to use them.
@@ -9,6 +9,9 @@ export interface ProblemDetails {
9
9
  requestId?: string;
10
10
  message?: string;
11
11
  param?: string | null;
12
+ /** ticket-681 — the documentation page the failure points at, and the exact section to read. */
13
+ docUrl?: string;
14
+ describe?: string;
12
15
  raw?: unknown;
13
16
  }
14
17
  /** Pure normalization shared by HTTP clients and the automation call ledger.
@@ -26,6 +29,9 @@ export declare class PraxisError extends Error {
26
29
  readonly errors: unknown[];
27
30
  readonly requestId?: string;
28
31
  readonly param?: string | null;
32
+ /** ticket-681 — the documented page and the exact section an agent should read to fix the call. */
33
+ readonly docUrl?: string;
34
+ readonly describe?: string;
29
35
  readonly raw?: unknown;
30
36
  constructor(problem?: ProblemDetails, options?: ErrorOptions);
31
37
  static fromResponse(response: Response, body: unknown): PraxisError;
@@ -16,6 +16,9 @@ export function problemFrom(status, headers, body, statusText) {
16
16
  param: typeof param === 'string' ? param : param === null || nested.param === null ? null : undefined,
17
17
  errors: Array.isArray(value.errors) ? value.errors : [],
18
18
  requestId: headers.get('x-request-id') ?? string(value.requestId) ?? string(value.request_id),
19
+ // Both spellings reach here: the own face writes snake_case, an in-process problem keeps docUrl.
20
+ docUrl: string(nested.doc_url) ?? string(value.doc_url) ?? string(nested.docUrl) ?? string(value.docUrl),
21
+ describe: string(nested.describe) ?? string(value.describe),
19
22
  raw: body,
20
23
  };
21
24
  }
@@ -28,6 +31,9 @@ export class PraxisError extends Error {
28
31
  errors;
29
32
  requestId;
30
33
  param;
34
+ /** ticket-681 — the documented page and the exact section an agent should read to fix the call. */
35
+ docUrl;
36
+ describe;
31
37
  raw;
32
38
  constructor(problem = {}, options) {
33
39
  super(problem.message ?? problem.detail ?? problem.title ?? `Praxis request failed${problem.status ? ` (${problem.status})` : ''}`, options);
@@ -40,6 +46,8 @@ export class PraxisError extends Error {
40
46
  this.errors = problem.errors ?? [];
41
47
  this.requestId = problem.requestId;
42
48
  this.param = problem.param;
49
+ this.docUrl = problem.docUrl;
50
+ this.describe = problem.describe;
43
51
  this.raw = problem.raw;
44
52
  }
45
53
  static fromResponse(response, body) {