@deepraxis/sdk 0.1.1-dev.c64b603 → 0.1.1-dev.d775f1e
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 +1 -59
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +5 -107
- package/dist/generated/sdk.gen.js +4 -252
- package/dist/generated/types.gen.d.ts +940 -2762
- package/dist/operations.generated.d.ts +10 -328
- package/dist/operations.generated.js +10 -390
- package/dist/resources.generated.d.ts +9 -408
- package/dist/resources.generated.js +0 -31
- 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";
|
|
@@ -179,7 +179,7 @@ export declare const operations: readonly [{
|
|
|
179
179
|
readonly resource: "agent.agents";
|
|
180
180
|
readonly method: "retrieve";
|
|
181
181
|
readonly summary: "Get agent";
|
|
182
|
-
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.";
|
|
183
183
|
readonly http: "GET";
|
|
184
184
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
185
185
|
readonly streaming: "no";
|
|
@@ -193,13 +193,13 @@ export declare const operations: readonly [{
|
|
|
193
193
|
readonly name: "version";
|
|
194
194
|
readonly type: "number";
|
|
195
195
|
readonly required: false;
|
|
196
|
-
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.";
|
|
197
197
|
}];
|
|
198
198
|
}, {
|
|
199
199
|
readonly resource: "agent.agents";
|
|
200
200
|
readonly method: "update";
|
|
201
201
|
readonly summary: "Update agent";
|
|
202
|
-
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.";
|
|
203
203
|
readonly http: "POST";
|
|
204
204
|
readonly path: "/agent/v1/agents/{agent_id}";
|
|
205
205
|
readonly streaming: "no";
|
|
@@ -237,7 +237,7 @@ export declare const operations: readonly [{
|
|
|
237
237
|
readonly name: "multiagent";
|
|
238
238
|
readonly type: "object";
|
|
239
239
|
readonly required: false;
|
|
240
|
-
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.";
|
|
241
241
|
}, {
|
|
242
242
|
readonly name: "name";
|
|
243
243
|
readonly type: "string";
|
|
@@ -264,17 +264,17 @@ export declare const operations: readonly [{
|
|
|
264
264
|
readonly name: "version";
|
|
265
265
|
readonly type: "number";
|
|
266
266
|
readonly required: false;
|
|
267
|
-
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.";
|
|
268
268
|
}, {
|
|
269
269
|
readonly name: "apply";
|
|
270
270
|
readonly type: "boolean";
|
|
271
271
|
readonly required: false;
|
|
272
|
-
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.";
|
|
273
273
|
}, {
|
|
274
274
|
readonly name: "version_note";
|
|
275
275
|
readonly type: "string";
|
|
276
276
|
readonly required: false;
|
|
277
|
-
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.";
|
|
278
278
|
}, {
|
|
279
279
|
readonly name: "bindings";
|
|
280
280
|
readonly type: "array";
|
|
@@ -662,155 +662,6 @@ export declare const operations: readonly [{
|
|
|
662
662
|
readonly description: "Customer id from customer listing, or your own customer_id.";
|
|
663
663
|
}];
|
|
664
664
|
readonly query: readonly [];
|
|
665
|
-
}, {
|
|
666
|
-
readonly resource: "agent.agents.endUsers";
|
|
667
|
-
readonly method: "list";
|
|
668
|
-
readonly summary: "List End Users";
|
|
669
|
-
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.";
|
|
670
|
-
readonly http: "GET";
|
|
671
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users";
|
|
672
|
-
readonly streaming: "no";
|
|
673
|
-
readonly pagination: false;
|
|
674
|
-
readonly pathParams: readonly [{
|
|
675
|
-
readonly name: "agent_id";
|
|
676
|
-
readonly sdkName: "agent_id";
|
|
677
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
678
|
-
}];
|
|
679
|
-
readonly query: readonly [{
|
|
680
|
-
readonly name: "limit";
|
|
681
|
-
readonly type: "integer";
|
|
682
|
-
readonly required: false;
|
|
683
|
-
readonly description: "Maximum users per page; defaults to 20.";
|
|
684
|
-
}, {
|
|
685
|
-
readonly name: "page";
|
|
686
|
-
readonly type: "string";
|
|
687
|
-
readonly required: false;
|
|
688
|
-
readonly description: "next_page from the previous response with the same agent, q and limit.";
|
|
689
|
-
}, {
|
|
690
|
-
readonly name: "q";
|
|
691
|
-
readonly type: "string";
|
|
692
|
-
readonly required: false;
|
|
693
|
-
readonly description: "Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.";
|
|
694
|
-
}];
|
|
695
|
-
}, {
|
|
696
|
-
readonly resource: "agent.agents.endUsers";
|
|
697
|
-
readonly method: "delete";
|
|
698
|
-
readonly summary: "Delete end-user data";
|
|
699
|
-
readonly description: "Delete a host application's end-user data from one service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.";
|
|
700
|
-
readonly http: "DELETE";
|
|
701
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
|
|
702
|
-
readonly streaming: "no";
|
|
703
|
-
readonly pagination: false;
|
|
704
|
-
readonly pathParams: readonly [{
|
|
705
|
-
readonly name: "agent_id";
|
|
706
|
-
readonly sdkName: "agent_id";
|
|
707
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
708
|
-
}, {
|
|
709
|
-
readonly name: "external_user_id";
|
|
710
|
-
readonly sdkName: "external_user_id";
|
|
711
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
712
|
-
}];
|
|
713
|
-
readonly query: readonly [{
|
|
714
|
-
readonly name: "confirm";
|
|
715
|
-
readonly type: "string";
|
|
716
|
-
readonly required: true;
|
|
717
|
-
readonly description: "Must exactly equal the external_user_id path parameter to confirm destructive deletion.";
|
|
718
|
-
}];
|
|
719
|
-
}, {
|
|
720
|
-
readonly resource: "agent.agents.endUsers";
|
|
721
|
-
readonly method: "retrieve";
|
|
722
|
-
readonly summary: "Get End User";
|
|
723
|
-
readonly description: "Inspect one end user and their twenty most recently updated sessions.\n\nUse external_user_id from listing or your host application. Users without session or issuance history return 404, including preemptively blocked users. End-user credentials and inaccessible or personal agents return 404.";
|
|
724
|
-
readonly http: "GET";
|
|
725
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
|
|
726
|
-
readonly streaming: "no";
|
|
727
|
-
readonly pagination: false;
|
|
728
|
-
readonly pathParams: readonly [{
|
|
729
|
-
readonly name: "agent_id";
|
|
730
|
-
readonly sdkName: "agent_id";
|
|
731
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
732
|
-
}, {
|
|
733
|
-
readonly name: "external_user_id";
|
|
734
|
-
readonly sdkName: "external_user_id";
|
|
735
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
736
|
-
}];
|
|
737
|
-
readonly query: readonly [];
|
|
738
|
-
}, {
|
|
739
|
-
readonly resource: "agent.agents.endUsers.block";
|
|
740
|
-
readonly method: "create";
|
|
741
|
-
readonly summary: "Block End User";
|
|
742
|
-
readonly description: "Block token issuance and session creation, then revoke existing tokens for an end user.\n\nMay block a user before any history exists; timestamps are then null and counts and cost are zero. Requires an embed policy, otherwise returns 409 with setup guidance. Deduplicates the policy blocklist and retains its 1000-user maximum. If revocation returns 502, the user remains blocked; retry to finish revocation. Repeats keep the user blocked and revoke any remaining grants. End-user credentials and inaccessible or personal agents return 404.";
|
|
743
|
-
readonly http: "POST";
|
|
744
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block";
|
|
745
|
-
readonly streaming: "no";
|
|
746
|
-
readonly pagination: false;
|
|
747
|
-
readonly pathParams: readonly [{
|
|
748
|
-
readonly name: "agent_id";
|
|
749
|
-
readonly sdkName: "agent_id";
|
|
750
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
751
|
-
}, {
|
|
752
|
-
readonly name: "external_user_id";
|
|
753
|
-
readonly sdkName: "external_user_id";
|
|
754
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
755
|
-
}];
|
|
756
|
-
readonly query: readonly [];
|
|
757
|
-
}, {
|
|
758
|
-
readonly resource: "agent.agents.endUsers";
|
|
759
|
-
readonly method: "retrieveDeletion";
|
|
760
|
-
readonly summary: "Get end-user deletion";
|
|
761
|
-
readonly description: "Poll the latest deletion task for an end user, including after the user data has been removed.\n\nUse the same agent_id and external_user_id as the confirmed DELETE. Status is pending, snapshotting, deleting, done or failed. Counts are empty until a verified snapshot exists. A failed task remains blocked and resumes when DELETE is retried with matching confirmation. snapshot_key is an operator recovery reference retained for seven days, not a public download URL. End-user credentials, inaccessible or personal agents, and missing tasks return 404. This read does not create a task or charge usage.";
|
|
762
|
-
readonly http: "GET";
|
|
763
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion";
|
|
764
|
-
readonly streaming: "no";
|
|
765
|
-
readonly pagination: false;
|
|
766
|
-
readonly pathParams: readonly [{
|
|
767
|
-
readonly name: "agent_id";
|
|
768
|
-
readonly sdkName: "agent_id";
|
|
769
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
770
|
-
}, {
|
|
771
|
-
readonly name: "external_user_id";
|
|
772
|
-
readonly sdkName: "external_user_id";
|
|
773
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
774
|
-
}];
|
|
775
|
-
readonly query: readonly [];
|
|
776
|
-
}, {
|
|
777
|
-
readonly resource: "agent.agents.endUsers.revokeTokens";
|
|
778
|
-
readonly method: "create";
|
|
779
|
-
readonly summary: "Revoke End User Tokens";
|
|
780
|
-
readonly description: "Revoke all issued tokens for an end user and terminate their open embed streams.\n\nRevokes credentials before marking grants revoked. Upstream failure returns 502 without changing grant revocation timestamps. Returns the count of newly revoked grants; a repeat without new grants returns zero. Does not block future issuance. End-user credentials and inaccessible or personal agents return 404.";
|
|
781
|
-
readonly http: "POST";
|
|
782
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens";
|
|
783
|
-
readonly streaming: "no";
|
|
784
|
-
readonly pagination: false;
|
|
785
|
-
readonly pathParams: readonly [{
|
|
786
|
-
readonly name: "agent_id";
|
|
787
|
-
readonly sdkName: "agent_id";
|
|
788
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
789
|
-
}, {
|
|
790
|
-
readonly name: "external_user_id";
|
|
791
|
-
readonly sdkName: "external_user_id";
|
|
792
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
793
|
-
}];
|
|
794
|
-
readonly query: readonly [];
|
|
795
|
-
}, {
|
|
796
|
-
readonly resource: "agent.agents.endUsers.unblock";
|
|
797
|
-
readonly method: "create";
|
|
798
|
-
readonly summary: "Unblock End User";
|
|
799
|
-
readonly description: "Allow an end user to receive new tokens and create new sessions again.\n\nRemoves the user from the blocklist; previously revoked tokens stay revoked. Idempotent. Requires an embed policy, otherwise returns 409 with setup guidance. Returns null timestamps and zero counts and cost when no session or issuance history exists. End-user credentials and inaccessible or personal agents return 404.";
|
|
800
|
-
readonly http: "POST";
|
|
801
|
-
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock";
|
|
802
|
-
readonly streaming: "no";
|
|
803
|
-
readonly pagination: false;
|
|
804
|
-
readonly pathParams: readonly [{
|
|
805
|
-
readonly name: "agent_id";
|
|
806
|
-
readonly sdkName: "agent_id";
|
|
807
|
-
readonly description: "Active service agent identifier from agent creation or listing.";
|
|
808
|
-
}, {
|
|
809
|
-
readonly name: "external_user_id";
|
|
810
|
-
readonly sdkName: "external_user_id";
|
|
811
|
-
readonly description: "Host user identifier supplied at issuance or from end-user listing.";
|
|
812
|
-
}];
|
|
813
|
-
readonly query: readonly [];
|
|
814
665
|
}, {
|
|
815
666
|
readonly resource: "agent.agents.unarchive";
|
|
816
667
|
readonly method: "create";
|
|
@@ -830,7 +681,7 @@ export declare const operations: readonly [{
|
|
|
830
681
|
readonly resource: "agent.agents.versions";
|
|
831
682
|
readonly method: "list";
|
|
832
683
|
readonly summary: "List agent versions";
|
|
833
|
-
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.";
|
|
834
685
|
readonly http: "GET";
|
|
835
686
|
readonly path: "/agent/v1/agents/{agent_id}/versions";
|
|
836
687
|
readonly streaming: "no";
|
|
@@ -855,7 +706,7 @@ export declare const operations: readonly [{
|
|
|
855
706
|
readonly resource: "agent.agents.versions";
|
|
856
707
|
readonly method: "apply";
|
|
857
708
|
readonly summary: "Apply Agent Version";
|
|
858
|
-
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.";
|
|
859
710
|
readonly http: "POST";
|
|
860
711
|
readonly path: "/agent/v1/agents/{agent_id}/versions/{version}/apply";
|
|
861
712
|
readonly streaming: "no";
|
|
@@ -1459,175 +1310,6 @@ export declare const operations: readonly [{
|
|
|
1459
1310
|
readonly description: "Deployment id (depl_...), returned by deployments.create or deployments.list.";
|
|
1460
1311
|
}];
|
|
1461
1312
|
readonly query: readonly [];
|
|
1462
|
-
}, {
|
|
1463
|
-
readonly resource: "agent.embed";
|
|
1464
|
-
readonly method: "retrieveAppearance";
|
|
1465
|
-
readonly summary: "Read chat appearance";
|
|
1466
|
-
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.";
|
|
1467
|
-
readonly http: "GET";
|
|
1468
|
-
readonly path: "/agent/v1/embed/appearance";
|
|
1469
|
-
readonly streaming: "no";
|
|
1470
|
-
readonly pagination: false;
|
|
1471
|
-
readonly pathParams: readonly [];
|
|
1472
|
-
readonly query: readonly [];
|
|
1473
|
-
}, {
|
|
1474
|
-
readonly resource: "agent.embed.exchange";
|
|
1475
|
-
readonly method: "create";
|
|
1476
|
-
readonly summary: "Exchange Hosted Code";
|
|
1477
|
-
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>\"}.";
|
|
1478
|
-
readonly http: "POST";
|
|
1479
|
-
readonly path: "/agent/v1/embed/exchange";
|
|
1480
|
-
readonly streaming: "no";
|
|
1481
|
-
readonly pagination: false;
|
|
1482
|
-
readonly pathParams: readonly [];
|
|
1483
|
-
readonly query: readonly [];
|
|
1484
|
-
readonly body: {
|
|
1485
|
-
readonly required: true;
|
|
1486
|
-
readonly fields: readonly [{
|
|
1487
|
-
readonly name: "code";
|
|
1488
|
-
readonly type: "string";
|
|
1489
|
-
readonly required: true;
|
|
1490
|
-
readonly description: "Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.";
|
|
1491
|
-
}];
|
|
1492
|
-
};
|
|
1493
|
-
}, {
|
|
1494
|
-
readonly resource: "agent.embedTokens";
|
|
1495
|
-
readonly method: "list";
|
|
1496
|
-
readonly summary: "List Embed Tokens";
|
|
1497
|
-
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.";
|
|
1498
|
-
readonly http: "GET";
|
|
1499
|
-
readonly path: "/agent/v1/embed_tokens";
|
|
1500
|
-
readonly streaming: "no";
|
|
1501
|
-
readonly pagination: false;
|
|
1502
|
-
readonly pathParams: readonly [];
|
|
1503
|
-
readonly query: readonly [{
|
|
1504
|
-
readonly name: "agent_id";
|
|
1505
|
-
readonly type: "string";
|
|
1506
|
-
readonly required: false;
|
|
1507
|
-
readonly description: "Filter by service agent identifier (agent_ or agt_ prefix).";
|
|
1508
|
-
}, {
|
|
1509
|
-
readonly name: "external_user_id";
|
|
1510
|
-
readonly type: "string";
|
|
1511
|
-
readonly required: false;
|
|
1512
|
-
readonly description: "Exact host user identifier supplied at issuance.";
|
|
1513
|
-
}, {
|
|
1514
|
-
readonly name: "limit";
|
|
1515
|
-
readonly type: "integer";
|
|
1516
|
-
readonly required: false;
|
|
1517
|
-
readonly description: "Maximum records per page; defaults to 20.";
|
|
1518
|
-
}, {
|
|
1519
|
-
readonly name: "page";
|
|
1520
|
-
readonly type: "string";
|
|
1521
|
-
readonly required: false;
|
|
1522
|
-
readonly description: "next_page from a previous response with the same filters.";
|
|
1523
|
-
}];
|
|
1524
|
-
}, {
|
|
1525
|
-
readonly resource: "agent.embedTokens";
|
|
1526
|
-
readonly method: "create";
|
|
1527
|
-
readonly summary: "Create Embed Token";
|
|
1528
|
-
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.";
|
|
1529
|
-
readonly http: "POST";
|
|
1530
|
-
readonly path: "/agent/v1/embed_tokens";
|
|
1531
|
-
readonly streaming: "no";
|
|
1532
|
-
readonly pagination: false;
|
|
1533
|
-
readonly pathParams: readonly [];
|
|
1534
|
-
readonly query: readonly [];
|
|
1535
|
-
readonly body: {
|
|
1536
|
-
readonly required: true;
|
|
1537
|
-
readonly fields: readonly [{
|
|
1538
|
-
readonly name: "hosted";
|
|
1539
|
-
readonly type: "boolean";
|
|
1540
|
-
readonly required: false;
|
|
1541
|
-
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.";
|
|
1542
|
-
}, {
|
|
1543
|
-
readonly name: "agent";
|
|
1544
|
-
readonly type: "string";
|
|
1545
|
-
readonly required: true;
|
|
1546
|
-
readonly description: "Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.";
|
|
1547
|
-
}, {
|
|
1548
|
-
readonly name: "version";
|
|
1549
|
-
readonly type: "integer";
|
|
1550
|
-
readonly required: false;
|
|
1551
|
-
readonly description: "Existing agent version to pin. Omit to pin the latest version at issuance.";
|
|
1552
|
-
}, {
|
|
1553
|
-
readonly name: "external_user_id";
|
|
1554
|
-
readonly type: "string";
|
|
1555
|
-
readonly required: true;
|
|
1556
|
-
readonly description: "Your application's stable end-user identifier, scoped to this organization and agent.";
|
|
1557
|
-
}, {
|
|
1558
|
-
readonly name: "ttl_seconds";
|
|
1559
|
-
readonly type: "integer";
|
|
1560
|
-
readonly required: false;
|
|
1561
|
-
readonly description: "Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds.";
|
|
1562
|
-
}, {
|
|
1563
|
-
readonly name: "budget_cents";
|
|
1564
|
-
readonly type: "integer";
|
|
1565
|
-
readonly required: false;
|
|
1566
|
-
readonly description: "Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum.";
|
|
1567
|
-
}, {
|
|
1568
|
-
readonly name: "system_message";
|
|
1569
|
-
readonly type: "array";
|
|
1570
|
-
readonly itemType: "object";
|
|
1571
|
-
readonly required: false;
|
|
1572
|
-
readonly description: "Optional host context as text blocks, limited to 8192 UTF-8 bytes in total.";
|
|
1573
|
-
}, {
|
|
1574
|
-
readonly name: "agent_override";
|
|
1575
|
-
readonly type: "object";
|
|
1576
|
-
readonly required: false;
|
|
1577
|
-
readonly description: "Optional system prompt override, accepted only when the embed policy allows agent overrides.";
|
|
1578
|
-
}, {
|
|
1579
|
-
readonly name: "allowed_origins";
|
|
1580
|
-
readonly type: "array";
|
|
1581
|
-
readonly itemType: "string";
|
|
1582
|
-
readonly required: false;
|
|
1583
|
-
readonly description: "Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin.";
|
|
1584
|
-
}, {
|
|
1585
|
-
readonly name: "metadata";
|
|
1586
|
-
readonly type: "object";
|
|
1587
|
-
readonly required: false;
|
|
1588
|
-
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.";
|
|
1589
|
-
}];
|
|
1590
|
-
};
|
|
1591
|
-
}, {
|
|
1592
|
-
readonly resource: "agent.embedTokens.anonymous";
|
|
1593
|
-
readonly method: "create";
|
|
1594
|
-
readonly summary: "Issue anonymous visitor token";
|
|
1595
|
-
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\"}.";
|
|
1596
|
-
readonly http: "POST";
|
|
1597
|
-
readonly path: "/agent/v1/embed_tokens/anonymous";
|
|
1598
|
-
readonly streaming: "no";
|
|
1599
|
-
readonly pagination: false;
|
|
1600
|
-
readonly pathParams: readonly [];
|
|
1601
|
-
readonly query: readonly [];
|
|
1602
|
-
readonly body: {
|
|
1603
|
-
readonly required: true;
|
|
1604
|
-
readonly fields: readonly [{
|
|
1605
|
-
readonly name: "publishable_key";
|
|
1606
|
-
readonly type: "string";
|
|
1607
|
-
readonly required: true;
|
|
1608
|
-
readonly description: "Public key created by the service agent owner; safe to include in browser code.";
|
|
1609
|
-
}, {
|
|
1610
|
-
readonly name: "visitor_secret";
|
|
1611
|
-
readonly type: "string";
|
|
1612
|
-
readonly required: false;
|
|
1613
|
-
readonly description: "Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.";
|
|
1614
|
-
}];
|
|
1615
|
-
};
|
|
1616
|
-
}, {
|
|
1617
|
-
readonly resource: "agent.embedTokens.revoke";
|
|
1618
|
-
readonly method: "create";
|
|
1619
|
-
readonly summary: "Revoke Embed Token";
|
|
1620
|
-
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.";
|
|
1621
|
-
readonly http: "POST";
|
|
1622
|
-
readonly path: "/agent/v1/embed_tokens/{id}/revoke";
|
|
1623
|
-
readonly streaming: "no";
|
|
1624
|
-
readonly pagination: false;
|
|
1625
|
-
readonly pathParams: readonly [{
|
|
1626
|
-
readonly name: "id";
|
|
1627
|
-
readonly sdkName: "id";
|
|
1628
|
-
readonly description: "Grant id returned by issuance or listing.";
|
|
1629
|
-
}];
|
|
1630
|
-
readonly query: readonly [];
|
|
1631
1313
|
}, {
|
|
1632
1314
|
readonly resource: "agent.environments";
|
|
1633
1315
|
readonly method: "list";
|