@deepraxis/sdk 0.1.0-dev.95813a3 → 0.1.0-dev.a3beed2
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 +28 -1
- package/dist/core/client.d.ts +9 -1
- package/dist/core/client.js +6 -0
- package/dist/core/transport.d.ts +5 -0
- package/dist/core/transport.js +6 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +66 -22
- package/dist/generated/sdk.gen.js +175 -50
- package/dist/generated/types.gen.d.ts +5113 -3071
- package/dist/helpers/application-publish.d.ts +24 -4
- package/dist/helpers/application-publish.js +53 -3
- package/dist/helpers/database-count.d.ts +17 -0
- package/dist/helpers/database-count.js +11 -0
- package/dist/helpers/file-upload.d.ts +24 -0
- package/dist/helpers/file-upload.js +113 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +244 -23
- package/dist/operations.generated.js +304 -24
- package/dist/resources.generated.d.ts +482 -0
- package/dist/resources.generated.js +15 -0
- package/package.json +1 -1
|
@@ -102,6 +102,24 @@ export declare const operations: readonly [{
|
|
|
102
102
|
readonly itemType: "object";
|
|
103
103
|
readonly required: false;
|
|
104
104
|
readonly description: "Tool configurations available to the agent. Maximum of 128 tools\nacross all toolsets allowed.";
|
|
105
|
+
}, {
|
|
106
|
+
readonly name: "databases";
|
|
107
|
+
readonly type: "array";
|
|
108
|
+
readonly itemType: "object";
|
|
109
|
+
readonly required: false;
|
|
110
|
+
readonly description: "Database allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
111
|
+
}, {
|
|
112
|
+
readonly name: "vector_stores";
|
|
113
|
+
readonly type: "array";
|
|
114
|
+
readonly itemType: "object";
|
|
115
|
+
readonly required: false;
|
|
116
|
+
readonly description: "Knowledge vector store allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
117
|
+
}, {
|
|
118
|
+
readonly name: "files";
|
|
119
|
+
readonly type: "array";
|
|
120
|
+
readonly itemType: "object";
|
|
121
|
+
readonly required: false;
|
|
122
|
+
readonly description: "File allowlist for platform resources accessible through service-agent codemode. Only kind=service accepts nonempty bindings; personal agents return 400. At most 20 bindings per resource type, with no duplicate ids. Newly added bindings apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Unbound resources return 404; writes to read_only resources are refused. Other platform APIs return 403, except public API discovery. Invalid bindings and unknown item fields return 400. Omit on create for no bindings.";
|
|
105
123
|
}, {
|
|
106
124
|
readonly name: "kind";
|
|
107
125
|
readonly type: "string";
|
|
@@ -140,6 +158,12 @@ export declare const operations: readonly [{
|
|
|
140
158
|
readonly type: "object";
|
|
141
159
|
readonly required: false;
|
|
142
160
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
161
|
+
}, {
|
|
162
|
+
readonly name: "preset";
|
|
163
|
+
readonly type: "string";
|
|
164
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
165
|
+
readonly required: false;
|
|
166
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
143
167
|
}];
|
|
144
168
|
};
|
|
145
169
|
}, {
|
|
@@ -230,6 +254,24 @@ export declare const operations: readonly [{
|
|
|
230
254
|
readonly type: "number";
|
|
231
255
|
readonly required: false;
|
|
232
256
|
readonly description: "The agent's current version, used to prevent concurrent overwrites.\nObtain this value from a create or retrieve response. Must be at least 1 if\nspecified. When supplied, the request fails if it does not match the server's\ncurrent version; omit to apply the update unconditionally.";
|
|
257
|
+
}, {
|
|
258
|
+
readonly name: "databases";
|
|
259
|
+
readonly type: "array";
|
|
260
|
+
readonly itemType: "object";
|
|
261
|
+
readonly required: false;
|
|
262
|
+
readonly description: "Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings.";
|
|
263
|
+
}, {
|
|
264
|
+
readonly name: "vector_stores";
|
|
265
|
+
readonly type: "array";
|
|
266
|
+
readonly itemType: "object";
|
|
267
|
+
readonly required: false;
|
|
268
|
+
readonly description: "Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings.";
|
|
269
|
+
}, {
|
|
270
|
+
readonly name: "files";
|
|
271
|
+
readonly type: "array";
|
|
272
|
+
readonly itemType: "object";
|
|
273
|
+
readonly required: false;
|
|
274
|
+
readonly description: "Replace this resource allowlist; omission preserves it, and null or [] clears it. Additions apply only to new sessions; disabling or removing a binding immediately revokes access in running sessions. Only service agents accept nonempty bindings.";
|
|
233
275
|
}, {
|
|
234
276
|
readonly name: "kind";
|
|
235
277
|
readonly type: "string";
|
|
@@ -268,6 +310,12 @@ export declare const operations: readonly [{
|
|
|
268
310
|
readonly type: "object";
|
|
269
311
|
readonly required: false;
|
|
270
312
|
readonly description: "Praxis extension: switchable model ids on /agent/v1 only. The default model must be included. When omitted, only the default model is selectable.";
|
|
313
|
+
}, {
|
|
314
|
+
readonly name: "preset";
|
|
315
|
+
readonly type: "string";
|
|
316
|
+
readonly enum: readonly ["minimal", "data-editor", "full"];
|
|
317
|
+
readonly required: false;
|
|
318
|
+
readonly description: "Optional tool preset. minimal enables read, glob, grep and ask_user_question; data-editor also enables write and edit; full uses the default toolset with always_allow. Explicit tools override matching preset entries. codemode requires bash and is absent from data-editor.";
|
|
271
319
|
}];
|
|
272
320
|
};
|
|
273
321
|
}, {
|
|
@@ -420,6 +468,20 @@ export declare const operations: readonly [{
|
|
|
420
468
|
readonly sdkName: "external_user_id";
|
|
421
469
|
}];
|
|
422
470
|
readonly query: readonly [];
|
|
471
|
+
}, {
|
|
472
|
+
readonly resource: "agent.agents.unarchive";
|
|
473
|
+
readonly method: "create";
|
|
474
|
+
readonly summary: "Unarchive Agent";
|
|
475
|
+
readonly description: "Restore an archived agent without creating a configuration version. Already active agents are unchanged. Missing or inaccessible agents return 404. Use the returned agent id to create new sessions.";
|
|
476
|
+
readonly http: "POST";
|
|
477
|
+
readonly path: "/agent/v1/agents/{agent_id}/unarchive";
|
|
478
|
+
readonly streaming: "no";
|
|
479
|
+
readonly pagination: false;
|
|
480
|
+
readonly pathParams: readonly [{
|
|
481
|
+
readonly name: "agent_id";
|
|
482
|
+
readonly sdkName: "agent_id";
|
|
483
|
+
}];
|
|
484
|
+
readonly query: readonly [];
|
|
423
485
|
}, {
|
|
424
486
|
readonly resource: "agent.agents.versions";
|
|
425
487
|
readonly method: "list";
|
|
@@ -582,7 +644,7 @@ export declare const operations: readonly [{
|
|
|
582
644
|
readonly resource: "agent.computers";
|
|
583
645
|
readonly method: "connect";
|
|
584
646
|
readonly summary: "Connect computer";
|
|
585
|
-
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.";
|
|
647
|
+
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Renew the lease while using the connection and release it with DELETE when finished.";
|
|
586
648
|
readonly http: "POST";
|
|
587
649
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
588
650
|
readonly streaming: "no";
|
|
@@ -592,6 +654,16 @@ export declare const operations: readonly [{
|
|
|
592
654
|
readonly sdkName: "computer_id";
|
|
593
655
|
}];
|
|
594
656
|
readonly query: readonly [];
|
|
657
|
+
readonly body: {
|
|
658
|
+
readonly required: false;
|
|
659
|
+
readonly fields: readonly [{
|
|
660
|
+
readonly name: "need";
|
|
661
|
+
readonly type: "string";
|
|
662
|
+
readonly enum: readonly ["light", "heavy"];
|
|
663
|
+
readonly required: false;
|
|
664
|
+
readonly description: "Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds.";
|
|
665
|
+
}];
|
|
666
|
+
};
|
|
595
667
|
}, {
|
|
596
668
|
readonly resource: "agent.computers.files";
|
|
597
669
|
readonly method: "list";
|
|
@@ -1406,7 +1478,7 @@ export declare const operations: readonly [{
|
|
|
1406
1478
|
readonly resource: "agent.sessions";
|
|
1407
1479
|
readonly method: "create";
|
|
1408
1480
|
readonly summary: "Create session";
|
|
1409
|
-
readonly description: "Create a session: one conversation with an agent
|
|
1481
|
+
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id (latest version) or {id, version, type:\"agent\"}. Unlike Anthropic Managed Agents, omit environment_id to get a light machine, unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, omission returns environment_id=light; explicit null allocates no machine, so codemode, bash and other machine tools are unavailable. Optional model must be one of the agent's allowed models; optional thinking is {effort: low|medium|high|xhigh|max|none} or null, where null inherits the agent default and then the model default (none requires the model to allow disabling thinking). Selections are saved before initial_events run; invalid ones return 400 invalid_request_error. Inline agent overrides are not supported. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. Omitted budget defaults to USD 20; null removes the limit, and a limit object uses a positive integer string of USD cents. Up to 500 file resources can be attached. Use initial_events to send a first user.message in this request, or send messages afterwards with sessions.events.send. The returned status can still be idle before initial events run; read agent.message and the subsequent session.status_idle event to confirm completion.";
|
|
1410
1482
|
readonly http: "POST";
|
|
1411
1483
|
readonly path: "/agent/v1/sessions";
|
|
1412
1484
|
readonly streaming: "no";
|
|
@@ -1424,7 +1496,7 @@ export declare const operations: readonly [{
|
|
|
1424
1496
|
readonly name: "environment_id";
|
|
1425
1497
|
readonly type: "string";
|
|
1426
1498
|
readonly required: false;
|
|
1427
|
-
readonly description: "
|
|
1499
|
+
readonly description: "Execution environment id from agent.environments.list or agent.environments.create. For a service agent, omission selects the built-in light environment and returns session.environment_id=light; explicit null allocates no machine and makes machine tools, including codemode and bash, unavailable. Personal agents use their selected Computer.";
|
|
1428
1500
|
}, {
|
|
1429
1501
|
readonly name: "budget";
|
|
1430
1502
|
readonly type: "object";
|
|
@@ -1485,6 +1557,20 @@ export declare const operations: readonly [{
|
|
|
1485
1557
|
readonly description: "Praxis extension: explicit session thinking effort; null inherits the pinned agent default, then the model default. none disables thinking only when model.thinking.can_disable is true. Unsupported efforts return 400 invalid_request_error.";
|
|
1486
1558
|
}];
|
|
1487
1559
|
};
|
|
1560
|
+
}, {
|
|
1561
|
+
readonly resource: "agent.sessions";
|
|
1562
|
+
readonly method: "delete";
|
|
1563
|
+
readonly summary: "Delete session";
|
|
1564
|
+
readonly description: "Delete an idle or terminated session and its event history after saving a deletion snapshot. Supply the session id from creation or listing. Running sessions return 409 INVALID_STATE: interrupt first or wait until idle or terminated. Afterwards retrieval and event listing return 404 and lists omit the session. Example: DELETE /agent/v1/sessions/sesn_example.";
|
|
1565
|
+
readonly http: "DELETE";
|
|
1566
|
+
readonly path: "/agent/v1/sessions/{session_id}";
|
|
1567
|
+
readonly streaming: "no";
|
|
1568
|
+
readonly pagination: false;
|
|
1569
|
+
readonly pathParams: readonly [{
|
|
1570
|
+
readonly name: "session_id";
|
|
1571
|
+
readonly sdkName: "session_id";
|
|
1572
|
+
}];
|
|
1573
|
+
readonly query: readonly [];
|
|
1488
1574
|
}, {
|
|
1489
1575
|
readonly resource: "agent.sessions";
|
|
1490
1576
|
readonly method: "retrieve";
|
|
@@ -2694,6 +2780,23 @@ export declare const operations: readonly [{
|
|
|
2694
2780
|
readonly sdkName: "version_id";
|
|
2695
2781
|
}];
|
|
2696
2782
|
readonly query: readonly [];
|
|
2783
|
+
}, {
|
|
2784
|
+
readonly resource: "application.workers.versions.assets";
|
|
2785
|
+
readonly method: "retrieveManifest";
|
|
2786
|
+
readonly summary: "Get version asset manifest";
|
|
2787
|
+
readonly description: "Read the retained asset paths, content hashes and byte sizes of a version for publication planning. This read creates no session or version. A version without assets returns an empty manifest; unavailable artifacts and foreign resources return 404.";
|
|
2788
|
+
readonly http: "GET";
|
|
2789
|
+
readonly path: "/application/v1/workers/{worker_id}/versions/{version_id}/assets/manifest";
|
|
2790
|
+
readonly streaming: "no";
|
|
2791
|
+
readonly pagination: false;
|
|
2792
|
+
readonly pathParams: readonly [{
|
|
2793
|
+
readonly name: "worker_id";
|
|
2794
|
+
readonly sdkName: "worker_id";
|
|
2795
|
+
}, {
|
|
2796
|
+
readonly name: "version_id";
|
|
2797
|
+
readonly sdkName: "version_id";
|
|
2798
|
+
}];
|
|
2799
|
+
readonly query: readonly [];
|
|
2697
2800
|
}, {
|
|
2698
2801
|
readonly resource: "automation.actions";
|
|
2699
2802
|
readonly method: "list";
|
|
@@ -5435,7 +5538,7 @@ export declare const operations: readonly [{
|
|
|
5435
5538
|
readonly name: "{column}";
|
|
5436
5539
|
readonly type: "string";
|
|
5437
5540
|
readonly required: false;
|
|
5438
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5541
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5439
5542
|
}, {
|
|
5440
5543
|
readonly name: "and";
|
|
5441
5544
|
readonly type: "string";
|
|
@@ -5475,7 +5578,7 @@ export declare const operations: readonly [{
|
|
|
5475
5578
|
readonly name: "on_conflict";
|
|
5476
5579
|
readonly type: "string";
|
|
5477
5580
|
readonly required: false;
|
|
5478
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5581
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5479
5582
|
}, {
|
|
5480
5583
|
readonly name: "columns";
|
|
5481
5584
|
readonly type: "string";
|
|
@@ -5486,7 +5589,7 @@ export declare const operations: readonly [{
|
|
|
5486
5589
|
readonly resource: "database.databases.rest";
|
|
5487
5590
|
readonly method: "retrieve";
|
|
5488
5591
|
readonly summary: "Select rows";
|
|
5489
|
-
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property.
|
|
5592
|
+
readonly description: "Read matching rows with filters, selected columns and ordering. Returns at most 1000 rows per request, including when limit is omitted. Content-Range reports the actual returned interval and the total when count is requested. PATCH and DELETE are not subject to this read cap. Unlike Supabase, casts, aggregates, spread and join modifiers are unsupported. Each table supports up to 1,000,000 rows. Query budget: 8,000 ms with a shared 3,000,000-row safety ceiling. Create indexes on filtered or sorted fields, or narrow the request when it exceeds its budget. Synchronous SQLite aggregates use candidate-row throughput estimates before execution; deployed Workers freeze clocks during synchronous CPU work, so the timer is not a guaranteed server-side interrupt. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Error table: QUERY_CANCELED / PostgREST 57014 is HTTP 500, retryable=false: Query timed out: index filtered or sorted fields, or narrow the range. DATABASE_INVALID_STATE is HTTP 409 for operations on a deleting database. Cleared or nonexistent databases return DATABASE_NOT_FOUND / HTTP 404. The count is an HTTP Content-Range response header, not a JSON property. Use praxis.database.count in the SDK or codemode to return { count: number | null }; a page length is not a total unless you know all matches fit in that page.";
|
|
5490
5593
|
readonly http: "GET";
|
|
5491
5594
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5492
5595
|
readonly streaming: "no";
|
|
@@ -5507,7 +5610,7 @@ export declare const operations: readonly [{
|
|
|
5507
5610
|
readonly name: "{column}";
|
|
5508
5611
|
readonly type: "string";
|
|
5509
5612
|
readonly required: false;
|
|
5510
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5613
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5511
5614
|
}, {
|
|
5512
5615
|
readonly name: "and";
|
|
5513
5616
|
readonly type: "string";
|
|
@@ -5547,7 +5650,7 @@ export declare const operations: readonly [{
|
|
|
5547
5650
|
readonly name: "on_conflict";
|
|
5548
5651
|
readonly type: "string";
|
|
5549
5652
|
readonly required: false;
|
|
5550
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5653
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5551
5654
|
}, {
|
|
5552
5655
|
readonly name: "columns";
|
|
5553
5656
|
readonly type: "string";
|
|
@@ -5558,7 +5661,7 @@ export declare const operations: readonly [{
|
|
|
5558
5661
|
readonly resource: "database.databases.rest";
|
|
5559
5662
|
readonly method: "head";
|
|
5560
5663
|
readonly summary: "Count rows";
|
|
5561
|
-
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode.
|
|
5664
|
+
readonly description: "Inspect the HTTP row count and range without retrieving row data; send Prefer: count=exact for a filtered count. Returns no body and does not fetch or serialize row data. A known count determines the interval using limit/offset or Range with a default and maximum page size of 1000. Without a count preference, or when the selected count mode cannot supply a total, Content-Range is */*. Singular Accept still validates page cardinality. Unlike Supabase, planned and estimated counts do not use PostgreSQL planner estimates. Count preferences: without filters, exact, planned and estimated all use SQLite's exact b-tree count. With filters, exact counts within budget; planned skips counting and reports an unknown total (Content-Range: 0-24/*); estimated attempts exact counting only when the preflight budget allows it, otherwise reports an unknown total. Preference-Applied echoes the requested count mode. Use praxis.database.count in the SDK or codemode to return { count: number | null } from this header without retrieving rows.";
|
|
5562
5665
|
readonly http: "HEAD";
|
|
5563
5666
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5564
5667
|
readonly streaming: "no";
|
|
@@ -5579,7 +5682,7 @@ export declare const operations: readonly [{
|
|
|
5579
5682
|
readonly name: "{column}";
|
|
5580
5683
|
readonly type: "string";
|
|
5581
5684
|
readonly required: false;
|
|
5582
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5685
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5583
5686
|
}, {
|
|
5584
5687
|
readonly name: "and";
|
|
5585
5688
|
readonly type: "string";
|
|
@@ -5619,7 +5722,7 @@ export declare const operations: readonly [{
|
|
|
5619
5722
|
readonly name: "on_conflict";
|
|
5620
5723
|
readonly type: "string";
|
|
5621
5724
|
readonly required: false;
|
|
5622
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5725
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5623
5726
|
}, {
|
|
5624
5727
|
readonly name: "columns";
|
|
5625
5728
|
readonly type: "string";
|
|
@@ -5651,7 +5754,7 @@ export declare const operations: readonly [{
|
|
|
5651
5754
|
readonly name: "{column}";
|
|
5652
5755
|
readonly type: "string";
|
|
5653
5756
|
readonly required: false;
|
|
5654
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5757
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5655
5758
|
}, {
|
|
5656
5759
|
readonly name: "and";
|
|
5657
5760
|
readonly type: "string";
|
|
@@ -5691,7 +5794,7 @@ export declare const operations: readonly [{
|
|
|
5691
5794
|
readonly name: "on_conflict";
|
|
5692
5795
|
readonly type: "string";
|
|
5693
5796
|
readonly required: false;
|
|
5694
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5797
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5695
5798
|
}, {
|
|
5696
5799
|
readonly name: "columns";
|
|
5697
5800
|
readonly type: "string";
|
|
@@ -5706,7 +5809,7 @@ export declare const operations: readonly [{
|
|
|
5706
5809
|
readonly resource: "database.databases.rest";
|
|
5707
5810
|
readonly method: "create";
|
|
5708
5811
|
readonly summary: "Insert rows";
|
|
5709
|
-
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5812
|
+
readonly description: "Insert rows into an existing table after defining its fields; at most 500 rows per request. Each request is atomic: any failure rolls back the entire batch. There are no transactions across requests.\nRows are filled to the union of their keys with null; send Prefer: missing=default to use field defaults for missing keys.\nThe default is return=minimal: success returns HTTP 201 with an empty body. Send Prefer: return=representation to return the inserted rows. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. Unlike Supabase, upsert conflicts can target only id or one unique field, not a composite key. Each table supports up to 1,000,000 rows.";
|
|
5710
5813
|
readonly http: "POST";
|
|
5711
5814
|
readonly path: "/database/v1/databases/{database_id}/rest/{table}";
|
|
5712
5815
|
readonly streaming: "no";
|
|
@@ -5727,7 +5830,7 @@ export declare const operations: readonly [{
|
|
|
5727
5830
|
readonly name: "{column}";
|
|
5728
5831
|
readonly type: "string";
|
|
5729
5832
|
readonly required: false;
|
|
5730
|
-
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns.
|
|
5833
|
+
readonly description: "Horizontal filter: replace {column} with a field name or JSON path, e.g. title=eq.summary. Repeat for more columns. Supported operators: eq (equal), neq (not equal; ne is not supported), gt/gte/lt/lte (comparisons), like (case-sensitive text pattern), ilike (case-insensitive text pattern), in (membership), is (null/boolean test), cs (contains), cd (contained by), and ov (array overlap). For like/ilike, * or % matches any sequence and _ matches one character, e.g. title=ilike.*spring*; URL-encode a literal % as %25. Use days=in.(1,2,3), title=is.null, active=is.true or active=is.false; is.not_null and is.unknown are also accepted (unknown means null). Negate a condition with not., e.g. title=not.eq.draft. Multiple filters are ANDed; use or=(title.eq.a,title.eq.b), and=(days.gte.1,days.lte.3), not.or=(...) or not.and=(...), with nested and(...) and or(...) groups as needed. cs/cd accept JSON objects or arrays on JSON fields; cs also accepts a JSON scalar. For array values or multi-link fields, use cs.{a,b}, cd.{a,b} or ov.{a,b}. JSON paths use -> for JSON and ->> for text, e.g. attributes->>has_onsen=eq.true or attributes->tags=cs.[1,2]; chain -> segments and end with ->> for text. Dot paths such as attributes.has_onsen are unsupported. Full-text, regex, range operators and any/all modifiers are unsupported.";
|
|
5731
5834
|
}, {
|
|
5732
5835
|
readonly name: "and";
|
|
5733
5836
|
readonly type: "string";
|
|
@@ -5767,7 +5870,7 @@ export declare const operations: readonly [{
|
|
|
5767
5870
|
readonly name: "on_conflict";
|
|
5768
5871
|
readonly type: "string";
|
|
5769
5872
|
readonly required: false;
|
|
5770
|
-
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5873
|
+
readonly description: "POST upsert: id or one unique field with resolution=merge-duplicates|ignore-duplicates. With resolution=merge-duplicates, a conflicting row keeps columns omitted from the request; supplied values replace the whole field value (including JSON objects), and explicit null clears a nullable field. With resolution=ignore-duplicates, a conflicting row is left unchanged. Without a conflict, both modes insert a new row using field defaults for omitted fields. In a batch, a key present in another row is filled with null when omitted in this row unless missing=default is set; that null can overwrite a value during merge. With missing=default, omitted keys stay omitted for conflict merges (existing values are preserved); new rows use defaults, or null when no default exists. Explicit null never invokes a default. POST accepts an optional client id matching [A-Za-z0-9_-]{1,64}; omitted ids are generated. PATCH cannot change id.";
|
|
5771
5874
|
}, {
|
|
5772
5875
|
readonly name: "columns";
|
|
5773
5876
|
readonly type: "string";
|
|
@@ -5810,7 +5913,7 @@ export declare const operations: readonly [{
|
|
|
5810
5913
|
readonly resource: "database.databases.tables";
|
|
5811
5914
|
readonly method: "create";
|
|
5812
5915
|
readonly summary: "Create table";
|
|
5813
|
-
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5916
|
+
readonly description: "Creates a table together with its initial fields in one call and returns it (HTTP 201) with generated tbl_ and fld_ ids. name must match ^[a-z_][a-z0-9_]{0,62}$ and be unused in this database (duplicate: 409 UNIQUE_VIOLATION). fields is required and may be an empty array; fields can also be added later with databaseAddField. Limits: 50 tables per database, 64 fields per table, and 16 indexed or unique fields per table; exceeding one returns 400 LIMIT_EXCEEDED. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. Every row also has a system id column, which is not declared as a field. Insert data afterwards with databaseInsert. Unlike Supabase, define schema with this table API and the field APIs; PostgreSQL DDL and SQL migration files cannot be submitted. Each table supports up to 1,000,000 rows.";
|
|
5814
5917
|
readonly http: "POST";
|
|
5815
5918
|
readonly path: "/database/v1/databases/{database_id}/tables";
|
|
5816
5919
|
readonly streaming: "no";
|
|
@@ -5909,7 +6012,7 @@ export declare const operations: readonly [{
|
|
|
5909
6012
|
readonly resource: "database.databases.tables.fields";
|
|
5910
6013
|
readonly method: "create";
|
|
5911
6014
|
readonly summary: "Add field";
|
|
5912
|
-
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row.
|
|
6015
|
+
readonly description: "Adds one field to an existing table and returns the updated table (HTTP 201). Required inputs are name (lowercase letters, digits and underscores; id and names starting with _ are reserved) and type (string, integer, number, boolean, datetime, json or link); json needs options.schema and link needs options.linked_table_id and options.multiple. Adding a required field to a table that already has rows needs a default, otherwise the call fails with 400 VALIDATION_FAILED; a default is written into every existing row. Fields default to indexed:false. Set indexed:true explicitly for fields used in filters or ordering. Only indexed:true or unique:true consumes one of the 16 indexed-or-unique field slots; a field with both consumes one slot. Unique fields still consume a slot even with indexed:false. Existing fields are unchanged. Minimal field example: {\"name\":\"notes\",\"type\":\"string\",\"indexed\":false}. JSON and link fields cannot be indexed. Limits: 64 fields and 16 indexed or unique fields per table (400 LIMIT_EXCEEDED). Unlike Supabase, schema evolution uses field definitions rather than ALTER TABLE statements or SQL migrations.";
|
|
5913
6016
|
readonly http: "POST";
|
|
5914
6017
|
readonly path: "/database/v1/databases/{database_id}/tables/{table}/fields";
|
|
5915
6018
|
readonly streaming: "no";
|
|
@@ -6046,7 +6149,7 @@ export declare const operations: readonly [{
|
|
|
6046
6149
|
readonly resource: "file.files";
|
|
6047
6150
|
readonly method: "create";
|
|
6048
6151
|
readonly summary: "Upload file";
|
|
6049
|
-
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most
|
|
6152
|
+
readonly description: "Upload a file to reuse in conversations or attach to a knowledge base. Unlike OpenAI Files, uploads must be nonempty and at most 100000000 bytes, and only user_data, assistants and vision purposes are accepted. Send file bytes as a multipart file part, not a filename or file ID; in the SDK use a File or Blob, for example new File([\"Return within 23 days.\"], \"policy.txt\", { type: \"text/plain\" }). Content determines the MIME type. Supported uploads include PDF, DOCX/XLSX/PPTX, PNG/JPEG/GIF/WebP, MP3/WAV/FLAC/OGG/M4A, MP4/WebM, and UTF-8 JSON/NDJSON/CSV/Markdown/plain text; empty, unsupported, oversized files and unsupported purposes return 400. Use Uploads for larger files. The purpose vision accepts only PNG, JPEG, GIF and WebP, while conversation images require user_data. The returned ID belongs to your tenant; upload alone does not ingest the file into Knowledge. Knowledge attachment has a lower limit of 100000000 bytes. Optionally set expires_after[anchor]=created_at with expires_after[seconds] (3600–2592000), or praxis[expires_in_seconds] (3600–7776000), never both. Without expiry, the file persists until deleted.";
|
|
6050
6153
|
readonly http: "POST";
|
|
6051
6154
|
readonly path: "/file/v1/files";
|
|
6052
6155
|
readonly streaming: "no";
|
|
@@ -6060,7 +6163,7 @@ export declare const operations: readonly [{
|
|
|
6060
6163
|
readonly name: "file";
|
|
6061
6164
|
readonly type: "string";
|
|
6062
6165
|
readonly required: true;
|
|
6063
|
-
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most
|
|
6166
|
+
readonly description: "File bytes in one multipart file part, not a filename or file ID. The file must be nonempty and at most 100000000 bytes; its content determines the MIME type.";
|
|
6064
6167
|
}, {
|
|
6065
6168
|
readonly name: "purpose";
|
|
6066
6169
|
readonly type: "string";
|
|
@@ -6097,7 +6200,7 @@ export declare const operations: readonly [{
|
|
|
6097
6200
|
readonly resource: "file.files";
|
|
6098
6201
|
readonly method: "retrieve";
|
|
6099
6202
|
readonly summary: "Retrieve file";
|
|
6100
|
-
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its
|
|
6203
|
+
readonly description: "Retrieve metadata for a live file owned by your tenant. Use its file- ID from upload or list. Missing, deleted, expired and other-tenant files return 404; use the content endpoint to download the bytes.";
|
|
6101
6204
|
readonly http: "GET";
|
|
6102
6205
|
readonly path: "/file/v1/files/{file_id}";
|
|
6103
6206
|
readonly streaming: "no";
|
|
@@ -6111,7 +6214,7 @@ export declare const operations: readonly [{
|
|
|
6111
6214
|
readonly resource: "file.files";
|
|
6112
6215
|
readonly method: "retrieveContent";
|
|
6113
6216
|
readonly summary: "Retrieve file content";
|
|
6114
|
-
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its
|
|
6217
|
+
readonly description: "Download the original bytes of a live file owned by your tenant. Supply its file- ID from upload or list. A single byte Range can return a partial response; a range outside the file returns 416. Missing, deleted, expired and other-tenant files return 404.";
|
|
6115
6218
|
readonly http: "GET";
|
|
6116
6219
|
readonly path: "/file/v1/files/{file_id}/content";
|
|
6117
6220
|
readonly streaming: "no";
|
|
@@ -6121,6 +6224,124 @@ export declare const operations: readonly [{
|
|
|
6121
6224
|
readonly sdkName: "file_id";
|
|
6122
6225
|
}];
|
|
6123
6226
|
readonly query: readonly [];
|
|
6227
|
+
}, {
|
|
6228
|
+
readonly resource: "file.uploads";
|
|
6229
|
+
readonly method: "create";
|
|
6230
|
+
readonly summary: "Create an upload";
|
|
6231
|
+
readonly description: "Start a multipart upload for a file larger than the 100000000-byte direct-upload limit. Supply the exact byte length, filename, MIME type and purpose. Unlike OpenAI, uploads accept at most 2 GiB (2147483648 bytes) and only user_data, assistants and vision purposes. Add parts of at most 64000000 bytes and complete within one hour. Optional part_size enables fixed-size, retryable parts. expires_after applies to the resulting file (3600–7776000 seconds on this own face); without it the file persists until deleted.";
|
|
6232
|
+
readonly http: "POST";
|
|
6233
|
+
readonly path: "/file/v1/uploads";
|
|
6234
|
+
readonly streaming: "no";
|
|
6235
|
+
readonly pagination: false;
|
|
6236
|
+
readonly pathParams: readonly [];
|
|
6237
|
+
readonly query: readonly [];
|
|
6238
|
+
readonly body: {
|
|
6239
|
+
readonly required: true;
|
|
6240
|
+
readonly fields: readonly [{
|
|
6241
|
+
readonly name: "bytes";
|
|
6242
|
+
readonly type: "integer";
|
|
6243
|
+
readonly required: true;
|
|
6244
|
+
readonly description: "Exact complete file length in bytes, from 1 through 2147483648 (2 GiB); the sum of completed parts must match.";
|
|
6245
|
+
}, {
|
|
6246
|
+
readonly name: "filename";
|
|
6247
|
+
readonly type: "string";
|
|
6248
|
+
readonly required: true;
|
|
6249
|
+
readonly description: "Filename for the resulting file, at most 255 UTF-8 bytes.";
|
|
6250
|
+
}, {
|
|
6251
|
+
readonly name: "mime_type";
|
|
6252
|
+
readonly type: "string";
|
|
6253
|
+
readonly required: true;
|
|
6254
|
+
readonly description: "Declared MIME type; validated against the assembled content.";
|
|
6255
|
+
}, {
|
|
6256
|
+
readonly name: "purpose";
|
|
6257
|
+
readonly type: "string";
|
|
6258
|
+
readonly enum: readonly ["user_data", "assistants", "vision"];
|
|
6259
|
+
readonly required: true;
|
|
6260
|
+
readonly description: "Use user_data for conversation attachments, assistants for assistant files, or vision for PNG, JPEG, GIF and WebP images.";
|
|
6261
|
+
}, {
|
|
6262
|
+
readonly name: "expires_after";
|
|
6263
|
+
readonly type: "object";
|
|
6264
|
+
readonly required: false;
|
|
6265
|
+
readonly description: "Optional expiry policy for the resulting file; omission retains the file until deletion.";
|
|
6266
|
+
}, {
|
|
6267
|
+
readonly name: "part_size";
|
|
6268
|
+
readonly type: "integer";
|
|
6269
|
+
readonly required: false;
|
|
6270
|
+
readonly description: "Optional fixed part size in bytes, 5242880–64000000. Requires part_number on every part; retries of identical bytes at the same number return the same part. Omit to use arbitrary-sized parts.";
|
|
6271
|
+
}];
|
|
6272
|
+
};
|
|
6273
|
+
}, {
|
|
6274
|
+
readonly resource: "file.uploads";
|
|
6275
|
+
readonly method: "cancel";
|
|
6276
|
+
readonly summary: "Cancel an upload";
|
|
6277
|
+
readonly description: "Cancel an unfinished upload using upload_id from create and release its reserved storage. Further parts and completion are rejected. Cancelling an already cancelled upload returns the same terminal result; a completed upload cannot be cancelled. Delete its resulting file instead.";
|
|
6278
|
+
readonly http: "POST";
|
|
6279
|
+
readonly path: "/file/v1/uploads/{upload_id}/cancel";
|
|
6280
|
+
readonly streaming: "no";
|
|
6281
|
+
readonly pagination: false;
|
|
6282
|
+
readonly pathParams: readonly [{
|
|
6283
|
+
readonly name: "upload_id";
|
|
6284
|
+
readonly sdkName: "upload_id";
|
|
6285
|
+
}];
|
|
6286
|
+
readonly query: readonly [];
|
|
6287
|
+
}, {
|
|
6288
|
+
readonly resource: "file.uploads";
|
|
6289
|
+
readonly method: "complete";
|
|
6290
|
+
readonly summary: "Complete an upload";
|
|
6291
|
+
readonly description: "Assemble the uploaded parts into a file. Supply upload_id from create and part_ids from addPart in file byte order; their sizes must total the declared bytes. Optional md5 verifies the assembled content. Retrying identical part_ids and normalized md5 returns the same result; different inputs return 409. Unlike OpenAI, completed can contain a file still processing (status uploaded). Poll files.retrieve using file.id until status processed (own face state active); error, expiry or 404 means processing failed and the file cannot be used.";
|
|
6292
|
+
readonly http: "POST";
|
|
6293
|
+
readonly path: "/file/v1/uploads/{upload_id}/complete";
|
|
6294
|
+
readonly streaming: "no";
|
|
6295
|
+
readonly pagination: false;
|
|
6296
|
+
readonly pathParams: readonly [{
|
|
6297
|
+
readonly name: "upload_id";
|
|
6298
|
+
readonly sdkName: "upload_id";
|
|
6299
|
+
}];
|
|
6300
|
+
readonly query: readonly [];
|
|
6301
|
+
readonly body: {
|
|
6302
|
+
readonly required: true;
|
|
6303
|
+
readonly fields: readonly [{
|
|
6304
|
+
readonly name: "part_ids";
|
|
6305
|
+
readonly type: "array";
|
|
6306
|
+
readonly itemType: "string";
|
|
6307
|
+
readonly required: true;
|
|
6308
|
+
readonly description: "All part IDs in concatenation order, without duplicates. Fixed-size uploads require increasing part_number order.";
|
|
6309
|
+
}, {
|
|
6310
|
+
readonly name: "md5";
|
|
6311
|
+
readonly type: "string";
|
|
6312
|
+
readonly required: false;
|
|
6313
|
+
readonly description: "Optional whole-file MD5 as 32 hexadecimal characters; verified after assembly.";
|
|
6314
|
+
}];
|
|
6315
|
+
};
|
|
6316
|
+
}, {
|
|
6317
|
+
readonly resource: "file.uploads.parts";
|
|
6318
|
+
readonly method: "create";
|
|
6319
|
+
readonly summary: "Add an upload part";
|
|
6320
|
+
readonly description: "Send one nonempty part as the multipart data field, at most 64000000 bytes. Parts may arrive concurrently in any order. Use upload_id from create. For a fixed-size upload, supply part_number starting at 1 and exactly part_size bytes except for the final remainder; retry the same number with identical bytes to recover its part ID. Without part_size, each request creates a new part and part_number is ignored. Save the returned part IDs for complete.";
|
|
6321
|
+
readonly http: "POST";
|
|
6322
|
+
readonly path: "/file/v1/uploads/{upload_id}/parts";
|
|
6323
|
+
readonly streaming: "no";
|
|
6324
|
+
readonly pagination: false;
|
|
6325
|
+
readonly multipart: true;
|
|
6326
|
+
readonly pathParams: readonly [{
|
|
6327
|
+
readonly name: "upload_id";
|
|
6328
|
+
readonly sdkName: "upload_id";
|
|
6329
|
+
}];
|
|
6330
|
+
readonly query: readonly [{
|
|
6331
|
+
readonly name: "part_number";
|
|
6332
|
+
readonly type: "integer";
|
|
6333
|
+
readonly required: false;
|
|
6334
|
+
readonly description: "Required when create set part_size; 1 through ceil(bytes / part_size). Ignored for general uploads.";
|
|
6335
|
+
}];
|
|
6336
|
+
readonly body: {
|
|
6337
|
+
readonly required: true;
|
|
6338
|
+
readonly fields: readonly [{
|
|
6339
|
+
readonly name: "data";
|
|
6340
|
+
readonly type: "string";
|
|
6341
|
+
readonly required: true;
|
|
6342
|
+
readonly description: "Raw bytes of this part, nonempty and at most 64000000 bytes.";
|
|
6343
|
+
}];
|
|
6344
|
+
};
|
|
6124
6345
|
}, {
|
|
6125
6346
|
readonly resource: "knowledge.vectorStores";
|
|
6126
6347
|
readonly method: "list";
|
|
@@ -9395,7 +9616,7 @@ export declare const operations: readonly [{
|
|
|
9395
9616
|
readonly name: "message";
|
|
9396
9617
|
readonly type: "string";
|
|
9397
9618
|
readonly required: true;
|
|
9398
|
-
readonly description: "Problem description
|
|
9619
|
+
readonly description: "Problem description, at most 4096 Unicode code points; may be empty only when contexts.praxis.error.message is a non-empty string.";
|
|
9399
9620
|
}, {
|
|
9400
9621
|
readonly name: "contact_email";
|
|
9401
9622
|
readonly type: "string";
|