@deepraxis/sdk 0.1.1-dev.e5614a0 → 0.1.1-dev.e5cbcae
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 +98 -1
- package/README.md +2 -2
- package/dist/core/errors.d.ts +6 -0
- package/dist/core/errors.js +8 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +344 -47
- package/dist/generated/sdk.gen.js +599 -46
- package/dist/generated/types.gen.d.ts +5980 -1753
- package/dist/operations.generated.d.ts +897 -88
- package/dist/operations.generated.js +1361 -363
- package/dist/resources.generated.d.ts +96 -8
- package/dist/resources.generated.js +62 -0
- 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`. 546 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 |
|
|
@@ -884,6 +890,7 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
884
890
|
| complete | POST | `/file/v1/uploads/{upload_id}/complete` | no | no |
|
|
885
891
|
| create | POST | `/file/v1/uploads` | no | no |
|
|
886
892
|
| createSigned | POST | `/file/v1/uploads/signed` | no | no |
|
|
893
|
+
| retrieve | GET | `/file/v1/uploads/{upload_id}` | no | no |
|
|
887
894
|
|
|
888
895
|
### file.uploads.parts
|
|
889
896
|
|
|
@@ -967,6 +974,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
967
974
|
|
|
968
975
|
## media
|
|
969
976
|
|
|
977
|
+
### media.generation.capabilities
|
|
978
|
+
|
|
979
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
980
|
+
|---|---|---|---|---|
|
|
981
|
+
| list | GET | `/media/v1/generation/capabilities` | no | no |
|
|
982
|
+
|
|
970
983
|
### media.libraries
|
|
971
984
|
|
|
972
985
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -989,6 +1002,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
989
1002
|
| retrieve | GET | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
990
1003
|
| update | PATCH | `/media/v1/libraries/{library_id}/assets/{asset_id}` | no | no |
|
|
991
1004
|
|
|
1005
|
+
### media.libraries.assets.frames
|
|
1006
|
+
|
|
1007
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1008
|
+
|---|---|---|---|---|
|
|
1009
|
+
| create | POST | `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | no | no |
|
|
1010
|
+
|
|
992
1011
|
### media.libraries.assets.import
|
|
993
1012
|
|
|
994
1013
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1032,12 +1051,26 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1032
1051
|
|---|---|---|---|---|
|
|
1033
1052
|
| list | GET | `/media/v1/libraries/{library_id}/folders` | no | no |
|
|
1034
1053
|
|
|
1054
|
+
### media.libraries.generations
|
|
1055
|
+
|
|
1056
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1057
|
+
|---|---|---|---|---|
|
|
1058
|
+
| create | POST | `/media/v1/libraries/{library_id}/generations` | no | no |
|
|
1059
|
+
|
|
1035
1060
|
### media.libraries.jobs
|
|
1036
1061
|
|
|
1037
1062
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
1038
1063
|
|---|---|---|---|---|
|
|
1064
|
+
| cancel | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | no | no |
|
|
1065
|
+
| list | GET | `/media/v1/libraries/{library_id}/jobs` | no | yes |
|
|
1039
1066
|
| retrieve | GET | `/media/v1/libraries/{library_id}/jobs/{job_id}` | no | no |
|
|
1040
1067
|
|
|
1068
|
+
### media.libraries.jobs.outputs.save
|
|
1069
|
+
|
|
1070
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1071
|
+
|---|---|---|---|---|
|
|
1072
|
+
| create | POST | `/media/v1/libraries/{library_id}/jobs/{job_id}/outputs/{index}/save` | no | no |
|
|
1073
|
+
|
|
1041
1074
|
### media.libraries.purge
|
|
1042
1075
|
|
|
1043
1076
|
| Method | HTTP | Path | Streaming | Pagination |
|
|
@@ -1068,6 +1101,13 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1068
1101
|
|---|---|---|---|---|
|
|
1069
1102
|
| create | POST | `/media/v1/libraries/{library_id}/search/visual` | no | no |
|
|
1070
1103
|
|
|
1104
|
+
### media.libraries.understandings
|
|
1105
|
+
|
|
1106
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1107
|
+
|---|---|---|---|---|
|
|
1108
|
+
| list | GET | `/media/v1/libraries/{library_id}/understandings` | no | yes |
|
|
1109
|
+
| retrieveFailureSummary | GET | `/media/v1/libraries/{library_id}/understandings/failure_summary` | no | no |
|
|
1110
|
+
|
|
1071
1111
|
## meta
|
|
1072
1112
|
|
|
1073
1113
|
### meta.docs
|
|
@@ -1217,6 +1257,57 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1217
1257
|
| retrieve | GET | `/model/v1/videos/{video_id}` | no | no |
|
|
1218
1258
|
| retrieveContent | GET | `/model/v1/videos/{video_id}/content` | no | no |
|
|
1219
1259
|
|
|
1260
|
+
## ontology
|
|
1261
|
+
|
|
1262
|
+
### ontology.changesets
|
|
1263
|
+
|
|
1264
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1265
|
+
|---|---|---|---|---|
|
|
1266
|
+
| create | POST | `/ontology/v1/changesets` | no | no |
|
|
1267
|
+
|
|
1268
|
+
### ontology.nodes
|
|
1269
|
+
|
|
1270
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1271
|
+
|---|---|---|---|---|
|
|
1272
|
+
| create | POST | `/ontology/v1/nodes` | no | no |
|
|
1273
|
+
| list | GET | `/ontology/v1/nodes` | no | yes |
|
|
1274
|
+
| retrieve | GET | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1275
|
+
| update | PATCH | `/ontology/v1/nodes/{node_id}` | no | no |
|
|
1276
|
+
|
|
1277
|
+
### ontology.nodes.merge
|
|
1278
|
+
|
|
1279
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1280
|
+
|---|---|---|---|---|
|
|
1281
|
+
| create | POST | `/ontology/v1/nodes/{node_id}/merge` | no | no |
|
|
1282
|
+
|
|
1283
|
+
### ontology.relations
|
|
1284
|
+
|
|
1285
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1286
|
+
|---|---|---|---|---|
|
|
1287
|
+
| create | POST | `/ontology/v1/relations` | no | no |
|
|
1288
|
+
| list | GET | `/ontology/v1/relations` | no | yes |
|
|
1289
|
+
| retrieve | GET | `/ontology/v1/relations/{relation_id}` | no | no |
|
|
1290
|
+
|
|
1291
|
+
### ontology.relations.invalidate
|
|
1292
|
+
|
|
1293
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1294
|
+
|---|---|---|---|---|
|
|
1295
|
+
| create | POST | `/ontology/v1/relations/{relation_id}/invalidate` | no | no |
|
|
1296
|
+
|
|
1297
|
+
### ontology.search
|
|
1298
|
+
|
|
1299
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1300
|
+
|---|---|---|---|---|
|
|
1301
|
+
| create | POST | `/ontology/v1/search` | no | no |
|
|
1302
|
+
|
|
1303
|
+
### ontology.types
|
|
1304
|
+
|
|
1305
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1306
|
+
|---|---|---|---|---|
|
|
1307
|
+
| create | POST | `/ontology/v1/types` | no | no |
|
|
1308
|
+
| list | GET | `/ontology/v1/types` | no | no |
|
|
1309
|
+
| retrieve | GET | `/ontology/v1/types/{name}` | no | no |
|
|
1310
|
+
|
|
1220
1311
|
## organization
|
|
1221
1312
|
|
|
1222
1313
|
### organization.charges
|
|
@@ -1259,6 +1350,12 @@ Multipart request bodies expand plain objects into bracketed fields (for example
|
|
|
1259
1350
|
| create | POST | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1260
1351
|
| list | GET | `/organization/v1/feedback/{id}/messages` | no | no |
|
|
1261
1352
|
|
|
1353
|
+
### organization.members
|
|
1354
|
+
|
|
1355
|
+
| Method | HTTP | Path | Streaming | Pagination |
|
|
1356
|
+
|---|---|---|---|---|
|
|
1357
|
+
| list | GET | `/organization/v1/members` | no | no |
|
|
1358
|
+
|
|
1262
1359
|
### organization.usage
|
|
1263
1360
|
|
|
1264
1361
|
| Method | HTTP | Path | Streaming | Pagination |
|
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)
|
|
@@ -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.
|
package/dist/core/errors.d.ts
CHANGED
|
@@ -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;
|
package/dist/core/errors.js
CHANGED
|
@@ -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) {
|