@deepraxis/sdk 0.1.0-dev.13103a0 → 0.1.0-dev.48c1ce8
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
|
/**
|
|
@@ -209,6 +209,8 @@ export declare const computersFilesContent: <ThrowOnError extends boolean = fals
|
|
|
209
209
|
* Resume the computer and issue a sandbox connection.
|
|
210
210
|
*
|
|
211
211
|
* Own-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.
|
|
212
|
+
*
|
|
213
|
+
* Connect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {"need":"heavy"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Heavy running time counts toward the daily budget in seconds. Renew the lease while using the connection and release it with DELETE when finished. If the daily budget is exhausted, 429 COMPUTER_BUDGET_EXHAUSTED allows you to continue with need light.
|
|
212
214
|
*/
|
|
213
215
|
export declare const connectComputer: <ThrowOnError extends boolean = false>(options: Options<ConnectComputerData, ThrowOnError>) => RequestResult<ConnectComputerResponses, ConnectComputerErrors, ThrowOnError>;
|
|
214
216
|
/**
|
|
@@ -849,7 +851,7 @@ export declare const sessionsUpdate: <ThrowOnError extends boolean = false>(opti
|
|
|
849
851
|
/**
|
|
850
852
|
* List agents
|
|
851
853
|
*
|
|
852
|
-
* 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.
|
|
853
855
|
*/
|
|
854
856
|
export declare const agentsList: <ThrowOnError extends boolean = false>(options?: Options<AgentsListData, ThrowOnError>) => RequestResult<AgentsListResponses, unknown, ThrowOnError>;
|
|
855
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: [{
|
|
@@ -496,6 +496,8 @@ export const computersFilesContent = (options) => (options.client ?? client).get
|
|
|
496
496
|
* Resume the computer and issue a sandbox connection.
|
|
497
497
|
*
|
|
498
498
|
* Own-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.
|
|
499
|
+
*
|
|
500
|
+
* Connect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {"need":"heavy"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Heavy running time counts toward the daily budget in seconds. Renew the lease while using the connection and release it with DELETE when finished. If the daily budget is exhausted, 429 COMPUTER_BUDGET_EXHAUSTED allows you to continue with need light.
|
|
499
501
|
*/
|
|
500
502
|
export const connectComputer = (options) => (options.client ?? client).post({
|
|
501
503
|
security: [{
|
|
@@ -508,7 +510,11 @@ export const connectComputer = (options) => (options.client ?? client).post({
|
|
|
508
510
|
type: 'apiKey'
|
|
509
511
|
}],
|
|
510
512
|
url: '/agent/v1/computers/{computer_id}/connect',
|
|
511
|
-
...options
|
|
513
|
+
...options,
|
|
514
|
+
headers: {
|
|
515
|
+
'Content-Type': 'application/json',
|
|
516
|
+
...options.headers
|
|
517
|
+
}
|
|
512
518
|
});
|
|
513
519
|
/**
|
|
514
520
|
* Renew computer lease
|
|
@@ -2368,7 +2374,7 @@ export const sessionsUpdate = (options) => (options.client ?? client).post({
|
|
|
2368
2374
|
/**
|
|
2369
2375
|
* List agents
|
|
2370
2376
|
*
|
|
2371
|
-
* 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.
|
|
2372
2378
|
*/
|
|
2373
2379
|
export const agentsList = (options) => (options?.client ?? client).get({
|
|
2374
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
|
/**
|
|
@@ -29872,6 +29878,10 @@ export type ComputersFilesListResponses = {
|
|
|
29872
29878
|
* Whether more items exist beyond this page.
|
|
29873
29879
|
*/
|
|
29874
29880
|
has_more: false;
|
|
29881
|
+
/**
|
|
29882
|
+
* Machine tier used to read this directory: light is the lightweight computer; heavy is the full computer.
|
|
29883
|
+
*/
|
|
29884
|
+
tier: 'light' | 'heavy';
|
|
29875
29885
|
};
|
|
29876
29886
|
};
|
|
29877
29887
|
export type ComputersFilesListResponse = ComputersFilesListResponses[keyof ComputersFilesListResponses];
|
|
@@ -30016,7 +30026,12 @@ export type ComputersFilesContentResponses = {
|
|
|
30016
30026
|
};
|
|
30017
30027
|
export type ComputersFilesContentResponse = ComputersFilesContentResponses[keyof ComputersFilesContentResponses];
|
|
30018
30028
|
export type ConnectComputerData = {
|
|
30019
|
-
body?:
|
|
30029
|
+
body?: {
|
|
30030
|
+
/**
|
|
30031
|
+
* Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds.
|
|
30032
|
+
*/
|
|
30033
|
+
need?: 'light' | 'heavy';
|
|
30034
|
+
};
|
|
30020
30035
|
path: {
|
|
30021
30036
|
/**
|
|
30022
30037
|
* Computer id (cmp_...), as returned by computers.create or computers.list.
|
|
@@ -30028,7 +30043,7 @@ export type ConnectComputerData = {
|
|
|
30028
30043
|
};
|
|
30029
30044
|
export type ConnectComputerErrors = {
|
|
30030
30045
|
/**
|
|
30031
|
-
*
|
|
30046
|
+
* INVALID_PARAMS: need must be light or heavy; unknown fields and non-object JSON are rejected. Correct the request body.
|
|
30032
30047
|
*/
|
|
30033
30048
|
400: {
|
|
30034
30049
|
error: {
|
|
@@ -30088,7 +30103,7 @@ export type ConnectComputerErrors = {
|
|
|
30088
30103
|
};
|
|
30089
30104
|
};
|
|
30090
30105
|
/**
|
|
30091
|
-
*
|
|
30106
|
+
* COMPUTER_BUDGET_EXHAUSTED: today's full-computer time has been used up. Connect with need light to continue using the lightweight shell.
|
|
30092
30107
|
*/
|
|
30093
30108
|
429: {
|
|
30094
30109
|
error: {
|
|
@@ -32945,7 +32960,7 @@ export type GetEmbedAppearanceErrors = {
|
|
|
32945
32960
|
*/
|
|
32946
32961
|
401: unknown;
|
|
32947
32962
|
/**
|
|
32948
|
-
* The credential's
|
|
32963
|
+
* The credential's business agent is absent or archived; obtain credentials for an active business agent.
|
|
32949
32964
|
*/
|
|
32950
32965
|
404: unknown;
|
|
32951
32966
|
/**
|
|
@@ -41105,9 +41120,9 @@ export type AgentsListData = {
|
|
|
41105
41120
|
limit?: number;
|
|
41106
41121
|
page?: null | string;
|
|
41107
41122
|
/**
|
|
41108
|
-
* Personal agents use a durable computer;
|
|
41123
|
+
* Personal agents use a durable computer; business agents use a clean environment per session.
|
|
41109
41124
|
*/
|
|
41110
|
-
kind?: 'personal' | '
|
|
41125
|
+
kind?: 'personal' | 'business';
|
|
41111
41126
|
};
|
|
41112
41127
|
url: '/agent/v1/agents';
|
|
41113
41128
|
};
|
|
@@ -41212,9 +41227,9 @@ export type AgentsListResponses = {
|
|
|
41212
41227
|
*/
|
|
41213
41228
|
version: number;
|
|
41214
41229
|
/**
|
|
41215
|
-
* 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.
|
|
41216
41231
|
*/
|
|
41217
|
-
kind: 'personal' | '
|
|
41232
|
+
kind: 'personal' | 'business';
|
|
41218
41233
|
/**
|
|
41219
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.
|
|
41220
41235
|
*/
|
|
@@ -41664,9 +41679,9 @@ export type AgentsCreateData = {
|
|
|
41664
41679
|
*/
|
|
41665
41680
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
41666
41681
|
/**
|
|
41667
|
-
* 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.
|
|
41668
41683
|
*/
|
|
41669
|
-
kind?: 'personal' | '
|
|
41684
|
+
kind?: 'personal' | 'business';
|
|
41670
41685
|
/**
|
|
41671
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.
|
|
41672
41687
|
*/
|
|
@@ -42129,9 +42144,9 @@ export type AgentsCreateResponses = {
|
|
|
42129
42144
|
*/
|
|
42130
42145
|
version: number;
|
|
42131
42146
|
/**
|
|
42132
|
-
* 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.
|
|
42133
42148
|
*/
|
|
42134
|
-
kind: 'personal' | '
|
|
42149
|
+
kind: 'personal' | 'business';
|
|
42135
42150
|
/**
|
|
42136
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.
|
|
42137
42152
|
*/
|
|
@@ -42609,9 +42624,9 @@ export type AgentsRetrieveResponses = {
|
|
|
42609
42624
|
*/
|
|
42610
42625
|
version: number;
|
|
42611
42626
|
/**
|
|
42612
|
-
* 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.
|
|
42613
42628
|
*/
|
|
42614
|
-
kind: 'personal' | '
|
|
42629
|
+
kind: 'personal' | 'business';
|
|
42615
42630
|
/**
|
|
42616
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.
|
|
42617
42632
|
*/
|
|
@@ -43066,9 +43081,9 @@ export type AgentsUpdateData = {
|
|
|
43066
43081
|
*/
|
|
43067
43082
|
version?: number;
|
|
43068
43083
|
/**
|
|
43069
|
-
* 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.
|
|
43070
43085
|
*/
|
|
43071
|
-
kind?: 'personal' | '
|
|
43086
|
+
kind?: 'personal' | 'business';
|
|
43072
43087
|
/**
|
|
43073
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.
|
|
43074
43089
|
*/
|
|
@@ -43536,9 +43551,9 @@ export type AgentsUpdateResponses = {
|
|
|
43536
43551
|
*/
|
|
43537
43552
|
version: number;
|
|
43538
43553
|
/**
|
|
43539
|
-
* 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.
|
|
43540
43555
|
*/
|
|
43541
|
-
kind: 'personal' | '
|
|
43556
|
+
kind: 'personal' | 'business';
|
|
43542
43557
|
/**
|
|
43543
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.
|
|
43544
43559
|
*/
|
|
@@ -44010,9 +44025,9 @@ export type AgentsArchiveResponses = {
|
|
|
44010
44025
|
*/
|
|
44011
44026
|
version: number;
|
|
44012
44027
|
/**
|
|
44013
|
-
* 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.
|
|
44014
44029
|
*/
|
|
44015
|
-
kind: 'personal' | '
|
|
44030
|
+
kind: 'personal' | 'business';
|
|
44016
44031
|
/**
|
|
44017
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.
|
|
44018
44033
|
*/
|
|
@@ -44494,9 +44509,9 @@ export type AgentsVersionsListResponses = {
|
|
|
44494
44509
|
*/
|
|
44495
44510
|
version: number;
|
|
44496
44511
|
/**
|
|
44497
|
-
* 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.
|
|
44498
44513
|
*/
|
|
44499
|
-
kind: 'personal' | '
|
|
44514
|
+
kind: 'personal' | 'business';
|
|
44500
44515
|
/**
|
|
44501
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.
|
|
44502
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";
|
|
@@ -608,7 +608,7 @@ export declare const operations: readonly [{
|
|
|
608
608
|
readonly resource: "agent.computers";
|
|
609
609
|
readonly method: "connect";
|
|
610
610
|
readonly summary: "Connect computer";
|
|
611
|
-
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.";
|
|
611
|
+
readonly description: "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Heavy running time counts toward the daily budget in seconds. Renew the lease while using the connection and release it with DELETE when finished. If the daily budget is exhausted, 429 COMPUTER_BUDGET_EXHAUSTED allows you to continue with need light.";
|
|
612
612
|
readonly http: "POST";
|
|
613
613
|
readonly path: "/agent/v1/computers/{computer_id}/connect";
|
|
614
614
|
readonly streaming: "no";
|
|
@@ -618,6 +618,16 @@ export declare const operations: readonly [{
|
|
|
618
618
|
readonly sdkName: "computer_id";
|
|
619
619
|
}];
|
|
620
620
|
readonly query: readonly [];
|
|
621
|
+
readonly body: {
|
|
622
|
+
readonly required: false;
|
|
623
|
+
readonly fields: readonly [{
|
|
624
|
+
readonly name: "need";
|
|
625
|
+
readonly type: "string";
|
|
626
|
+
readonly enum: readonly ["light", "heavy"];
|
|
627
|
+
readonly required: false;
|
|
628
|
+
readonly description: "Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds.";
|
|
629
|
+
}];
|
|
630
|
+
};
|
|
621
631
|
}, {
|
|
622
632
|
readonly resource: "agent.computers.files";
|
|
623
633
|
readonly method: "list";
|
|
@@ -1074,7 +1084,7 @@ export declare const operations: readonly [{
|
|
|
1074
1084
|
readonly name: "agent_id";
|
|
1075
1085
|
readonly type: "string";
|
|
1076
1086
|
readonly required: false;
|
|
1077
|
-
readonly description: "Filter by
|
|
1087
|
+
readonly description: "Filter by business agent identifier (agent_ or agt_ prefix).";
|
|
1078
1088
|
}, {
|
|
1079
1089
|
readonly name: "external_user_id";
|
|
1080
1090
|
readonly type: "string";
|
|
@@ -1095,7 +1105,7 @@ export declare const operations: readonly [{
|
|
|
1095
1105
|
readonly resource: "agent.embedTokens";
|
|
1096
1106
|
readonly method: "create";
|
|
1097
1107
|
readonly summary: "Create Embed Token";
|
|
1098
|
-
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.";
|
|
1099
1109
|
readonly http: "POST";
|
|
1100
1110
|
readonly path: "/agent/v1/embed_tokens";
|
|
1101
1111
|
readonly streaming: "no";
|
|
@@ -1113,7 +1123,7 @@ export declare const operations: readonly [{
|
|
|
1113
1123
|
readonly name: "agent";
|
|
1114
1124
|
readonly type: "string";
|
|
1115
1125
|
readonly required: true;
|
|
1116
|
-
readonly description: "
|
|
1126
|
+
readonly description: "Business agent ID or identity_number from agent retrieval; it must belong to your organization and be active.";
|
|
1117
1127
|
}, {
|
|
1118
1128
|
readonly name: "version";
|
|
1119
1129
|
readonly type: "integer";
|
|
@@ -1175,7 +1185,7 @@ export declare const operations: readonly [{
|
|
|
1175
1185
|
readonly name: "publishable_key";
|
|
1176
1186
|
readonly type: "string";
|
|
1177
1187
|
readonly required: true;
|
|
1178
|
-
readonly description: "Public key created by the
|
|
1188
|
+
readonly description: "Public key created by the business agent owner; safe to include in browser code.";
|
|
1179
1189
|
}, {
|
|
1180
1190
|
readonly name: "visitor_secret";
|
|
1181
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",
|
|
@@ -756,7 +756,7 @@ export const operations = [
|
|
|
756
756
|
"resource": "agent.computers",
|
|
757
757
|
"method": "connect",
|
|
758
758
|
"summary": "Connect computer",
|
|
759
|
-
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.",
|
|
759
|
+
"description": "Resume the computer and issue a sandbox connection.\n\nOwn-face extension: Managed Agents has no persistent Computer connection. Returns the public SDK sandbox_id, envd_access_token and template_id, plus the machine tier the computer is on now (light or heavy) and the lease that keeps it there (lease_id, lease_expires_at; lease_id is null when no lease exists). Keep the lease while the connection stays open: renew it about every 20 seconds (POST .../leases/{lease_id}/renew) and release it on close (DELETE .../leases/{lease_id}). An unrenewed lease simply expires, and the full machine is reclaimed only after that. Archived computers remain accessible; foreign or absent computers return 404. Never cache credentials.\n\nConnect to a computer with a caller-held lease. Omit the body or send {} to request light: the lightweight shell, or the heavy instance while it is running. Send {\"need\":\"heavy\"} to request full Linux for interactive programs; files are synchronized before the heavy connection is returned with tier heavy. Heavy running time counts toward the daily budget in seconds. Renew the lease while using the connection and release it with DELETE when finished. If the daily budget is exhausted, 429 COMPUTER_BUDGET_EXHAUSTED allows you to continue with need light.",
|
|
760
760
|
"http": "POST",
|
|
761
761
|
"path": "/agent/v1/computers/{computer_id}/connect",
|
|
762
762
|
"streaming": "no",
|
|
@@ -767,7 +767,22 @@ export const operations = [
|
|
|
767
767
|
"sdkName": "computer_id"
|
|
768
768
|
}
|
|
769
769
|
],
|
|
770
|
-
"query": []
|
|
770
|
+
"query": [],
|
|
771
|
+
"body": {
|
|
772
|
+
"required": false,
|
|
773
|
+
"fields": [
|
|
774
|
+
{
|
|
775
|
+
"name": "need",
|
|
776
|
+
"type": "string",
|
|
777
|
+
"enum": [
|
|
778
|
+
"light",
|
|
779
|
+
"heavy"
|
|
780
|
+
],
|
|
781
|
+
"required": false,
|
|
782
|
+
"description": "Defaults to light. light uses the lightweight shell, or the heavy instance while it is running. heavy requests a full Linux computer for interactive programs; heavy running time counts toward the daily budget in seconds."
|
|
783
|
+
}
|
|
784
|
+
]
|
|
785
|
+
}
|
|
771
786
|
},
|
|
772
787
|
{
|
|
773
788
|
"resource": "agent.computers.files",
|
|
@@ -1326,7 +1341,7 @@ export const operations = [
|
|
|
1326
1341
|
"name": "agent_id",
|
|
1327
1342
|
"type": "string",
|
|
1328
1343
|
"required": false,
|
|
1329
|
-
"description": "Filter by
|
|
1344
|
+
"description": "Filter by business agent identifier (agent_ or agt_ prefix)."
|
|
1330
1345
|
},
|
|
1331
1346
|
{
|
|
1332
1347
|
"name": "external_user_id",
|
|
@@ -1352,7 +1367,7 @@ export const operations = [
|
|
|
1352
1367
|
"resource": "agent.embedTokens",
|
|
1353
1368
|
"method": "create",
|
|
1354
1369
|
"summary": "Create Embed Token",
|
|
1355
|
-
"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.",
|
|
1356
1371
|
"http": "POST",
|
|
1357
1372
|
"path": "/agent/v1/embed_tokens",
|
|
1358
1373
|
"streaming": "no",
|
|
@@ -1372,7 +1387,7 @@ export const operations = [
|
|
|
1372
1387
|
"name": "agent",
|
|
1373
1388
|
"type": "string",
|
|
1374
1389
|
"required": true,
|
|
1375
|
-
"description": "
|
|
1390
|
+
"description": "Business agent ID or identity_number from agent retrieval; it must belong to your organization and be active."
|
|
1376
1391
|
},
|
|
1377
1392
|
{
|
|
1378
1393
|
"name": "version",
|
|
@@ -1445,7 +1460,7 @@ export const operations = [
|
|
|
1445
1460
|
"name": "publishable_key",
|
|
1446
1461
|
"type": "string",
|
|
1447
1462
|
"required": true,
|
|
1448
|
-
"description": "Public key created by the
|
|
1463
|
+
"description": "Public key created by the business agent owner; safe to include in browser code."
|
|
1449
1464
|
},
|
|
1450
1465
|
{
|
|
1451
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<{
|
|
@@ -1267,6 +1267,7 @@ export declare function createAgent(transport: Transport): {
|
|
|
1267
1267
|
updated_at: string | null;
|
|
1268
1268
|
}>;
|
|
1269
1269
|
has_more: false;
|
|
1270
|
+
tier: "light" | "heavy";
|
|
1270
1271
|
}>;
|
|
1271
1272
|
retrieveContent: (options: import("./core/transport.js").CallOptions<Types.ComputersFilesContentData>) => Promise<Blob | File>;
|
|
1272
1273
|
};
|