@deepraxis/sdk 0.1.0-dev.79876bd → 0.1.0-dev.8ad8e89
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.
|
@@ -38,7 +38,7 @@ export declare const setRunFeedback: <ThrowOnError extends boolean = false>(opti
|
|
|
38
38
|
/**
|
|
39
39
|
* List End Users
|
|
40
40
|
*
|
|
41
|
-
* List users who have sessions or token issuance history on a
|
|
41
|
+
* List users who have sessions or token issuance history on a business agent.
|
|
42
42
|
*
|
|
43
43
|
* Ordered 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.
|
|
44
44
|
*/
|
|
@@ -46,7 +46,7 @@ export declare const listEndUsers: <ThrowOnError extends boolean = false>(option
|
|
|
46
46
|
/**
|
|
47
47
|
* Delete end-user data
|
|
48
48
|
*
|
|
49
|
-
* Delete a host application's end-user data from one
|
|
49
|
+
* Delete a host application's end-user data from one business agent after explicit confirmation.
|
|
50
50
|
*
|
|
51
51
|
* Develop 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.
|
|
52
52
|
*/
|
|
@@ -118,9 +118,9 @@ export declare const listEmbedTokens: <ThrowOnError extends boolean = false>(opt
|
|
|
118
118
|
/**
|
|
119
119
|
* Create Embed Token
|
|
120
120
|
*
|
|
121
|
-
* Issue a short-lived credential on your backend for an end user of a
|
|
121
|
+
* Issue a short-lived credential on your backend for an end user of a business agent.
|
|
122
122
|
*
|
|
123
|
-
* Requires an active
|
|
123
|
+
* Requires an active business 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.
|
|
124
124
|
*/
|
|
125
125
|
export declare const createEmbedToken: <ThrowOnError extends boolean = false>(options: Options<CreateEmbedTokenData, ThrowOnError>) => RequestResult<CreateEmbedTokenResponses, CreateEmbedTokenErrors, ThrowOnError>;
|
|
126
126
|
/**
|
|
@@ -851,7 +851,7 @@ export declare const sessionsUpdate: <ThrowOnError extends boolean = false>(opti
|
|
|
851
851
|
/**
|
|
852
852
|
* List agents
|
|
853
853
|
*
|
|
854
|
-
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=
|
|
854
|
+
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=business for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.
|
|
855
855
|
*/
|
|
856
856
|
export declare const agentsList: <ThrowOnError extends boolean = false>(options?: Options<AgentsListData, ThrowOnError>) => RequestResult<AgentsListResponses, unknown, ThrowOnError>;
|
|
857
857
|
/**
|
|
@@ -66,7 +66,7 @@ export const setRunFeedback = (options) => (options.client ?? client).post({
|
|
|
66
66
|
/**
|
|
67
67
|
* List End Users
|
|
68
68
|
*
|
|
69
|
-
* List users who have sessions or token issuance history on a
|
|
69
|
+
* List users who have sessions or token issuance history on a business agent.
|
|
70
70
|
*
|
|
71
71
|
* Ordered 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.
|
|
72
72
|
*/
|
|
@@ -86,7 +86,7 @@ export const listEndUsers = (options) => (options.client ?? client).get({
|
|
|
86
86
|
/**
|
|
87
87
|
* Delete end-user data
|
|
88
88
|
*
|
|
89
|
-
* Delete a host application's end-user data from one
|
|
89
|
+
* Delete a host application's end-user data from one business agent after explicit confirmation.
|
|
90
90
|
*
|
|
91
91
|
* Develop 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.
|
|
92
92
|
*/
|
|
@@ -256,9 +256,9 @@ export const listEmbedTokens = (options) => (options?.client ?? client).get({
|
|
|
256
256
|
/**
|
|
257
257
|
* Create Embed Token
|
|
258
258
|
*
|
|
259
|
-
* Issue a short-lived credential on your backend for an end user of a
|
|
259
|
+
* Issue a short-lived credential on your backend for an end user of a business agent.
|
|
260
260
|
*
|
|
261
|
-
* Requires an active
|
|
261
|
+
* Requires an active business 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.
|
|
262
262
|
*/
|
|
263
263
|
export const createEmbedToken = (options) => (options.client ?? client).post({
|
|
264
264
|
security: [{
|
|
@@ -2374,7 +2374,7 @@ export const sessionsUpdate = (options) => (options.client ?? client).post({
|
|
|
2374
2374
|
/**
|
|
2375
2375
|
* List agents
|
|
2376
2376
|
*
|
|
2377
|
-
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=
|
|
2377
|
+
* List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=business for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.
|
|
2378
2378
|
*/
|
|
2379
2379
|
export const agentsList = (options) => (options?.client ?? client).get({
|
|
2380
2380
|
security: [{
|
|
@@ -1253,7 +1253,7 @@ export type OpenaiPrediction = {
|
|
|
1253
1253
|
*/
|
|
1254
1254
|
export type OpenaiPromptCacheOptions = {
|
|
1255
1255
|
/**
|
|
1256
|
-
*
|
|
1256
|
+
* Explicit request-level cache mode: use only caller-marked cache breakpoints on models supporting this option.
|
|
1257
1257
|
*/
|
|
1258
1258
|
mode: 'explicit';
|
|
1259
1259
|
/**
|
|
@@ -1261,6 +1261,9 @@ export type OpenaiPromptCacheOptions = {
|
|
|
1261
1261
|
*/
|
|
1262
1262
|
ttl?: string | null;
|
|
1263
1263
|
} | null;
|
|
1264
|
+
/**
|
|
1265
|
+
* Provider name used in provider selection preferences.
|
|
1266
|
+
*/
|
|
1264
1267
|
export type OpenaiProviderName = 'Modal' | 'AkashML' | 'AI21' | 'AionLabs' | 'Alibaba' | 'Ambient' | 'Baidu' | 'Amazon Bedrock' | 'Amazon Nova' | 'Anthropic' | 'Arcee AI' | 'AssemblyAI' | 'AtlasCloud' | 'Avian' | 'Azure' | 'BaseTen' | 'BytePlus' | 'Black Forest Labs' | 'Cerebras' | 'Chutes' | 'Cirrascale' | 'Claude Platform on AWS' | 'Clarifai' | 'Cloudflare' | 'Cohere' | 'CoreWeave' | 'Cosine' | 'Crucible' | 'Crusoe' | 'Darkbloom' | 'Databricks' | 'Decart' | 'Deepgram' | 'DeepInfra' | 'DeepSeek' | 'DekaLLM' | 'DigitalOcean' | 'Featherless' | 'Fireworks' | 'Fish Audio' | 'Friendli' | 'GMICloud' | 'Google' | 'Google AI Studio' | 'Groq' | 'HeyGen' | 'Inception' | 'Inceptron' | 'InferenceNet' | 'Ionstream' | 'Infermatic' | 'Io Net' | 'Inferact vLLM' | 'Inflection' | 'Liquid' | 'Makora' | 'Mara' | 'Mancer 2' | 'Meta' | 'Minimax' | 'ModelRun' | 'Mistral' | 'Modular' | 'Moonshot AI' | 'Morph' | 'VoyageAI by MongoDB' | 'TypeSafe' | 'Near AI' | 'Nebius' | 'Nex AGI' | 'NextBit' | 'Novita' | 'Nvidia' | 'Ollama' | 'OpenAI' | 'OpenInference' | 'Parasail' | 'Poolside' | 'PrimeIntellect' | 'Perceptron' | 'Perplexity' | 'Phala' | 'Recraft' | 'Reka' | 'Relace' | 'Sail Research' | 'Sakana AI' | 'SambaNova' | 'Seed' | 'SiliconFlow' | 'Sourceful' | 'StepFun' | 'Stealth' | 'StreamLake' | 'Switchpoint' | 'Tencent' | 'Tenstorrent' | 'Thinking Machines' | 'Together' | 'Unbiased' | 'Upstage' | 'Venice' | 'Wafer' | 'WandB' | 'Quiver' | 'Krea' | 'Runway' | 'Xiaomi' | 'xAI' | 'Z.AI' | 'FakeProvider';
|
|
1265
1268
|
/**
|
|
1266
1269
|
* Preferred maximum latency (in seconds). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints above the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold.
|
|
@@ -1270,6 +1273,9 @@ export type OpenaiPreferredMaxLatency = number | OpenaiPercentileLatencyCutoffs
|
|
|
1270
1273
|
* Preferred minimum throughput (in tokens per second). Can be a number (applies to p50) or an object with percentile-specific cutoffs. Endpoints below the threshold(s) may still be used, but are deprioritized in routing. When using fallback models, this may cause a fallback model to be used instead of the primary model if it meets the threshold.
|
|
1271
1274
|
*/
|
|
1272
1275
|
export type OpenaiPreferredMinThroughput = number | OpenaiPercentileThroughputCutoffs | null;
|
|
1276
|
+
/**
|
|
1277
|
+
* Numeric precision or quantization format used by the model provider.
|
|
1278
|
+
*/
|
|
1273
1279
|
export type OpenaiQuantization = 'int4' | 'int8' | 'fp4' | 'mxfp4' | 'nvfp4' | 'fp6' | 'fp8' | 'mxfp8' | 'fp16' | 'bf16' | 'fp32' | 'unknown';
|
|
1274
1280
|
/**
|
|
1275
1281
|
* The provider sorting strategy (price, throughput, latency)
|
|
@@ -22188,7 +22194,7 @@ export type OpenaiOpenAiResponseCustomToolCallOutput = {
|
|
|
22188
22194
|
*/
|
|
22189
22195
|
export type OpenaiPromptCacheBreakpoint = {
|
|
22190
22196
|
/**
|
|
22191
|
-
*
|
|
22197
|
+
* Explicit cache boundary at this content block; automatic breakpoints remain enabled unless the request-level cache mode disables them.
|
|
22192
22198
|
*/
|
|
22193
22199
|
mode: 'explicit';
|
|
22194
22200
|
} | null;
|
|
@@ -27273,9 +27279,9 @@ export type UnarchiveAgentResponses = {
|
|
|
27273
27279
|
*/
|
|
27274
27280
|
version: number;
|
|
27275
27281
|
/**
|
|
27276
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
27282
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
27277
27283
|
*/
|
|
27278
|
-
kind: 'personal' | '
|
|
27284
|
+
kind: 'personal' | 'business';
|
|
27279
27285
|
/**
|
|
27280
27286
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
27281
27287
|
*/
|
|
@@ -27753,7 +27759,7 @@ export type ListEndUsersData = {
|
|
|
27753
27759
|
body?: never;
|
|
27754
27760
|
path: {
|
|
27755
27761
|
/**
|
|
27756
|
-
* Active
|
|
27762
|
+
* Active business agent identifier from agent creation or listing.
|
|
27757
27763
|
*/
|
|
27758
27764
|
agent_id: string;
|
|
27759
27765
|
};
|
|
@@ -27832,7 +27838,7 @@ export type DeleteEndUserData = {
|
|
|
27832
27838
|
body?: never;
|
|
27833
27839
|
path: {
|
|
27834
27840
|
/**
|
|
27835
|
-
* Active
|
|
27841
|
+
* Active business agent identifier from agent creation or listing.
|
|
27836
27842
|
*/
|
|
27837
27843
|
agent_id: string;
|
|
27838
27844
|
/**
|
|
@@ -27882,7 +27888,7 @@ export type GetEndUserData = {
|
|
|
27882
27888
|
body?: never;
|
|
27883
27889
|
path: {
|
|
27884
27890
|
/**
|
|
27885
|
-
* Active
|
|
27891
|
+
* Active business agent identifier from agent creation or listing.
|
|
27886
27892
|
*/
|
|
27887
27893
|
agent_id: string;
|
|
27888
27894
|
/**
|
|
@@ -27968,7 +27974,7 @@ export type GetEndUserDeletionData = {
|
|
|
27968
27974
|
body?: never;
|
|
27969
27975
|
path: {
|
|
27970
27976
|
/**
|
|
27971
|
-
* Active
|
|
27977
|
+
* Active business agent identifier from agent creation or listing.
|
|
27972
27978
|
*/
|
|
27973
27979
|
agent_id: string;
|
|
27974
27980
|
/**
|
|
@@ -28054,7 +28060,7 @@ export type RevokeEndUserTokensData = {
|
|
|
28054
28060
|
body?: never;
|
|
28055
28061
|
path: {
|
|
28056
28062
|
/**
|
|
28057
|
-
* Active
|
|
28063
|
+
* Active business agent identifier from agent creation or listing.
|
|
28058
28064
|
*/
|
|
28059
28065
|
agent_id: string;
|
|
28060
28066
|
/**
|
|
@@ -28099,7 +28105,7 @@ export type BlockEndUserData = {
|
|
|
28099
28105
|
body?: never;
|
|
28100
28106
|
path: {
|
|
28101
28107
|
/**
|
|
28102
|
-
* Active
|
|
28108
|
+
* Active business agent identifier from agent creation or listing.
|
|
28103
28109
|
*/
|
|
28104
28110
|
agent_id: string;
|
|
28105
28111
|
/**
|
|
@@ -28168,7 +28174,7 @@ export type UnblockEndUserData = {
|
|
|
28168
28174
|
body?: never;
|
|
28169
28175
|
path: {
|
|
28170
28176
|
/**
|
|
28171
|
-
* Active
|
|
28177
|
+
* Active business agent identifier from agent creation or listing.
|
|
28172
28178
|
*/
|
|
28173
28179
|
agent_id: string;
|
|
28174
28180
|
/**
|
|
@@ -28277,7 +28283,7 @@ export type ExchangeEmbedCodeResponse = ExchangeEmbedCodeResponses[keyof Exchang
|
|
|
28277
28283
|
export type CreateAnonymousEmbedTokenData = {
|
|
28278
28284
|
body: {
|
|
28279
28285
|
/**
|
|
28280
|
-
* Public key created by the
|
|
28286
|
+
* Public key created by the business agent owner; safe to include in browser code.
|
|
28281
28287
|
*/
|
|
28282
28288
|
publishable_key: string;
|
|
28283
28289
|
/**
|
|
@@ -28346,7 +28352,7 @@ export type ListEmbedTokensData = {
|
|
|
28346
28352
|
path?: never;
|
|
28347
28353
|
query?: {
|
|
28348
28354
|
/**
|
|
28349
|
-
* Filter by
|
|
28355
|
+
* Filter by business agent identifier (agent_ or agt_ prefix).
|
|
28350
28356
|
*/
|
|
28351
28357
|
agent_id?: string;
|
|
28352
28358
|
/**
|
|
@@ -28400,7 +28406,7 @@ export type ListEmbedTokensResponses = {
|
|
|
28400
28406
|
*/
|
|
28401
28407
|
type: 'embed_token';
|
|
28402
28408
|
/**
|
|
28403
|
-
*
|
|
28409
|
+
* Business agent identifier.
|
|
28404
28410
|
*/
|
|
28405
28411
|
agent_id: string;
|
|
28406
28412
|
/**
|
|
@@ -28455,7 +28461,7 @@ export type CreateEmbedTokenData = {
|
|
|
28455
28461
|
*/
|
|
28456
28462
|
hosted?: boolean;
|
|
28457
28463
|
/**
|
|
28458
|
-
*
|
|
28464
|
+
* Business agent ID or identity_number from agent retrieval; it must belong to your organization and be active.
|
|
28459
28465
|
*/
|
|
28460
28466
|
agent: string;
|
|
28461
28467
|
/**
|
|
@@ -28525,7 +28531,7 @@ export type CreateEmbedTokenErrors = {
|
|
|
28525
28531
|
*/
|
|
28526
28532
|
403: unknown;
|
|
28527
28533
|
/**
|
|
28528
|
-
* The
|
|
28534
|
+
* The business agent or requested version is unavailable to this caller; check the agent identifier and version.
|
|
28529
28535
|
*/
|
|
28530
28536
|
404: unknown;
|
|
28531
28537
|
/**
|
|
@@ -28600,7 +28606,7 @@ export type RevokeEmbedTokenResponses = {
|
|
|
28600
28606
|
*/
|
|
28601
28607
|
type: 'embed_token';
|
|
28602
28608
|
/**
|
|
28603
|
-
*
|
|
28609
|
+
* Business agent identifier.
|
|
28604
28610
|
*/
|
|
28605
28611
|
agent_id: string;
|
|
28606
28612
|
/**
|
|
@@ -32954,7 +32960,7 @@ export type GetEmbedAppearanceErrors = {
|
|
|
32954
32960
|
*/
|
|
32955
32961
|
401: unknown;
|
|
32956
32962
|
/**
|
|
32957
|
-
* The credential's
|
|
32963
|
+
* The credential's business agent is absent or archived; obtain credentials for an active business agent.
|
|
32958
32964
|
*/
|
|
32959
32965
|
404: unknown;
|
|
32960
32966
|
/**
|
|
@@ -41114,9 +41120,9 @@ export type AgentsListData = {
|
|
|
41114
41120
|
limit?: number;
|
|
41115
41121
|
page?: null | string;
|
|
41116
41122
|
/**
|
|
41117
|
-
* Personal agents use a durable computer;
|
|
41123
|
+
* Personal agents use a durable computer; business agents use a clean environment per session.
|
|
41118
41124
|
*/
|
|
41119
|
-
kind?: 'personal' | '
|
|
41125
|
+
kind?: 'personal' | 'business';
|
|
41120
41126
|
};
|
|
41121
41127
|
url: '/agent/v1/agents';
|
|
41122
41128
|
};
|
|
@@ -41221,9 +41227,9 @@ export type AgentsListResponses = {
|
|
|
41221
41227
|
*/
|
|
41222
41228
|
version: number;
|
|
41223
41229
|
/**
|
|
41224
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
41230
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
41225
41231
|
*/
|
|
41226
|
-
kind: 'personal' | '
|
|
41232
|
+
kind: 'personal' | 'business';
|
|
41227
41233
|
/**
|
|
41228
41234
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
41229
41235
|
*/
|
|
@@ -41673,9 +41679,9 @@ export type AgentsCreateData = {
|
|
|
41673
41679
|
*/
|
|
41674
41680
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
41675
41681
|
/**
|
|
41676
|
-
* Immutable agent kind. personal requires computer_id;
|
|
41682
|
+
* Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.
|
|
41677
41683
|
*/
|
|
41678
|
-
kind?: 'personal' | '
|
|
41684
|
+
kind?: 'personal' | 'business';
|
|
41679
41685
|
/**
|
|
41680
41686
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined.
|
|
41681
41687
|
*/
|
|
@@ -42138,9 +42144,9 @@ export type AgentsCreateResponses = {
|
|
|
42138
42144
|
*/
|
|
42139
42145
|
version: number;
|
|
42140
42146
|
/**
|
|
42141
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
42147
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
42142
42148
|
*/
|
|
42143
|
-
kind: 'personal' | '
|
|
42149
|
+
kind: 'personal' | 'business';
|
|
42144
42150
|
/**
|
|
42145
42151
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
42146
42152
|
*/
|
|
@@ -42618,9 +42624,9 @@ export type AgentsRetrieveResponses = {
|
|
|
42618
42624
|
*/
|
|
42619
42625
|
version: number;
|
|
42620
42626
|
/**
|
|
42621
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
42627
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
42622
42628
|
*/
|
|
42623
|
-
kind: 'personal' | '
|
|
42629
|
+
kind: 'personal' | 'business';
|
|
42624
42630
|
/**
|
|
42625
42631
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
42626
42632
|
*/
|
|
@@ -43075,9 +43081,9 @@ export type AgentsUpdateData = {
|
|
|
43075
43081
|
*/
|
|
43076
43082
|
version?: number;
|
|
43077
43083
|
/**
|
|
43078
|
-
* Immutable agent kind. personal requires computer_id;
|
|
43084
|
+
* Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.
|
|
43079
43085
|
*/
|
|
43080
|
-
kind?: 'personal' | '
|
|
43086
|
+
kind?: 'personal' | 'business';
|
|
43081
43087
|
/**
|
|
43082
43088
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined.
|
|
43083
43089
|
*/
|
|
@@ -43545,9 +43551,9 @@ export type AgentsUpdateResponses = {
|
|
|
43545
43551
|
*/
|
|
43546
43552
|
version: number;
|
|
43547
43553
|
/**
|
|
43548
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
43554
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
43549
43555
|
*/
|
|
43550
|
-
kind: 'personal' | '
|
|
43556
|
+
kind: 'personal' | 'business';
|
|
43551
43557
|
/**
|
|
43552
43558
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
43553
43559
|
*/
|
|
@@ -44019,9 +44025,9 @@ export type AgentsArchiveResponses = {
|
|
|
44019
44025
|
*/
|
|
44020
44026
|
version: number;
|
|
44021
44027
|
/**
|
|
44022
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
44028
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
44023
44029
|
*/
|
|
44024
|
-
kind: 'personal' | '
|
|
44030
|
+
kind: 'personal' | 'business';
|
|
44025
44031
|
/**
|
|
44026
44032
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
44027
44033
|
*/
|
|
@@ -44503,9 +44509,9 @@ export type AgentsVersionsListResponses = {
|
|
|
44503
44509
|
*/
|
|
44504
44510
|
version: number;
|
|
44505
44511
|
/**
|
|
44506
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
44512
|
+
* Immutable agent kind. personal uses a durable computer; business uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
44507
44513
|
*/
|
|
44508
|
-
kind: 'personal' | '
|
|
44514
|
+
kind: 'personal' | 'business';
|
|
44509
44515
|
/**
|
|
44510
44516
|
* Praxis extension: MA only has session-scoped temporary containers and memory_stores, not durable browsable computers. computer_id selects a tenant-owned active computer. Session selection overrides the agent default; a sandbox environment_id and computer_id cannot be combined. Omitted when no computer is selected.
|
|
44511
44517
|
*/
|
|
@@ -2,7 +2,7 @@ export declare const operations: readonly [{
|
|
|
2
2
|
readonly resource: "agent.agents";
|
|
3
3
|
readonly method: "list";
|
|
4
4
|
readonly summary: "List agents";
|
|
5
|
-
readonly description: "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=
|
|
5
|
+
readonly description: "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=business for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.";
|
|
6
6
|
readonly http: "GET";
|
|
7
7
|
readonly path: "/agent/v1/agents";
|
|
8
8
|
readonly streaming: "no";
|
|
@@ -37,7 +37,7 @@ export declare const operations: readonly [{
|
|
|
37
37
|
}, {
|
|
38
38
|
readonly name: "kind";
|
|
39
39
|
readonly type: "string";
|
|
40
|
-
readonly enum: readonly ["personal", "
|
|
40
|
+
readonly enum: readonly ["personal", "business"];
|
|
41
41
|
readonly required: false;
|
|
42
42
|
readonly description: "Filter agents by their immutable kind, including agents created before kind was recorded.";
|
|
43
43
|
}];
|
|
@@ -105,9 +105,9 @@ export declare const operations: readonly [{
|
|
|
105
105
|
}, {
|
|
106
106
|
readonly name: "kind";
|
|
107
107
|
readonly type: "string";
|
|
108
|
-
readonly enum: readonly ["personal", "
|
|
108
|
+
readonly enum: readonly ["personal", "business"];
|
|
109
109
|
readonly required: false;
|
|
110
|
-
readonly description: "Immutable agent kind. personal requires computer_id;
|
|
110
|
+
readonly description: "Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.";
|
|
111
111
|
}, {
|
|
112
112
|
readonly name: "computer_id";
|
|
113
113
|
readonly type: "string";
|
|
@@ -239,9 +239,9 @@ export declare const operations: readonly [{
|
|
|
239
239
|
}, {
|
|
240
240
|
readonly name: "kind";
|
|
241
241
|
readonly type: "string";
|
|
242
|
-
readonly enum: readonly ["personal", "
|
|
242
|
+
readonly enum: readonly ["personal", "business"];
|
|
243
243
|
readonly required: false;
|
|
244
|
-
readonly description: "Immutable agent kind. personal requires computer_id;
|
|
244
|
+
readonly description: "Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error.";
|
|
245
245
|
}, {
|
|
246
246
|
readonly name: "computer_id";
|
|
247
247
|
readonly type: "string";
|
|
@@ -300,7 +300,7 @@ export declare const operations: readonly [{
|
|
|
300
300
|
readonly resource: "agent.agents.endUsers";
|
|
301
301
|
readonly method: "list";
|
|
302
302
|
readonly summary: "List End Users";
|
|
303
|
-
readonly description: "List users who have sessions or token issuance history on a
|
|
303
|
+
readonly description: "List users who have sessions or token issuance history on a business 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.";
|
|
304
304
|
readonly http: "GET";
|
|
305
305
|
readonly path: "/agent/v1/agents/{agent_id}/end_users";
|
|
306
306
|
readonly streaming: "no";
|
|
@@ -329,7 +329,7 @@ export declare const operations: readonly [{
|
|
|
329
329
|
readonly resource: "agent.agents.endUsers";
|
|
330
330
|
readonly method: "delete";
|
|
331
331
|
readonly summary: "Delete end-user data";
|
|
332
|
-
readonly description: "Delete a host application's end-user data from one
|
|
332
|
+
readonly description: "Delete a host application's end-user data from one business 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.";
|
|
333
333
|
readonly http: "DELETE";
|
|
334
334
|
readonly path: "/agent/v1/agents/{agent_id}/end_users/{external_user_id}";
|
|
335
335
|
readonly streaming: "no";
|
|
@@ -1084,7 +1084,7 @@ export declare const operations: readonly [{
|
|
|
1084
1084
|
readonly name: "agent_id";
|
|
1085
1085
|
readonly type: "string";
|
|
1086
1086
|
readonly required: false;
|
|
1087
|
-
readonly description: "Filter by
|
|
1087
|
+
readonly description: "Filter by business agent identifier (agent_ or agt_ prefix).";
|
|
1088
1088
|
}, {
|
|
1089
1089
|
readonly name: "external_user_id";
|
|
1090
1090
|
readonly type: "string";
|
|
@@ -1105,7 +1105,7 @@ export declare const operations: readonly [{
|
|
|
1105
1105
|
readonly resource: "agent.embedTokens";
|
|
1106
1106
|
readonly method: "create";
|
|
1107
1107
|
readonly summary: "Create Embed Token";
|
|
1108
|
-
readonly description: "Issue a short-lived credential on your backend for an end user of a
|
|
1108
|
+
readonly description: "Issue a short-lived credential on your backend for an end user of a business agent.\n\nRequires an active business 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.";
|
|
1109
1109
|
readonly http: "POST";
|
|
1110
1110
|
readonly path: "/agent/v1/embed_tokens";
|
|
1111
1111
|
readonly streaming: "no";
|
|
@@ -1123,7 +1123,7 @@ export declare const operations: readonly [{
|
|
|
1123
1123
|
readonly name: "agent";
|
|
1124
1124
|
readonly type: "string";
|
|
1125
1125
|
readonly required: true;
|
|
1126
|
-
readonly description: "
|
|
1126
|
+
readonly description: "Business agent ID or identity_number from agent retrieval; it must belong to your organization and be active.";
|
|
1127
1127
|
}, {
|
|
1128
1128
|
readonly name: "version";
|
|
1129
1129
|
readonly type: "integer";
|
|
@@ -1185,7 +1185,7 @@ export declare const operations: readonly [{
|
|
|
1185
1185
|
readonly name: "publishable_key";
|
|
1186
1186
|
readonly type: "string";
|
|
1187
1187
|
readonly required: true;
|
|
1188
|
-
readonly description: "Public key created by the
|
|
1188
|
+
readonly description: "Public key created by the business agent owner; safe to include in browser code.";
|
|
1189
1189
|
}, {
|
|
1190
1190
|
readonly name: "visitor_secret";
|
|
1191
1191
|
readonly type: "string";
|
|
@@ -4,7 +4,7 @@ export const operations = [
|
|
|
4
4
|
"resource": "agent.agents",
|
|
5
5
|
"method": "list",
|
|
6
6
|
"summary": "List agents",
|
|
7
|
-
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=
|
|
7
|
+
"description": "List the agents of the workspace behind your API key, newest first, in pages of at most 100 (default 20). Use it to find an agent id before creating a session; to read one agent use agents.retrieve, to see its history use agents.versions.list. Archived agents are hidden unless include_archived is true. Filter kind=personal for durable-computer agents or kind=business for per-session environments. Pass next_page from the response as page to read the next page; a null next_page means the end.",
|
|
8
8
|
"http": "GET",
|
|
9
9
|
"path": "/agent/v1/agents",
|
|
10
10
|
"streaming": "no",
|
|
@@ -50,7 +50,7 @@ export const operations = [
|
|
|
50
50
|
"type": "string",
|
|
51
51
|
"enum": [
|
|
52
52
|
"personal",
|
|
53
|
-
"
|
|
53
|
+
"business"
|
|
54
54
|
],
|
|
55
55
|
"required": false,
|
|
56
56
|
"description": "Filter agents by their immutable kind, including agents created before kind was recorded."
|
|
@@ -133,10 +133,10 @@ export const operations = [
|
|
|
133
133
|
"type": "string",
|
|
134
134
|
"enum": [
|
|
135
135
|
"personal",
|
|
136
|
-
"
|
|
136
|
+
"business"
|
|
137
137
|
],
|
|
138
138
|
"required": false,
|
|
139
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
139
|
+
"description": "Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
140
140
|
},
|
|
141
141
|
{
|
|
142
142
|
"name": "computer_id",
|
|
@@ -301,10 +301,10 @@ export const operations = [
|
|
|
301
301
|
"type": "string",
|
|
302
302
|
"enum": [
|
|
303
303
|
"personal",
|
|
304
|
-
"
|
|
304
|
+
"business"
|
|
305
305
|
],
|
|
306
306
|
"required": false,
|
|
307
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
307
|
+
"description": "Immutable agent kind. personal requires computer_id; business cannot bind a computer. Omit on create to infer from computer_id. On update, the same kind is ignored; changing kind or crossing its computer binding returns 400 invalid_request_error."
|
|
308
308
|
},
|
|
309
309
|
{
|
|
310
310
|
"name": "computer_id",
|
|
@@ -379,7 +379,7 @@ export const operations = [
|
|
|
379
379
|
"resource": "agent.agents.endUsers",
|
|
380
380
|
"method": "list",
|
|
381
381
|
"summary": "List End Users",
|
|
382
|
-
"description": "List users who have sessions or token issuance history on a
|
|
382
|
+
"description": "List users who have sessions or token issuance history on a business 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.",
|
|
383
383
|
"http": "GET",
|
|
384
384
|
"path": "/agent/v1/agents/{agent_id}/end_users",
|
|
385
385
|
"streaming": "no",
|
|
@@ -415,7 +415,7 @@ export const operations = [
|
|
|
415
415
|
"resource": "agent.agents.endUsers",
|
|
416
416
|
"method": "delete",
|
|
417
417
|
"summary": "Delete end-user data",
|
|
418
|
-
"description": "Delete a host application's end-user data from one
|
|
418
|
+
"description": "Delete a host application's end-user data from one business 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.",
|
|
419
419
|
"http": "DELETE",
|
|
420
420
|
"path": "/agent/v1/agents/{agent_id}/end_users/{external_user_id}",
|
|
421
421
|
"streaming": "no",
|
|
@@ -1341,7 +1341,7 @@ export const operations = [
|
|
|
1341
1341
|
"name": "agent_id",
|
|
1342
1342
|
"type": "string",
|
|
1343
1343
|
"required": false,
|
|
1344
|
-
"description": "Filter by
|
|
1344
|
+
"description": "Filter by business agent identifier (agent_ or agt_ prefix)."
|
|
1345
1345
|
},
|
|
1346
1346
|
{
|
|
1347
1347
|
"name": "external_user_id",
|
|
@@ -1367,7 +1367,7 @@ export const operations = [
|
|
|
1367
1367
|
"resource": "agent.embedTokens",
|
|
1368
1368
|
"method": "create",
|
|
1369
1369
|
"summary": "Create Embed Token",
|
|
1370
|
-
"description": "Issue a short-lived credential on your backend for an end user of a
|
|
1370
|
+
"description": "Issue a short-lived credential on your backend for an end user of a business agent.\n\nRequires an active business 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.",
|
|
1371
1371
|
"http": "POST",
|
|
1372
1372
|
"path": "/agent/v1/embed_tokens",
|
|
1373
1373
|
"streaming": "no",
|
|
@@ -1387,7 +1387,7 @@ export const operations = [
|
|
|
1387
1387
|
"name": "agent",
|
|
1388
1388
|
"type": "string",
|
|
1389
1389
|
"required": true,
|
|
1390
|
-
"description": "
|
|
1390
|
+
"description": "Business agent ID or identity_number from agent retrieval; it must belong to your organization and be active."
|
|
1391
1391
|
},
|
|
1392
1392
|
{
|
|
1393
1393
|
"name": "version",
|
|
@@ -1460,7 +1460,7 @@ export const operations = [
|
|
|
1460
1460
|
"name": "publishable_key",
|
|
1461
1461
|
"type": "string",
|
|
1462
1462
|
"required": true,
|
|
1463
|
-
"description": "Public key created by the
|
|
1463
|
+
"description": "Public key created by the business agent owner; safe to include in browser code."
|
|
1464
1464
|
},
|
|
1465
1465
|
{
|
|
1466
1466
|
"name": "visitor_secret",
|
|
@@ -27,7 +27,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
27
27
|
type: "agent";
|
|
28
28
|
updated_at: string;
|
|
29
29
|
version: number;
|
|
30
|
-
kind: "personal" | "
|
|
30
|
+
kind: "personal" | "business";
|
|
31
31
|
computer_id?: string;
|
|
32
32
|
subagent_model?: string | null;
|
|
33
33
|
subagents?: Array<{
|
|
@@ -158,7 +158,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
158
158
|
type: "agent";
|
|
159
159
|
updated_at: string;
|
|
160
160
|
version: number;
|
|
161
|
-
kind: "personal" | "
|
|
161
|
+
kind: "personal" | "business";
|
|
162
162
|
computer_id?: string;
|
|
163
163
|
subagent_model?: string | null;
|
|
164
164
|
subagents?: Array<{
|
|
@@ -362,7 +362,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
362
362
|
type: "agent";
|
|
363
363
|
updated_at: string;
|
|
364
364
|
version: number;
|
|
365
|
-
kind: "personal" | "
|
|
365
|
+
kind: "personal" | "business";
|
|
366
366
|
computer_id?: string;
|
|
367
367
|
subagent_model?: string | null;
|
|
368
368
|
subagents?: Array<{
|
|
@@ -495,7 +495,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
495
495
|
type: "agent";
|
|
496
496
|
updated_at: string;
|
|
497
497
|
version: number;
|
|
498
|
-
kind: "personal" | "
|
|
498
|
+
kind: "personal" | "business";
|
|
499
499
|
computer_id?: string;
|
|
500
500
|
subagent_model?: string | null;
|
|
501
501
|
subagents?: Array<{
|
|
@@ -829,7 +829,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
829
829
|
type: "agent";
|
|
830
830
|
updated_at: string;
|
|
831
831
|
version: number;
|
|
832
|
-
kind: "personal" | "
|
|
832
|
+
kind: "personal" | "business";
|
|
833
833
|
computer_id?: string;
|
|
834
834
|
subagent_model?: string | null;
|
|
835
835
|
subagents?: Array<{
|
|
@@ -961,7 +961,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
961
961
|
type: "agent";
|
|
962
962
|
updated_at: string;
|
|
963
963
|
version: number;
|
|
964
|
-
kind: "personal" | "
|
|
964
|
+
kind: "personal" | "business";
|
|
965
965
|
computer_id?: string;
|
|
966
966
|
subagent_model?: string | null;
|
|
967
967
|
subagents?: Array<{
|
|
@@ -1094,7 +1094,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
1094
1094
|
type: "agent";
|
|
1095
1095
|
updated_at: string;
|
|
1096
1096
|
version: number;
|
|
1097
|
-
kind: "personal" | "
|
|
1097
|
+
kind: "personal" | "business";
|
|
1098
1098
|
computer_id?: string;
|
|
1099
1099
|
subagent_model?: string | null;
|
|
1100
1100
|
subagents?: Array<{
|