@deepraxis/sdk 0.1.1-dev.d25d171 → 0.1.1-dev.ed5af3e
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 +26 -46
- package/dist/automation.d.ts +7 -0
- package/dist/core/client.d.ts +5 -1
- package/dist/core/client.js +10 -0
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +80 -88
- package/dist/generated/sdk.gen.js +171 -156
- package/dist/generated/types.gen.d.ts +2517 -2160
- package/dist/helpers/application-build.d.ts +10 -0
- package/dist/helpers/application-build.js +98 -0
- package/dist/helpers/application-publish.d.ts +8 -0
- package/dist/helpers/application-publish.js +26 -9
- package/dist/helpers/browser-connect.d.ts +78 -0
- package/dist/helpers/browser-connect.js +161 -0
- package/dist/helpers/browser-decisions.d.ts +44 -0
- package/dist/helpers/browser-decisions.js +84 -0
- package/dist/helpers/browser-documentation.d.ts +2 -0
- package/dist/helpers/browser-documentation.js +47 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +2 -0
- package/dist/operations.generated.d.ts +274 -270
- package/dist/operations.generated.js +327 -307
- package/dist/resources.generated.d.ts +190 -355
- package/dist/resources.generated.js +15 -25
- package/package.json +1 -1
|
@@ -84,7 +84,7 @@ export declare const operations: readonly [{
|
|
|
84
84
|
readonly name: "multiagent";
|
|
85
85
|
readonly type: "object";
|
|
86
86
|
readonly required: false;
|
|
87
|
-
readonly description: "A
|
|
87
|
+
readonly description: "Coordinator roster. A bare string agent id is equivalent to {type: \"agent\", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: \"self\"} refers to this agent. Specify a concrete version to pin it explicitly.";
|
|
88
88
|
}, {
|
|
89
89
|
readonly name: "skills";
|
|
90
90
|
readonly type: "array";
|
|
@@ -107,7 +107,7 @@ export declare const operations: readonly [{
|
|
|
107
107
|
readonly type: "array";
|
|
108
108
|
readonly itemType: "object";
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.";
|
|
110
|
+
readonly description: "Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "kind";
|
|
113
113
|
readonly type: "string";
|
|
@@ -124,6 +124,11 @@ export declare const operations: readonly [{
|
|
|
124
124
|
readonly type: "string";
|
|
125
125
|
readonly required: false;
|
|
126
126
|
readonly description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.";
|
|
127
|
+
}, {
|
|
128
|
+
readonly name: "image_model";
|
|
129
|
+
readonly type: "string";
|
|
130
|
+
readonly required: false;
|
|
131
|
+
readonly description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.";
|
|
127
132
|
}, {
|
|
128
133
|
readonly name: "subagents";
|
|
129
134
|
readonly type: "array";
|
|
@@ -174,7 +179,7 @@ export declare const operations: readonly [{
|
|
|
174
179
|
readonly resource: "agent.agents";
|
|
175
180
|
readonly method: "retrieve";
|
|
176
181
|
readonly summary: "Get agent";
|
|
177
|
-
readonly description: "Read
|
|
182
|
+
readonly description: "Read the agent configuration currently effective for new sessions. By default, version equals active_version and latest_version identifies the newest saved version, including an unapplied save. Use latest_version for optimistic concurrency when updating. Pass version as a positive integer to read that saved version; version=active is equivalent to omission. The response lists every native tool with its resolved configuration in one agent_toolset_20260401 entry, so tools can be sent back unchanged to agents.update. Use agents.versions.list to enumerate saved versions.";
|
|
178
183
|
readonly http: "GET";
|
|
179
184
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
180
185
|
readonly streaming: "no";
|
|
@@ -188,13 +193,13 @@ export declare const operations: readonly [{
|
|
|
188
193
|
readonly name: "version";
|
|
189
194
|
readonly type: "number";
|
|
190
195
|
readonly required: false;
|
|
191
|
-
readonly description: "Agent version to read
|
|
196
|
+
readonly description: "Agent version to read. Omit, or send active, for the currently effective version used by new sessions. Send an integer of at least 1 from agents.versions.list to read that saved version. The default response also includes latest_version, the newest saved version number.";
|
|
192
197
|
}];
|
|
193
198
|
}, {
|
|
194
199
|
readonly resource: "agent.agents";
|
|
195
200
|
readonly method: "update";
|
|
196
201
|
readonly summary: "Update agent";
|
|
197
|
-
readonly description: "
|
|
202
|
+
readonly description: "Save configuration changes as a new immutable version. Send latest_version from a default retrieve or update response as the request version for optimistic concurrency; a stale value returns 409. apply defaults to true and makes the new version effective; apply false saves without changing active_version. The response contains the effective configuration, with version equal to active_version and latest_version naming the newest saved version. An unchanged configuration, including a note-only update, is a no-op returning 200 and the current effective version without creating or activating a version. version_note records up to 280 characters only when a configuration change creates a new version; null is equivalent to omission. Use agents.versions.apply to activate an existing saved version. Existing sessions and tokens keep their version. Omitted fields keep their value. multiagent takes null or a coordinator roster; subagent_model keeps its value when omitted and is cleared by null. Archived agents cannot be updated. tools: [] removes every tool, while tools: null returns 400 (tools cannot be null; send [] to remove every tool). On update, omit skills to keep them, send an array to replace them, or send [] or null to clear them. skills attaches uploaded custom skills as [{type: \"custom\", skill_id, version?}] (skill_id from skills.create or skills.list; at most 20, no repeated skill_id). Omit version, or send \"latest\", to use the skill's newest version when a session starts. type anthropic returns 400.";
|
|
198
203
|
readonly http: "POST";
|
|
199
204
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
200
205
|
readonly streaming: "no";
|
|
@@ -232,7 +237,7 @@ export declare const operations: readonly [{
|
|
|
232
237
|
readonly name: "multiagent";
|
|
233
238
|
readonly type: "object";
|
|
234
239
|
readonly required: false;
|
|
235
|
-
readonly description: "A
|
|
240
|
+
readonly description: "Coordinator roster. A bare string agent id is equivalent to {type: \"agent\", id}; omitting its version pins the referenced agent's current saved version when this roster is saved. {type: \"self\"} refers to this agent. Specify a concrete version to pin it explicitly.";
|
|
236
241
|
}, {
|
|
237
242
|
readonly name: "name";
|
|
238
243
|
readonly type: "string";
|
|
@@ -259,17 +264,17 @@ export declare const operations: readonly [{
|
|
|
259
264
|
readonly name: "version";
|
|
260
265
|
readonly type: "number";
|
|
261
266
|
readonly required: false;
|
|
262
|
-
readonly description: "
|
|
267
|
+
readonly description: "Newest saved version used for optimistic concurrency. Obtain latest_version from the default retrieve or update response, or version from versions.list. A stale value returns 409; omit for an unconditional update.";
|
|
263
268
|
}, {
|
|
264
269
|
readonly name: "apply";
|
|
265
270
|
readonly type: "boolean";
|
|
266
271
|
readonly required: false;
|
|
267
|
-
readonly description: "Defaults to true: apply
|
|
272
|
+
readonly description: "Defaults to true: apply a newly saved configuration version. Set false to save without changing active_version. An unchanged configuration is a no-op, including note-only updates; use versions.apply to activate a saved version.";
|
|
268
273
|
}, {
|
|
269
274
|
readonly name: "version_note";
|
|
270
275
|
readonly type: "string";
|
|
271
276
|
readonly required: false;
|
|
272
|
-
readonly description: "Optional change explanation
|
|
277
|
+
readonly description: "Optional change explanation, at most 280 characters. Recorded only when a configuration change creates a new immutable version. A note-only update is a no-op returning 200 and the current effective version. Null is equivalent to omission.";
|
|
273
278
|
}, {
|
|
274
279
|
readonly name: "bindings";
|
|
275
280
|
readonly type: "array";
|
|
@@ -292,6 +297,11 @@ export declare const operations: readonly [{
|
|
|
292
297
|
readonly type: "string";
|
|
293
298
|
readonly required: false;
|
|
294
299
|
readonly description: "Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.";
|
|
300
|
+
}, {
|
|
301
|
+
readonly name: "image_model";
|
|
302
|
+
readonly type: "string";
|
|
303
|
+
readonly required: false;
|
|
304
|
+
readonly description: "Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.";
|
|
295
305
|
}, {
|
|
296
306
|
readonly name: "subagents";
|
|
297
307
|
readonly type: "array";
|
|
@@ -338,6 +348,21 @@ export declare const operations: readonly [{
|
|
|
338
348
|
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.";
|
|
339
349
|
}];
|
|
340
350
|
};
|
|
351
|
+
}, {
|
|
352
|
+
readonly resource: "agent.agents";
|
|
353
|
+
readonly method: "retrieveAppearance";
|
|
354
|
+
readonly summary: "Get agent appearance";
|
|
355
|
+
readonly description: "Read the saved chat appearance of a service agent.\n\nAgent Kit calls this from the page with a customer access token of this agent; your API key and console members can read it too. A token of another agent returns 404. The body is the same as the embed appearance read; a missing appearance returns the agent's own name and avatar only. Responses are private and cacheable for 60 seconds.";
|
|
356
|
+
readonly http: "GET";
|
|
357
|
+
readonly path: "/agent/v1/agents/{agent_id}/appearance";
|
|
358
|
+
readonly streaming: "no";
|
|
359
|
+
readonly pagination: false;
|
|
360
|
+
readonly pathParams: readonly [{
|
|
361
|
+
readonly name: "agent_id";
|
|
362
|
+
readonly sdkName: "agent_id";
|
|
363
|
+
readonly description: "Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.";
|
|
364
|
+
}];
|
|
365
|
+
readonly query: readonly [];
|
|
341
366
|
}, {
|
|
342
367
|
readonly resource: "agent.agents";
|
|
343
368
|
readonly method: "archive";
|
|
@@ -353,6 +378,47 @@ export declare const operations: readonly [{
|
|
|
353
378
|
readonly description: "Agent id, as returned by agents.create or agents.list (for a session filter, the agent the session was created with). Not the agent name.";
|
|
354
379
|
}];
|
|
355
380
|
readonly query: readonly [];
|
|
381
|
+
}, {
|
|
382
|
+
readonly resource: "agent.agents.customers";
|
|
383
|
+
readonly method: "list";
|
|
384
|
+
readonly summary: "List customers";
|
|
385
|
+
readonly description: "List the customers of a service agent, identified and anonymous, most recently seen first.\n\nCall this from your backend with your API key, or from the console. Customers follow Shopify Admin customers (list, retrieve, block, sign-out and data deletion of the people who use your storefront), so that experience applies. The list includes customers who signed in but have not started a session yet, and customers recorded under your own ids by embed tokens before customer sign-in existed; an id first seen that way is identified unless it starts with anon_. Unlike Shopify, a customer can be anonymous: a visitor admitted with the publishable key gets an anon_ id, and when it later signs in with anonymous_access_token it is merged: merged_into names the identified customer, and its sessions count toward that customer. Filter with q (a case-sensitive customer id prefix), type (identified or anonymous) and blocked (true or false). limit is 1 to 100, default 20; reuse next_page with the same filters and limit. A customer access token gets 404. Example: GET /agent/v1/agents/agent_example/customers?type=identified&blocked=false&limit=50.";
|
|
386
|
+
readonly http: "GET";
|
|
387
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers";
|
|
388
|
+
readonly streaming: "no";
|
|
389
|
+
readonly pagination: false;
|
|
390
|
+
readonly pathParams: readonly [{
|
|
391
|
+
readonly name: "agent_id";
|
|
392
|
+
readonly sdkName: "agent_id";
|
|
393
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
394
|
+
}];
|
|
395
|
+
readonly query: readonly [{
|
|
396
|
+
readonly name: "limit";
|
|
397
|
+
readonly type: "integer";
|
|
398
|
+
readonly required: false;
|
|
399
|
+
readonly description: "Maximum customers per page, 1 to 100; defaults to 20.";
|
|
400
|
+
}, {
|
|
401
|
+
readonly name: "page";
|
|
402
|
+
readonly type: "string";
|
|
403
|
+
readonly required: false;
|
|
404
|
+
readonly description: "next_page from the previous response with the same q, type, blocked and limit.";
|
|
405
|
+
}, {
|
|
406
|
+
readonly name: "q";
|
|
407
|
+
readonly type: "string";
|
|
408
|
+
readonly required: false;
|
|
409
|
+
readonly description: "Case-sensitive literal prefix of the customer id; omit for all customers.";
|
|
410
|
+
}, {
|
|
411
|
+
readonly name: "type";
|
|
412
|
+
readonly type: "string";
|
|
413
|
+
readonly enum: readonly ["identified", "anonymous"];
|
|
414
|
+
readonly required: false;
|
|
415
|
+
readonly description: "Only identified or only anonymous customers; omit for both.";
|
|
416
|
+
}, {
|
|
417
|
+
readonly name: "blocked";
|
|
418
|
+
readonly type: "boolean";
|
|
419
|
+
readonly required: false;
|
|
420
|
+
readonly description: "true for blocked customers only, false for customers who are not blocked; omit for both.";
|
|
421
|
+
}];
|
|
356
422
|
}, {
|
|
357
423
|
readonly resource: "agent.agents.customers.auth.accessTokens";
|
|
358
424
|
readonly method: "create";
|
|
@@ -478,152 +544,122 @@ export declare const operations: readonly [{
|
|
|
478
544
|
}];
|
|
479
545
|
};
|
|
480
546
|
}, {
|
|
481
|
-
readonly resource: "agent.agents.
|
|
482
|
-
readonly method: "list";
|
|
483
|
-
readonly summary: "List End Users";
|
|
484
|
-
readonly description: "List users who have sessions or token issuance history on a service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.";
|
|
485
|
-
readonly http: "GET";
|
|
486
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users";
|
|
487
|
-
readonly streaming: "no";
|
|
488
|
-
readonly pagination: false;
|
|
489
|
-
readonly pathParams: readonly [{
|
|
490
|
-
readonly name: "agent_id";
|
|
491
|
-
readonly sdkName: "agent_id";
|
|
492
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
493
|
-
}];
|
|
494
|
-
readonly query: readonly [{
|
|
495
|
-
readonly name: "limit";
|
|
496
|
-
readonly type: "integer";
|
|
497
|
-
readonly required: false;
|
|
498
|
-
readonly description: "Maximum users per page; defaults to 20.";
|
|
499
|
-
}, {
|
|
500
|
-
readonly name: "page";
|
|
501
|
-
readonly type: "string";
|
|
502
|
-
readonly required: false;
|
|
503
|
-
readonly description: "next_page from the previous response with the same agent, q and limit.";
|
|
504
|
-
}, {
|
|
505
|
-
readonly name: "q";
|
|
506
|
-
readonly type: "string";
|
|
507
|
-
readonly required: false;
|
|
508
|
-
readonly description: "Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.";
|
|
509
|
-
}];
|
|
510
|
-
}, {
|
|
511
|
-
readonly resource: "agent.agents.endUsers";
|
|
547
|
+
readonly resource: "agent.agents.customers";
|
|
512
548
|
readonly method: "delete";
|
|
513
|
-
readonly summary: "Delete
|
|
514
|
-
readonly description: "Delete a
|
|
549
|
+
readonly summary: "Delete customer data";
|
|
550
|
+
readonly description: "Delete a customer's data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact customer id; a missing or different confirm returns 400 naming the value to send. Returns 202 with a pending task id; poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the customer is blocked before a seven-day recovery snapshot is verified; sessions including child sessions, conversation data, grants and feedback are then removed. A block that existed before stays; a temporary block is removed on success. File attachments are retained. Example: DELETE /agent/v1/agents/agent_example/customers/cus_8f2a91?confirm=cus_8f2a91.";
|
|
515
551
|
readonly http: "DELETE";
|
|
516
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
552
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}";
|
|
517
553
|
readonly streaming: "no";
|
|
518
554
|
readonly pagination: false;
|
|
519
555
|
readonly pathParams: readonly [{
|
|
520
556
|
readonly name: "agent_id";
|
|
521
557
|
readonly sdkName: "agent_id";
|
|
522
|
-
readonly description: "Active service agent
|
|
558
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
523
559
|
}, {
|
|
524
|
-
readonly name: "
|
|
525
|
-
readonly sdkName: "
|
|
526
|
-
readonly description: "
|
|
560
|
+
readonly name: "customer_id";
|
|
561
|
+
readonly sdkName: "customer_id";
|
|
562
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
527
563
|
}];
|
|
528
564
|
readonly query: readonly [{
|
|
529
565
|
readonly name: "confirm";
|
|
530
566
|
readonly type: "string";
|
|
531
567
|
readonly required: true;
|
|
532
|
-
readonly description: "Must
|
|
568
|
+
readonly description: "Must equal the customer_id path parameter exactly, confirming the destructive deletion.";
|
|
533
569
|
}];
|
|
534
570
|
}, {
|
|
535
|
-
readonly resource: "agent.agents.
|
|
571
|
+
readonly resource: "agent.agents.customers";
|
|
536
572
|
readonly method: "retrieve";
|
|
537
|
-
readonly summary: "Get
|
|
538
|
-
readonly description: "
|
|
573
|
+
readonly summary: "Get customer";
|
|
574
|
+
readonly description: "Retrieve one customer of a service agent with its twenty most recently updated sessions.\n\nUse the customer id from the list or your own customer_id. An unknown customer returns 404 CUSTOMER_NOT_FOUND, and so does a customer access token. Unlike Shopify, an identified customer's session_count, cost and recent_sessions include the sessions of anonymous customers merged into it; the merged anonymous customer still shows its own sessions and its merged_into.";
|
|
539
575
|
readonly http: "GET";
|
|
540
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
576
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}";
|
|
541
577
|
readonly streaming: "no";
|
|
542
578
|
readonly pagination: false;
|
|
543
579
|
readonly pathParams: readonly [{
|
|
544
580
|
readonly name: "agent_id";
|
|
545
581
|
readonly sdkName: "agent_id";
|
|
546
|
-
readonly description: "Active service agent
|
|
582
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
547
583
|
}, {
|
|
548
|
-
readonly name: "
|
|
549
|
-
readonly sdkName: "
|
|
550
|
-
readonly description: "
|
|
584
|
+
readonly name: "customer_id";
|
|
585
|
+
readonly sdkName: "customer_id";
|
|
586
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
551
587
|
}];
|
|
552
588
|
readonly query: readonly [];
|
|
553
589
|
}, {
|
|
554
|
-
readonly resource: "agent.agents.
|
|
590
|
+
readonly resource: "agent.agents.customers.block";
|
|
555
591
|
readonly method: "create";
|
|
556
|
-
readonly summary: "Block
|
|
557
|
-
readonly description: "Block
|
|
592
|
+
readonly summary: "Block customer";
|
|
593
|
+
readonly description: "Block a customer and end every sign-in it has on this agent.\n\nBlocks the customer, then ends every live sign-in the way logout does: each access token is revoked and its open event streams close. From then on grant_codes, access_tokens, renew and new sessions for this customer return CUSTOMER_BLOCKED until you unblock it. Idempotent: a repeat keeps the first block time and revokes whatever is still live. If credential revocation fails the request returns 502 and the customer stays blocked; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
|
|
558
594
|
readonly http: "POST";
|
|
559
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
595
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/block";
|
|
560
596
|
readonly streaming: "no";
|
|
561
597
|
readonly pagination: false;
|
|
562
598
|
readonly pathParams: readonly [{
|
|
563
599
|
readonly name: "agent_id";
|
|
564
600
|
readonly sdkName: "agent_id";
|
|
565
|
-
readonly description: "Active service agent
|
|
601
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
566
602
|
}, {
|
|
567
|
-
readonly name: "
|
|
568
|
-
readonly sdkName: "
|
|
569
|
-
readonly description: "
|
|
603
|
+
readonly name: "customer_id";
|
|
604
|
+
readonly sdkName: "customer_id";
|
|
605
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
570
606
|
}];
|
|
571
607
|
readonly query: readonly [];
|
|
572
608
|
}, {
|
|
573
|
-
readonly resource: "agent.agents.
|
|
609
|
+
readonly resource: "agent.agents.customers";
|
|
574
610
|
readonly method: "retrieveDeletion";
|
|
575
|
-
readonly summary: "Get
|
|
576
|
-
readonly description: "Poll the latest deletion task
|
|
611
|
+
readonly summary: "Get customer deletion";
|
|
612
|
+
readonly description: "Poll the latest deletion task of a customer, including after its data has been removed.\n\nUse the same agent_id and customer id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. snapshot_key is an operator recovery reference retained for seven days, not a download URL. A customer access token and a missing task return 404.";
|
|
577
613
|
readonly http: "GET";
|
|
578
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
614
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion";
|
|
579
615
|
readonly streaming: "no";
|
|
580
616
|
readonly pagination: false;
|
|
581
617
|
readonly pathParams: readonly [{
|
|
582
618
|
readonly name: "agent_id";
|
|
583
619
|
readonly sdkName: "agent_id";
|
|
584
|
-
readonly description: "Active service agent
|
|
620
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
585
621
|
}, {
|
|
586
|
-
readonly name: "
|
|
587
|
-
readonly sdkName: "
|
|
588
|
-
readonly description: "
|
|
622
|
+
readonly name: "customer_id";
|
|
623
|
+
readonly sdkName: "customer_id";
|
|
624
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
589
625
|
}];
|
|
590
626
|
readonly query: readonly [];
|
|
591
627
|
}, {
|
|
592
|
-
readonly resource: "agent.agents.
|
|
628
|
+
readonly resource: "agent.agents.customers.revokeTokens";
|
|
593
629
|
readonly method: "create";
|
|
594
|
-
readonly summary: "Revoke
|
|
595
|
-
readonly description: "
|
|
630
|
+
readonly summary: "Revoke customer tokens";
|
|
631
|
+
readonly description: "Sign a customer out everywhere without blocking it.\n\nEnds every live sign-in of the customer, revoking each access token and closing its open event streams; the customer can sign in again right away. Returns the number of access tokens this request revoked; a repeat returns 0. Credential revocation failure returns 502; retry to finish. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
|
|
596
632
|
readonly http: "POST";
|
|
597
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
633
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens";
|
|
598
634
|
readonly streaming: "no";
|
|
599
635
|
readonly pagination: false;
|
|
600
636
|
readonly pathParams: readonly [{
|
|
601
637
|
readonly name: "agent_id";
|
|
602
638
|
readonly sdkName: "agent_id";
|
|
603
|
-
readonly description: "Active service agent
|
|
639
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
604
640
|
}, {
|
|
605
|
-
readonly name: "
|
|
606
|
-
readonly sdkName: "
|
|
607
|
-
readonly description: "
|
|
641
|
+
readonly name: "customer_id";
|
|
642
|
+
readonly sdkName: "customer_id";
|
|
643
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
608
644
|
}];
|
|
609
645
|
readonly query: readonly [];
|
|
610
646
|
}, {
|
|
611
|
-
readonly resource: "agent.agents.
|
|
647
|
+
readonly resource: "agent.agents.customers.unblock";
|
|
612
648
|
readonly method: "create";
|
|
613
|
-
readonly summary: "Unblock
|
|
614
|
-
readonly description: "Allow
|
|
649
|
+
readonly summary: "Unblock customer";
|
|
650
|
+
readonly description: "Allow a blocked customer to sign in and start sessions again.\n\nIdempotent. Access tokens revoked while the customer was blocked stay revoked; sign the customer in again with a new grant code. An unknown customer returns 404 CUSTOMER_NOT_FOUND.";
|
|
615
651
|
readonly http: "POST";
|
|
616
|
-
readonly path: "/agent/v1/agents/{agent_id}/
|
|
652
|
+
readonly path: "/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock";
|
|
617
653
|
readonly streaming: "no";
|
|
618
654
|
readonly pagination: false;
|
|
619
655
|
readonly pathParams: readonly [{
|
|
620
656
|
readonly name: "agent_id";
|
|
621
657
|
readonly sdkName: "agent_id";
|
|
622
|
-
readonly description: "Active service agent
|
|
658
|
+
readonly description: "Active service agent id from agent creation or listing.";
|
|
623
659
|
}, {
|
|
624
|
-
readonly name: "
|
|
625
|
-
readonly sdkName: "
|
|
626
|
-
readonly description: "
|
|
660
|
+
readonly name: "customer_id";
|
|
661
|
+
readonly sdkName: "customer_id";
|
|
662
|
+
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
627
663
|
}];
|
|
628
664
|
readonly query: readonly [];
|
|
629
665
|
}, {
|
|
@@ -645,7 +681,7 @@ export declare const operations: readonly [{
|
|
|
645
681
|
readonly resource: "agent.agents.versions";
|
|
646
682
|
readonly method: "list";
|
|
647
683
|
readonly summary: "List agent versions";
|
|
648
|
-
readonly description: "List the saved versions of one agent, in pages of at most 100 (default 20). Each item is the full agent definition at that version, so you can compare
|
|
684
|
+
readonly description: "List the saved versions of one agent in ascending version number, oldest first, in pages of at most 100 (default 20). Each item is the full agent definition at that saved version, so you can compare configurations. active is true only for the item new sessions use. active_version on every item is the same agent-level currently effective version; it is not that item's version. Use agents.retrieve with version to read a single saved version; agent_id comes from agents.list or agents.create. Pass next_page as page to continue.";
|
|
649
685
|
readonly http: "GET";
|
|
650
686
|
readonly path: "/agent/v1/agents/{agent_id}/versions";
|
|
651
687
|
readonly streaming: "no";
|
|
@@ -670,7 +706,7 @@ export declare const operations: readonly [{
|
|
|
670
706
|
readonly resource: "agent.agents.versions";
|
|
671
707
|
readonly method: "apply";
|
|
672
708
|
readonly summary: "Apply Agent Version";
|
|
673
|
-
readonly description: "Apply a version from agents.versions.list
|
|
709
|
+
readonly description: "Apply a saved version from agents.versions.list for new sessions and newly issued tokens, without creating a version. Existing sessions and tokens retain their version. The response contains the effective configuration with version equal to active_version and latest_version naming the newest saved version. Missing versions return 404; archived agents return 409. For example, POST /agent/v1/agents/{agent_id}/versions/2/apply with no body.";
|
|
674
710
|
readonly http: "POST";
|
|
675
711
|
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
676
712
|
readonly streaming: "no";
|
|
@@ -1274,175 +1310,6 @@ export declare const operations: readonly [{
|
|
|
1274
1310
|
readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
|
|
1275
1311
|
}];
|
|
1276
1312
|
readonly query: readonly [];
|
|
1277
|
-
}, {
|
|
1278
|
-
readonly resource: "agent.embed";
|
|
1279
|
-
readonly method: "retrieveAppearance";
|
|
1280
|
-
readonly summary: "Read chat appearance";
|
|
1281
|
-
readonly description: "Load saved appearance for an iframe or Hosted chat page. Supply an end-user embed token as Bearer authorization, or a console-issued publishable key in Praxis-Publishable-Key before anonymous token issuance. The credential selects the agent; identity_number and agent_id query parameters are rejected with 400. Missing appearance returns an empty object. Kit option names retain camelCase. Responses are private and cacheable for 60 seconds. Component hosts configure Kit in their own code instead.";
|
|
1282
|
-
readonly http: "GET";
|
|
1283
|
-
readonly path: "/agent/v1/embed/appearance";
|
|
1284
|
-
readonly streaming: "no";
|
|
1285
|
-
readonly pagination: false;
|
|
1286
|
-
readonly pathParams: readonly [];
|
|
1287
|
-
readonly query: readonly [];
|
|
1288
|
-
}, {
|
|
1289
|
-
readonly resource: "agent.embed.exchange";
|
|
1290
|
-
readonly method: "create";
|
|
1291
|
-
readonly summary: "Exchange Hosted Code";
|
|
1292
|
-
readonly description: "Redeem a single-use hosted link credential for an end-user token.\n\nRead code from the c fragment parameter of hosted_url returned by embed token creation with hosted true, then remove the fragment before exchanging. No Authorization header is required; the code authenticates this request. The code expires after 60 seconds and is consumed atomically on exchange, so concurrent attempts have only one winner. Expired, used and unknown codes return the same 404 body. Keep the token in memory and return to the host website for a fresh link when it expires; exchange cannot refresh it. Requests are IP limited per minute using the anonymous entrypoint budget (default 20). Example body is {\"code\":\"<code from hosted_url>\"}.";
|
|
1293
|
-
readonly http: "POST";
|
|
1294
|
-
readonly path: "/agent/v1/embed/exchange";
|
|
1295
|
-
readonly streaming: "no";
|
|
1296
|
-
readonly pagination: false;
|
|
1297
|
-
readonly pathParams: readonly [];
|
|
1298
|
-
readonly query: readonly [];
|
|
1299
|
-
readonly body: {
|
|
1300
|
-
readonly required: true;
|
|
1301
|
-
readonly fields: readonly [{
|
|
1302
|
-
readonly name: "code";
|
|
1303
|
-
readonly type: "string";
|
|
1304
|
-
readonly required: true;
|
|
1305
|
-
readonly description: "Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.";
|
|
1306
|
-
}];
|
|
1307
|
-
};
|
|
1308
|
-
}, {
|
|
1309
|
-
readonly resource: "agent.embedTokens";
|
|
1310
|
-
readonly method: "list";
|
|
1311
|
-
readonly summary: "List Embed Tokens";
|
|
1312
|
-
readonly description: "List embed token issuance records in your organization.\n\nIncludes expired and revoked grants; returns neither token nor token_id. Sorts by created_at, then grant id, both descending. agent_id accepts agent_ or agt_; external_user_id matches exactly. limit is 1–100 (default 20). Reuse next_page as page with the same filters and organization; a mismatch returns 400. End-user credentials return 404.";
|
|
1313
|
-
readonly http: "GET";
|
|
1314
|
-
readonly path: "/agent/v1/embed_tokens";
|
|
1315
|
-
readonly streaming: "no";
|
|
1316
|
-
readonly pagination: false;
|
|
1317
|
-
readonly pathParams: readonly [];
|
|
1318
|
-
readonly query: readonly [{
|
|
1319
|
-
readonly name: "agent_id";
|
|
1320
|
-
readonly type: "string";
|
|
1321
|
-
readonly required: false;
|
|
1322
|
-
readonly description: "Filter by service agent identifier (agent_ or agt_ prefix).";
|
|
1323
|
-
}, {
|
|
1324
|
-
readonly name: "external_user_id";
|
|
1325
|
-
readonly type: "string";
|
|
1326
|
-
readonly required: false;
|
|
1327
|
-
readonly description: "Exact host user identifier supplied at issuance.";
|
|
1328
|
-
}, {
|
|
1329
|
-
readonly name: "limit";
|
|
1330
|
-
readonly type: "integer";
|
|
1331
|
-
readonly required: false;
|
|
1332
|
-
readonly description: "Maximum records per page; defaults to 20.";
|
|
1333
|
-
}, {
|
|
1334
|
-
readonly name: "page";
|
|
1335
|
-
readonly type: "string";
|
|
1336
|
-
readonly required: false;
|
|
1337
|
-
readonly description: "next_page from a previous response with the same filters.";
|
|
1338
|
-
}];
|
|
1339
|
-
}, {
|
|
1340
|
-
readonly resource: "agent.embedTokens";
|
|
1341
|
-
readonly method: "create";
|
|
1342
|
-
readonly summary: "Create Embed Token";
|
|
1343
|
-
readonly description: "Issue a short-lived credential on your backend for an end user of a service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.";
|
|
1344
|
-
readonly http: "POST";
|
|
1345
|
-
readonly path: "/agent/v1/embed_tokens";
|
|
1346
|
-
readonly streaming: "no";
|
|
1347
|
-
readonly pagination: false;
|
|
1348
|
-
readonly pathParams: readonly [];
|
|
1349
|
-
readonly query: readonly [];
|
|
1350
|
-
readonly body: {
|
|
1351
|
-
readonly required: true;
|
|
1352
|
-
readonly fields: readonly [{
|
|
1353
|
-
readonly name: "hosted";
|
|
1354
|
-
readonly type: "boolean";
|
|
1355
|
-
readonly required: false;
|
|
1356
|
-
readonly description: "Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number.";
|
|
1357
|
-
}, {
|
|
1358
|
-
readonly name: "agent";
|
|
1359
|
-
readonly type: "string";
|
|
1360
|
-
readonly required: true;
|
|
1361
|
-
readonly description: "Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.";
|
|
1362
|
-
}, {
|
|
1363
|
-
readonly name: "version";
|
|
1364
|
-
readonly type: "integer";
|
|
1365
|
-
readonly required: false;
|
|
1366
|
-
readonly description: "Existing agent version to pin. Omit to pin the latest version at issuance.";
|
|
1367
|
-
}, {
|
|
1368
|
-
readonly name: "external_user_id";
|
|
1369
|
-
readonly type: "string";
|
|
1370
|
-
readonly required: true;
|
|
1371
|
-
readonly description: "Your application's stable end-user identifier, scoped to this organization and agent.";
|
|
1372
|
-
}, {
|
|
1373
|
-
readonly name: "ttl_seconds";
|
|
1374
|
-
readonly type: "integer";
|
|
1375
|
-
readonly required: false;
|
|
1376
|
-
readonly description: "Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds.";
|
|
1377
|
-
}, {
|
|
1378
|
-
readonly name: "budget_cents";
|
|
1379
|
-
readonly type: "integer";
|
|
1380
|
-
readonly required: false;
|
|
1381
|
-
readonly description: "Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum.";
|
|
1382
|
-
}, {
|
|
1383
|
-
readonly name: "system_message";
|
|
1384
|
-
readonly type: "array";
|
|
1385
|
-
readonly itemType: "object";
|
|
1386
|
-
readonly required: false;
|
|
1387
|
-
readonly description: "Optional host context as text blocks, limited to 8192 UTF-8 bytes in total.";
|
|
1388
|
-
}, {
|
|
1389
|
-
readonly name: "agent_override";
|
|
1390
|
-
readonly type: "object";
|
|
1391
|
-
readonly required: false;
|
|
1392
|
-
readonly description: "Optional system prompt override, accepted only when the embed policy allows agent overrides.";
|
|
1393
|
-
}, {
|
|
1394
|
-
readonly name: "allowed_origins";
|
|
1395
|
-
readonly type: "array";
|
|
1396
|
-
readonly itemType: "string";
|
|
1397
|
-
readonly required: false;
|
|
1398
|
-
readonly description: "Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin.";
|
|
1399
|
-
}, {
|
|
1400
|
-
readonly name: "metadata";
|
|
1401
|
-
readonly type: "object";
|
|
1402
|
-
readonly required: false;
|
|
1403
|
-
readonly description: "Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object.";
|
|
1404
|
-
}];
|
|
1405
|
-
};
|
|
1406
|
-
}, {
|
|
1407
|
-
readonly resource: "agent.embedTokens.anonymous";
|
|
1408
|
-
readonly method: "create";
|
|
1409
|
-
readonly summary: "Issue anonymous visitor token";
|
|
1410
|
-
readonly description: "Obtain a short-lived embedding token for a visitor without an account using the agent owner's publishable key.\n\nNo Authorization header is required. Send the browser Origin allowed by the agent policy. Save a returned visitor_secret and reuse it for refreshes; only new visitors receive one. Unknown secrets create new visitors, and extra fields including visitor_id return 400. Issuance uses the key creator's organization membership, the key session budget and the smaller of the policy TTL maximum and 3600 seconds. IP requests are limited per minute (default 20); UTC daily session and spending caps are checked across the key's primary sessions created that day. Token issuance itself does not create a session or charge usage; subsequent sessions bill the host organization. Example body: {\"publishable_key\":\"pk_praxis_example\"}.";
|
|
1411
|
-
readonly http: "POST";
|
|
1412
|
-
readonly path: "/agent/v1/embed_tokens/anonymous";
|
|
1413
|
-
readonly streaming: "no";
|
|
1414
|
-
readonly pagination: false;
|
|
1415
|
-
readonly pathParams: readonly [];
|
|
1416
|
-
readonly query: readonly [];
|
|
1417
|
-
readonly body: {
|
|
1418
|
-
readonly required: true;
|
|
1419
|
-
readonly fields: readonly [{
|
|
1420
|
-
readonly name: "publishable_key";
|
|
1421
|
-
readonly type: "string";
|
|
1422
|
-
readonly required: true;
|
|
1423
|
-
readonly description: "Public key created by the service agent owner; safe to include in browser code.";
|
|
1424
|
-
}, {
|
|
1425
|
-
readonly name: "visitor_secret";
|
|
1426
|
-
readonly type: "string";
|
|
1427
|
-
readonly required: false;
|
|
1428
|
-
readonly description: "Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.";
|
|
1429
|
-
}];
|
|
1430
|
-
};
|
|
1431
|
-
}, {
|
|
1432
|
-
readonly resource: "agent.embedTokens.revoke";
|
|
1433
|
-
readonly method: "create";
|
|
1434
|
-
readonly summary: "Revoke Embed Token";
|
|
1435
|
-
readonly description: "Revoke an embed token and close its open event streams.\n\nUse an id from issuance or listing. Revokes the credential before setting revoked_at; upstream failure leaves it unset. Streams receive session.error (EMBED_TOKEN_REVOKED), then close immediately; other credentials are unaffected. Idempotent; repeats return the original revoked record without another revocation or audit. Missing or foreign grants and end-user credentials return 404.";
|
|
1436
|
-
readonly http: "POST";
|
|
1437
|
-
readonly path: "/agent/v1/embed_tokens/{id}/revoke";
|
|
1438
|
-
readonly streaming: "no";
|
|
1439
|
-
readonly pagination: false;
|
|
1440
|
-
readonly pathParams: readonly [{
|
|
1441
|
-
readonly name: "id";
|
|
1442
|
-
readonly sdkName: "id";
|
|
1443
|
-
readonly description: "Grant id returned by issuance or listing.";
|
|
1444
|
-
}];
|
|
1445
|
-
readonly query: readonly [];
|
|
1446
1313
|
}, {
|
|
1447
1314
|
readonly resource: "agent.environments";
|
|
1448
1315
|
readonly method: "list";
|
|
@@ -1669,7 +1536,7 @@ export declare const operations: readonly [{
|
|
|
1669
1536
|
readonly resource: "agent.sessions";
|
|
1670
1537
|
readonly method: "create";
|
|
1671
1538
|
readonly summary: "Create session";
|
|
1672
|
-
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, 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. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive
|
|
1539
|
+
readonly description: "Create a session: one conversation with an agent. Pass agent as an agent id or {type:\"agent\", id, version?}; an id alone, or an object without version, pins the agent's active_version (the version chosen with agents.versions.apply, not necessarily the newest saved one). Unlike Anthropic Managed Agents, omit environment_id to use the default environment saved in the agent version (light for a new agent), unless computer_id (explicit, or the agent's default) selects a Computer; pass an environment id for a sandbox recipe. For service agents, 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. Unlike Anthropic Managed Agents, the only inline agent override is system ({type:\"agent_with_overrides\", id, system}); to change the model, tools, MCP servers or skills, save a version instead. Supports vault_ids, up to 50, owned by the current organization and not archived; credential injection is deferred to a later version. budget is {type:\"limit\", max_list_cost:{amount, currency:\"USD\"}} where amount is a positive decimal string of US dollars with at most 2 decimal places (\"20.00\" is USD 20.00); omitted budget defaults to \"20.00\" and null removes the limit. 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.";
|
|
1673
1540
|
readonly http: "POST";
|
|
1674
1541
|
readonly path: "/agent/v1/sessions";
|
|
1675
1542
|
readonly streaming: "no";
|
|
@@ -2123,9 +1990,9 @@ export declare const operations: readonly [{
|
|
|
2123
1990
|
}];
|
|
2124
1991
|
readonly query: readonly [{
|
|
2125
1992
|
readonly name: "limit";
|
|
2126
|
-
readonly type: "
|
|
1993
|
+
readonly type: "integer";
|
|
2127
1994
|
readonly required: false;
|
|
2128
|
-
readonly description: "Number of
|
|
1995
|
+
readonly description: "Number of resources per page, from 1 to 100; defaults to 100.";
|
|
2129
1996
|
}, {
|
|
2130
1997
|
readonly name: "page";
|
|
2131
1998
|
readonly type: "string";
|
|
@@ -3241,7 +3108,7 @@ export declare const operations: readonly [{
|
|
|
3241
3108
|
readonly resource: "automation.actions";
|
|
3242
3109
|
readonly method: "list";
|
|
3243
3110
|
readonly summary: "List actions";
|
|
3244
|
-
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default.";
|
|
3111
|
+
readonly description: "Discover callable Actions and their ns/name references without executing them. Combine each returned namespace and name as ns/name; Action calls use the current revision and do not accept @version or @tag. Filter by name or description; results include seven-day statistics and revision summaries without implementation source. Archived actions are excluded by default. List items carry no input contract: get the action and read current_revision.input_schema. Call it with call(\"ns/name\", input) in a script or call: ns/name with with: in a workflow.";
|
|
3245
3112
|
readonly http: "GET";
|
|
3246
3113
|
readonly path: "/automation/v1/actions";
|
|
3247
3114
|
readonly streaming: "no";
|
|
@@ -3378,7 +3245,7 @@ export declare const operations: readonly [{
|
|
|
3378
3245
|
readonly resource: "automation.actions";
|
|
3379
3246
|
readonly method: "retrieve";
|
|
3380
3247
|
readonly summary: "Get an Action with its current input and output JSON Schemas";
|
|
3381
|
-
readonly description: "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input). The response ETag is the current revision ID for conditional updates.";
|
|
3248
|
+
readonly description: "Read the Action and its full current implementation, with input and output JSON Schemas at current_revision.input_schema and current_revision.output_schema. To read a built-in Action, use ns=praxis and name=<bare name>, for example name=ocr; invoke it in a script with call(\"ocr\", input) or in a workflow step with call: ocr and with:. Input that breaks the contract returns INPUT_INVALID, with the fields in errors[]. The response ETag is the current revision ID for conditional updates.";
|
|
3382
3249
|
readonly http: "GET";
|
|
3383
3250
|
readonly path: "/automation/v1/actions/{ns}/{name}";
|
|
3384
3251
|
readonly streaming: "no";
|
|
@@ -3713,6 +3580,142 @@ export declare const operations: readonly [{
|
|
|
3713
3580
|
readonly required: false;
|
|
3714
3581
|
readonly fields: readonly [];
|
|
3715
3582
|
};
|
|
3583
|
+
}, {
|
|
3584
|
+
readonly resource: "automation.humanTasks";
|
|
3585
|
+
readonly method: "list";
|
|
3586
|
+
readonly summary: "List human tasks";
|
|
3587
|
+
readonly description: "List the human tasks that praxis/approval workflow steps opened, newest first. By default it returns only open tasks assigned to the caller: their approval inbox. scope=all lists every task of the organization, and status and run_id narrow the list. Use a returned id with retrieve for details and respond to decide. Read-only: listing never changes a task.";
|
|
3588
|
+
readonly http: "GET";
|
|
3589
|
+
readonly path: "/automation/v1/human-tasks";
|
|
3590
|
+
readonly streaming: "no";
|
|
3591
|
+
readonly pagination: true;
|
|
3592
|
+
readonly pathParams: readonly [];
|
|
3593
|
+
readonly query: readonly [{
|
|
3594
|
+
readonly name: "limit";
|
|
3595
|
+
readonly type: "integer";
|
|
3596
|
+
readonly required: false;
|
|
3597
|
+
readonly description: "Page size, 1–100, default 50.";
|
|
3598
|
+
}, {
|
|
3599
|
+
readonly name: "cursor";
|
|
3600
|
+
readonly type: "string";
|
|
3601
|
+
readonly required: false;
|
|
3602
|
+
readonly description: "The next_cursor of the previous page; omit for the first page.";
|
|
3603
|
+
}, {
|
|
3604
|
+
readonly name: "status";
|
|
3605
|
+
readonly type: "array";
|
|
3606
|
+
readonly itemType: "string";
|
|
3607
|
+
readonly enum: readonly ["open", "completed", "expired", "cancelled"];
|
|
3608
|
+
readonly required: false;
|
|
3609
|
+
readonly description: "Filter by status, comma-separated: open, completed, expired, cancelled. Defaults to open.";
|
|
3610
|
+
}, {
|
|
3611
|
+
readonly name: "run_id";
|
|
3612
|
+
readonly type: "string";
|
|
3613
|
+
readonly required: false;
|
|
3614
|
+
readonly description: "Only tasks opened by this run (run_).";
|
|
3615
|
+
}, {
|
|
3616
|
+
readonly name: "scope";
|
|
3617
|
+
readonly type: "string";
|
|
3618
|
+
readonly enum: readonly ["assigned", "all"];
|
|
3619
|
+
readonly required: false;
|
|
3620
|
+
readonly description: "assigned (default) lists only tasks assigned to the caller; all lists every task of the organization.";
|
|
3621
|
+
}];
|
|
3622
|
+
}, {
|
|
3623
|
+
readonly resource: "automation.humanTasks";
|
|
3624
|
+
readonly method: "retrieve";
|
|
3625
|
+
readonly summary: "Retrieve a human task";
|
|
3626
|
+
readonly description: "Read one human task - title, Markdown body, context, actions, form, assignees, mode, due time, responses and outcome - so an assignee can choose an action and fill the form. Read-only; the Console approval page /automation/tasks/{id} reads the same resource.";
|
|
3627
|
+
readonly http: "GET";
|
|
3628
|
+
readonly path: "/automation/v1/human-tasks/{id}";
|
|
3629
|
+
readonly streaming: "no";
|
|
3630
|
+
readonly pagination: false;
|
|
3631
|
+
readonly pathParams: readonly [{
|
|
3632
|
+
readonly name: "id";
|
|
3633
|
+
readonly sdkName: "id";
|
|
3634
|
+
readonly description: "Human task ID (htask_), from the list or the run's waits.";
|
|
3635
|
+
}];
|
|
3636
|
+
readonly query: readonly [];
|
|
3637
|
+
}, {
|
|
3638
|
+
readonly resource: "automation.humanTasks";
|
|
3639
|
+
readonly method: "cancel";
|
|
3640
|
+
readonly summary: "Cancel a human task";
|
|
3641
|
+
readonly description: "Cancel an open human task; only the person who started the run or an organization API key may cancel. The task becomes cancelled and the waiting workflow step raises a runtime error with code HUMAN_TASK_CANCELLED, which try/catch can catch. Open tasks are cancelled automatically when their run ends, so this call is not needed then.";
|
|
3642
|
+
readonly http: "POST";
|
|
3643
|
+
readonly path: "/automation/v1/human-tasks/{id}/cancel";
|
|
3644
|
+
readonly streaming: "no";
|
|
3645
|
+
readonly pagination: false;
|
|
3646
|
+
readonly pathParams: readonly [{
|
|
3647
|
+
readonly name: "id";
|
|
3648
|
+
readonly sdkName: "id";
|
|
3649
|
+
readonly description: "Human task ID (htask_).";
|
|
3650
|
+
}];
|
|
3651
|
+
readonly query: readonly [];
|
|
3652
|
+
readonly body: {
|
|
3653
|
+
readonly required: false;
|
|
3654
|
+
readonly fields: readonly [{
|
|
3655
|
+
readonly name: "reason";
|
|
3656
|
+
readonly type: "string";
|
|
3657
|
+
readonly required: false;
|
|
3658
|
+
readonly description: "Optional cancellation reason, at most 500 characters.";
|
|
3659
|
+
}];
|
|
3660
|
+
};
|
|
3661
|
+
}, {
|
|
3662
|
+
readonly resource: "automation.humanTasks";
|
|
3663
|
+
readonly method: "delegate";
|
|
3664
|
+
readonly summary: "Delegate a human task";
|
|
3665
|
+
readonly description: "An assignee who has not responded hands their place to another user (to_user), replacing their entry in assignees.users in place, so sequential order is kept. The new user cannot already be an assignee, nor the initiator unless self-approval is allowed. The task must still be open.";
|
|
3666
|
+
readonly http: "POST";
|
|
3667
|
+
readonly path: "/automation/v1/human-tasks/{id}/delegate";
|
|
3668
|
+
readonly streaming: "no";
|
|
3669
|
+
readonly pagination: false;
|
|
3670
|
+
readonly pathParams: readonly [{
|
|
3671
|
+
readonly name: "id";
|
|
3672
|
+
readonly sdkName: "id";
|
|
3673
|
+
readonly description: "Human task ID (htask_).";
|
|
3674
|
+
}];
|
|
3675
|
+
readonly query: readonly [];
|
|
3676
|
+
readonly body: {
|
|
3677
|
+
readonly required: true;
|
|
3678
|
+
readonly fields: readonly [{
|
|
3679
|
+
readonly name: "to_user";
|
|
3680
|
+
readonly type: "string";
|
|
3681
|
+
readonly required: true;
|
|
3682
|
+
readonly description: "User ID taking over; cannot already be an assignee, nor the initiator unless self-approval is allowed.";
|
|
3683
|
+
}];
|
|
3684
|
+
};
|
|
3685
|
+
}, {
|
|
3686
|
+
readonly resource: "automation.humanTasks";
|
|
3687
|
+
readonly method: "respond";
|
|
3688
|
+
readonly summary: "Respond to a human task";
|
|
3689
|
+
readonly description: "Submit an action (action_id), form values (values) and a comment as the calling user. Depending on the task's mode the response either decides it (status becomes completed, outcome is set, and the waiting workflow resumes with outcome as the step output) or is recorded while other assignees are awaited. When two assignees respond at once, exactly one decides and the other gets TASK_CLOSED. An agent may respond only if the workflow set allow_agent_decision. Send an Idempotency-Key to retry safely.";
|
|
3690
|
+
readonly http: "POST";
|
|
3691
|
+
readonly path: "/automation/v1/human-tasks/{id}/respond";
|
|
3692
|
+
readonly streaming: "no";
|
|
3693
|
+
readonly pagination: false;
|
|
3694
|
+
readonly pathParams: readonly [{
|
|
3695
|
+
readonly name: "id";
|
|
3696
|
+
readonly sdkName: "id";
|
|
3697
|
+
readonly description: "Human task ID (htask_).";
|
|
3698
|
+
}];
|
|
3699
|
+
readonly query: readonly [];
|
|
3700
|
+
readonly body: {
|
|
3701
|
+
readonly required: true;
|
|
3702
|
+
readonly fields: readonly [{
|
|
3703
|
+
readonly name: "action_id";
|
|
3704
|
+
readonly type: "string";
|
|
3705
|
+
readonly required: true;
|
|
3706
|
+
readonly description: "The chosen action ID from the task's actions, for example approve.";
|
|
3707
|
+
}, {
|
|
3708
|
+
readonly name: "values";
|
|
3709
|
+
readonly type: "object";
|
|
3710
|
+
readonly required: false;
|
|
3711
|
+
readonly description: "Any JSON object whose keys are strings and whose values are any JSON value.";
|
|
3712
|
+
}, {
|
|
3713
|
+
readonly name: "comment";
|
|
3714
|
+
readonly type: "string";
|
|
3715
|
+
readonly required: false;
|
|
3716
|
+
readonly description: "Comment of at most 4000 characters; required when the action has require_comment true.";
|
|
3717
|
+
}];
|
|
3718
|
+
};
|
|
3716
3719
|
}, {
|
|
3717
3720
|
readonly resource: "automation.resolve";
|
|
3718
3721
|
readonly method: "retrieve";
|
|
@@ -3844,7 +3847,7 @@ export declare const operations: readonly [{
|
|
|
3844
3847
|
readonly resource: "automation.runs";
|
|
3845
3848
|
readonly method: "create";
|
|
3846
3849
|
readonly summary: "Run a published target or execute draft source";
|
|
3847
|
-
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to
|
|
3850
|
+
readonly description: "Execute a published script or workflow with target, or test unpublished code directly with source and language (ts for TypeScript, yaml for workflow YAML), without first saving or publishing a definition. Minimal script: `export default async ({ file_id }: { file_id: string }) => { const result = await call(\"ocr\", { document: { type: \"file\", file_id } }); return result; }`; send it as source with language=\"ts\", input={\"file_id\":\"<uploaded file ID>\"} and wait=0, using a PDF or image already uploaded to your account. To call a platform API directly in the same script, use the praxis SDK object, for example `praxis.model.ocr.create({ body: { model: \"glm-ocr\", document: { type: \"file\", file_id } } })`; Action IDs are strings passed to call(), not SDK methods such as praxis.ocr(...). praxis, call, invoke, console and codemode are module-scope bindings, not on globalThis, and need no import; invoke(\"namespace/name\", input) starts a child run. target and source are mutually exclusive; target accepts ns/name@version, @tag or @range and defaults to latest when @ is omitted. Source/input validation precedes run creation, so a separate validate call is optional. input defaults to {} and must match the input schema and fit within 1 MiB. wait is 0–60 seconds (default 0): a terminal run returns 200, otherwise 202. Use the returned id with praxis.automation.runs.retrieve and inspect status, output and error; acceptance does not mean successful completion. For long-running, background or batch work, use wait: 0 and poll the run, or split work into child runs or a workflow; wait only controls the response wait and does not extend execution limits. Actions time out after 30 s (run-sandbox after 10 min); scripts have a 5 min wall-clock limit and a 30 s CPU limit; workflows default to 24 h and allow up to 30 days. Each run can start at most 100 child runs, with at most 20 active at once; nesting depth is limited to 10. Idempotency-Key is scoped to tenant, method and path for 24 hours, excluding wait from the fingerprint; replay returns the current run with Idempotent-Replayed: true, changed contents return 422 and an in-flight request returns 409. With language=yaml, source is a workflow YAML: the run input is . in the first step, and the shape is described in create workflow. Error details are in errors[] (pointer, detail, hint). New non-deterministic run IDs contain 78 characters, compared with 46 for legacy random IDs; treat IDs as opaque strings. Historical and deterministic IDs remain valid; same-millisecond order is not guaranteed.";
|
|
3848
3851
|
readonly http: "POST";
|
|
3849
3852
|
readonly path: "/automation/v1/runs";
|
|
3850
3853
|
readonly streaming: "no";
|
|
@@ -4241,7 +4244,7 @@ export declare const operations: readonly [{
|
|
|
4241
4244
|
readonly resource: "automation.scripts";
|
|
4242
4245
|
readonly method: "create";
|
|
4243
4246
|
readonly summary: "Create a script";
|
|
4244
|
-
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.";
|
|
4247
|
+
readonly description: "Save a TypeScript script as an editable draft for later reuse; this does not publish or start a run. Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. The draft is a source string with a default-exported function, for example `export default async (input: {name: string}) => ({greeting: \"Hello, \" + input.name});`. Scripts provide praxis, call, invoke, console and codemode as module-scope bindings, not on globalThis, with no import needed: praxis.<domain>.<resource>.<method>(...) calls a platform API, call(\"ocr\", input) calls a built-in Action, and invoke(\"namespace/name\", input) starts a child run. Action IDs are strings (bare names for built-ins, namespace/name for your own Actions); praxis.ocr(...) does not exist. The return value is limited to 1 MiB: write large results to a file with call(\"write-file\", ...) and return the file ID. A call error carries errors[] (pointer, detail, hint); String(e) is only the summary. To test it, pass that source and language=ts to praxis.automation.runs.create without publishing. To publish later, use the returned draft.revision as expected_draft_revision.";
|
|
4245
4248
|
readonly http: "POST";
|
|
4246
4249
|
readonly path: "/automation/v1/scripts";
|
|
4247
4250
|
readonly streaming: "no";
|
|
@@ -5006,7 +5009,7 @@ export declare const operations: readonly [{
|
|
|
5006
5009
|
readonly resource: "automation.validate";
|
|
5007
5010
|
readonly method: "create";
|
|
5008
5011
|
readonly summary: "Validate a definition";
|
|
5009
|
-
readonly description: "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation.";
|
|
5012
|
+
readonly description: "Check source without executing it when you need diagnostics, inferred schemas or references. This is optional before praxis.automation.runs.create, which also validates source before execution. Actions, scripts and workflows are supported; results include validity without saving. Invalid source is reported with valid=false. Script/action output schemas are inferred from return types: Promise unwrapping, Record, intersections and Date. Unknown types yield an empty schema and a warning in warnings. Source diagnostics use /source or /implementation/source with 1-based line/column. For kind=action the same admission checks as action creation apply (no external imports, platform operations only as direct call(praxis/<api>.<op>, input) calls, no agent or automation calls), so source that validates is not rejected at creation. For kind=workflow the YAML needs document (dsl, namespace, name, version) and do; each problem is one entry in errors[] (pointer, detail, hint), so read the first one. A listen outside the supported subset (to.all, inside a fork) and emit are not reported here and fail with DEFINITION_INVALID only when a run is created.";
|
|
5010
5013
|
readonly http: "POST";
|
|
5011
5014
|
readonly path: "/automation/v1/validate";
|
|
5012
5015
|
readonly streaming: "no";
|
|
@@ -5091,7 +5094,7 @@ export declare const operations: readonly [{
|
|
|
5091
5094
|
readonly resource: "automation.workflows";
|
|
5092
5095
|
readonly method: "create";
|
|
5093
5096
|
readonly summary: "Create a workflow";
|
|
5094
|
-
readonly description: "Save a YAML workflow as an editable draft
|
|
5097
|
+
readonly description: "Save a YAML workflow as an editable draft; this does not validate, publish or run it, so check it with validate (kind=workflow) first. Minimal draft: document with dsl (\"1.0.3\"), namespace, name and version, plus a do list of steps, for example document: {dsl: \"1.0.3\", namespace: demo, name: add, version: \"1.0.0\"} and do: [{first: {call: demo/add-one, with: {n: \"${ .n }\"}}}]. call: <ns/name> calls an Action directly (bare name for built-ins such as ocr) and with is the Action input; the input contract is at current_revision.input_schema in the get-action response. run: starts a saved script or child workflow. The run input is . in the first step, and expressions are jq written as a whole ${ ... } string. Limits: Action 30 s (run-sandbox 10 min), workflow 24 h by default and 30 days at most, payload 1 MiB. Test the draft by sending its source and language=yaml to praxis.automation.runs.create. Guide: /docs/developers/automation/guides/write-workflow. Error details are in the errors[] of the response (pointer, detail, hint). Choose your own namespace without registering it first; praxis is reserved for built-in Actions. Scripts and workflows share names within the tenant; a duplicate returns NAME_TAKEN. run.workflow accepts ns/name@range or {namespace, name, version, input}; run.script uses the same reference shape as a platform extension. Object namespace, name and version are required; version accepts an exact version, dist-tag or range, locked at publication. Object input defaults to {} and supports expressions; string references retain task-level with. run.await defaults to true and returns the child output. With false, the child uses detach and the task immediately returns {run_id}; parent cancellation does not cascade. Inline script.code returns DEFINITION_INVALID with a detail asking you to save a script and reference it first. raise.error retains its type URI, status, title and detail in the run error.";
|
|
5095
5098
|
readonly http: "POST";
|
|
5096
5099
|
readonly path: "/automation/v1/workflows";
|
|
5097
5100
|
readonly streaming: "no";
|
|
@@ -5150,7 +5153,7 @@ export declare const operations: readonly [{
|
|
|
5150
5153
|
readonly resource: "automation.workflows";
|
|
5151
5154
|
readonly method: "update";
|
|
5152
5155
|
readonly summary: "Update a workflow draft";
|
|
5153
|
-
readonly description: "Update description, labels or draft with the current draft revision in If-Match. Even metadata-only updates create a new draft revision.";
|
|
5156
|
+
readonly description: "Update description, labels or draft with the current draft revision in If-Match, taken from draft.revision in the get-workflow response. Even metadata-only updates create a new draft revision. A mismatch returns 412 PRECONDITION_FAILED; read the draft again, merge and retry. The draft is not validated here, so check it with validate (kind=workflow) before publishing. Error details are in errors[].";
|
|
5154
5157
|
readonly http: "PATCH";
|
|
5155
5158
|
readonly path: "/automation/v1/workflows/{ns}/{name}";
|
|
5156
5159
|
readonly streaming: "no";
|
|
@@ -5344,7 +5347,7 @@ export declare const operations: readonly [{
|
|
|
5344
5347
|
readonly method: "create";
|
|
5345
5348
|
readonly aliases: readonly ["publish"];
|
|
5346
5349
|
readonly summary: "Publish a workflow version";
|
|
5347
|
-
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number.";
|
|
5350
|
+
readonly description: "Publish a saved definition from its draft or an ad hoc run as a reusable version for named runs or triggers, validating the definition and locking dependencies. To test unpublished code, use praxis.automation.runs.create with source and language instead. Use draft.revision from create or retrieve as expected_draft_revision. The draft must match expected_draft_revision; an ad hoc run requires from_run and expected_source_sha256. The same version and contents return the existing version; different contents return VERSION_EXISTS, prereleases require an explicit tag (not latest, URL-safe characters only, not a version or range; violations return TAG_REQUIRED or TAG_INVALID with the complete rules in hint), and invalid definitions return DEFINITION_INVALID. Stable releases automatically advance latest only above the highest existing stable version; workflows becoming latest synchronize their declared schedule. String and object run.workflow/run.script references share version resolution and dependency locking. Publishing removes +build metadata from the version number. For a workflow, document namespace, name and version must equal the publish target, otherwise DEFINITION_IDENTITY_MISMATCH; where a DEFINITION_INVALID failure sits is listed in errors[] (pointer, detail, hint).";
|
|
5348
5351
|
readonly http: "POST";
|
|
5349
5352
|
readonly path: "/automation/v1/workflows/{ns}/{name}/versions";
|
|
5350
5353
|
readonly streaming: "no";
|
|
@@ -7835,6 +7838,7 @@ export declare const operations: readonly [{
|
|
|
7835
7838
|
readonly name: "file_id";
|
|
7836
7839
|
readonly type: "string";
|
|
7837
7840
|
readonly required: true;
|
|
7841
|
+
readonly description: "File ID to copy into this library; passed as the upload source instead of file bytes.";
|
|
7838
7842
|
}, {
|
|
7839
7843
|
readonly name: "public_id";
|
|
7840
7844
|
readonly type: "string";
|