@deepraxis/sdk 0.1.0-dev.48c1ce8 → 0.1.0-dev.56788b6
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 service 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 service 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 service agent.
|
|
122
122
|
*
|
|
123
|
-
* Requires an active
|
|
123
|
+
* Requires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.
|
|
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=service 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 service 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 service 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 service agent.
|
|
260
260
|
*
|
|
261
|
-
* Requires an active
|
|
261
|
+
* Requires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.
|
|
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=service 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: [{
|
|
@@ -1421,6 +1421,9 @@ export type OpenaiTraceConfig = {
|
|
|
1421
1421
|
trace_name?: string;
|
|
1422
1422
|
[key: string]: unknown;
|
|
1423
1423
|
};
|
|
1424
|
+
/**
|
|
1425
|
+
* Extra output data the request can ask for through include; each value adds one kind of detail to the response, such as file search results or encrypted reasoning content.
|
|
1426
|
+
*/
|
|
1424
1427
|
export type OpenaiResponseIncludesEnum = 'file_search_call.results' | 'message.input_image.image_url' | 'computer_call_output.output.image_url' | 'reasoning.encrypted_content' | 'code_interpreter_call.outputs';
|
|
1425
1428
|
/**
|
|
1426
1429
|
* Input for a response request - can be a string or array of items
|
|
@@ -27279,9 +27282,9 @@ export type UnarchiveAgentResponses = {
|
|
|
27279
27282
|
*/
|
|
27280
27283
|
version: number;
|
|
27281
27284
|
/**
|
|
27282
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
27285
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
27283
27286
|
*/
|
|
27284
|
-
kind: 'personal' | '
|
|
27287
|
+
kind: 'personal' | 'service';
|
|
27285
27288
|
/**
|
|
27286
27289
|
* 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.
|
|
27287
27290
|
*/
|
|
@@ -27759,7 +27762,7 @@ export type ListEndUsersData = {
|
|
|
27759
27762
|
body?: never;
|
|
27760
27763
|
path: {
|
|
27761
27764
|
/**
|
|
27762
|
-
* Active
|
|
27765
|
+
* Active service agent identifier from agent creation or listing.
|
|
27763
27766
|
*/
|
|
27764
27767
|
agent_id: string;
|
|
27765
27768
|
};
|
|
@@ -27838,7 +27841,7 @@ export type DeleteEndUserData = {
|
|
|
27838
27841
|
body?: never;
|
|
27839
27842
|
path: {
|
|
27840
27843
|
/**
|
|
27841
|
-
* Active
|
|
27844
|
+
* Active service agent identifier from agent creation or listing.
|
|
27842
27845
|
*/
|
|
27843
27846
|
agent_id: string;
|
|
27844
27847
|
/**
|
|
@@ -27888,7 +27891,7 @@ export type GetEndUserData = {
|
|
|
27888
27891
|
body?: never;
|
|
27889
27892
|
path: {
|
|
27890
27893
|
/**
|
|
27891
|
-
* Active
|
|
27894
|
+
* Active service agent identifier from agent creation or listing.
|
|
27892
27895
|
*/
|
|
27893
27896
|
agent_id: string;
|
|
27894
27897
|
/**
|
|
@@ -27974,7 +27977,7 @@ export type GetEndUserDeletionData = {
|
|
|
27974
27977
|
body?: never;
|
|
27975
27978
|
path: {
|
|
27976
27979
|
/**
|
|
27977
|
-
* Active
|
|
27980
|
+
* Active service agent identifier from agent creation or listing.
|
|
27978
27981
|
*/
|
|
27979
27982
|
agent_id: string;
|
|
27980
27983
|
/**
|
|
@@ -28060,7 +28063,7 @@ export type RevokeEndUserTokensData = {
|
|
|
28060
28063
|
body?: never;
|
|
28061
28064
|
path: {
|
|
28062
28065
|
/**
|
|
28063
|
-
* Active
|
|
28066
|
+
* Active service agent identifier from agent creation or listing.
|
|
28064
28067
|
*/
|
|
28065
28068
|
agent_id: string;
|
|
28066
28069
|
/**
|
|
@@ -28105,7 +28108,7 @@ export type BlockEndUserData = {
|
|
|
28105
28108
|
body?: never;
|
|
28106
28109
|
path: {
|
|
28107
28110
|
/**
|
|
28108
|
-
* Active
|
|
28111
|
+
* Active service agent identifier from agent creation or listing.
|
|
28109
28112
|
*/
|
|
28110
28113
|
agent_id: string;
|
|
28111
28114
|
/**
|
|
@@ -28174,7 +28177,7 @@ export type UnblockEndUserData = {
|
|
|
28174
28177
|
body?: never;
|
|
28175
28178
|
path: {
|
|
28176
28179
|
/**
|
|
28177
|
-
* Active
|
|
28180
|
+
* Active service agent identifier from agent creation or listing.
|
|
28178
28181
|
*/
|
|
28179
28182
|
agent_id: string;
|
|
28180
28183
|
/**
|
|
@@ -28283,7 +28286,7 @@ export type ExchangeEmbedCodeResponse = ExchangeEmbedCodeResponses[keyof Exchang
|
|
|
28283
28286
|
export type CreateAnonymousEmbedTokenData = {
|
|
28284
28287
|
body: {
|
|
28285
28288
|
/**
|
|
28286
|
-
* Public key created by the
|
|
28289
|
+
* Public key created by the service agent owner; safe to include in browser code.
|
|
28287
28290
|
*/
|
|
28288
28291
|
publishable_key: string;
|
|
28289
28292
|
/**
|
|
@@ -28352,7 +28355,7 @@ export type ListEmbedTokensData = {
|
|
|
28352
28355
|
path?: never;
|
|
28353
28356
|
query?: {
|
|
28354
28357
|
/**
|
|
28355
|
-
* Filter by
|
|
28358
|
+
* Filter by service agent identifier (agent_ or agt_ prefix).
|
|
28356
28359
|
*/
|
|
28357
28360
|
agent_id?: string;
|
|
28358
28361
|
/**
|
|
@@ -28406,7 +28409,7 @@ export type ListEmbedTokensResponses = {
|
|
|
28406
28409
|
*/
|
|
28407
28410
|
type: 'embed_token';
|
|
28408
28411
|
/**
|
|
28409
|
-
*
|
|
28412
|
+
* Service agent identifier.
|
|
28410
28413
|
*/
|
|
28411
28414
|
agent_id: string;
|
|
28412
28415
|
/**
|
|
@@ -28461,7 +28464,7 @@ export type CreateEmbedTokenData = {
|
|
|
28461
28464
|
*/
|
|
28462
28465
|
hosted?: boolean;
|
|
28463
28466
|
/**
|
|
28464
|
-
*
|
|
28467
|
+
* Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.
|
|
28465
28468
|
*/
|
|
28466
28469
|
agent: string;
|
|
28467
28470
|
/**
|
|
@@ -28531,7 +28534,7 @@ export type CreateEmbedTokenErrors = {
|
|
|
28531
28534
|
*/
|
|
28532
28535
|
403: unknown;
|
|
28533
28536
|
/**
|
|
28534
|
-
* The
|
|
28537
|
+
* The service agent or requested version is unavailable to this caller; check the agent identifier and version.
|
|
28535
28538
|
*/
|
|
28536
28539
|
404: unknown;
|
|
28537
28540
|
/**
|
|
@@ -28606,7 +28609,7 @@ export type RevokeEmbedTokenResponses = {
|
|
|
28606
28609
|
*/
|
|
28607
28610
|
type: 'embed_token';
|
|
28608
28611
|
/**
|
|
28609
|
-
*
|
|
28612
|
+
* Service agent identifier.
|
|
28610
28613
|
*/
|
|
28611
28614
|
agent_id: string;
|
|
28612
28615
|
/**
|
|
@@ -32960,7 +32963,7 @@ export type GetEmbedAppearanceErrors = {
|
|
|
32960
32963
|
*/
|
|
32961
32964
|
401: unknown;
|
|
32962
32965
|
/**
|
|
32963
|
-
* The credential's
|
|
32966
|
+
* The credential's service agent is absent or archived; obtain credentials for an active service agent.
|
|
32964
32967
|
*/
|
|
32965
32968
|
404: unknown;
|
|
32966
32969
|
/**
|
|
@@ -41120,9 +41123,9 @@ export type AgentsListData = {
|
|
|
41120
41123
|
limit?: number;
|
|
41121
41124
|
page?: null | string;
|
|
41122
41125
|
/**
|
|
41123
|
-
* Personal agents use a durable computer;
|
|
41126
|
+
* Personal agents use a durable computer; service agents use a clean environment per session.
|
|
41124
41127
|
*/
|
|
41125
|
-
kind?: 'personal' | '
|
|
41128
|
+
kind?: 'personal' | 'service';
|
|
41126
41129
|
};
|
|
41127
41130
|
url: '/agent/v1/agents';
|
|
41128
41131
|
};
|
|
@@ -41227,9 +41230,9 @@ export type AgentsListResponses = {
|
|
|
41227
41230
|
*/
|
|
41228
41231
|
version: number;
|
|
41229
41232
|
/**
|
|
41230
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
41233
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
41231
41234
|
*/
|
|
41232
|
-
kind: 'personal' | '
|
|
41235
|
+
kind: 'personal' | 'service';
|
|
41233
41236
|
/**
|
|
41234
41237
|
* 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.
|
|
41235
41238
|
*/
|
|
@@ -41679,9 +41682,9 @@ export type AgentsCreateData = {
|
|
|
41679
41682
|
*/
|
|
41680
41683
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
41681
41684
|
/**
|
|
41682
|
-
* Immutable agent kind. personal requires computer_id;
|
|
41685
|
+
* Immutable agent kind. personal requires computer_id; service 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.
|
|
41683
41686
|
*/
|
|
41684
|
-
kind?: 'personal' | '
|
|
41687
|
+
kind?: 'personal' | 'service';
|
|
41685
41688
|
/**
|
|
41686
41689
|
* 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.
|
|
41687
41690
|
*/
|
|
@@ -42144,9 +42147,9 @@ export type AgentsCreateResponses = {
|
|
|
42144
42147
|
*/
|
|
42145
42148
|
version: number;
|
|
42146
42149
|
/**
|
|
42147
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
42150
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
42148
42151
|
*/
|
|
42149
|
-
kind: 'personal' | '
|
|
42152
|
+
kind: 'personal' | 'service';
|
|
42150
42153
|
/**
|
|
42151
42154
|
* 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.
|
|
42152
42155
|
*/
|
|
@@ -42624,9 +42627,9 @@ export type AgentsRetrieveResponses = {
|
|
|
42624
42627
|
*/
|
|
42625
42628
|
version: number;
|
|
42626
42629
|
/**
|
|
42627
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
42630
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
42628
42631
|
*/
|
|
42629
|
-
kind: 'personal' | '
|
|
42632
|
+
kind: 'personal' | 'service';
|
|
42630
42633
|
/**
|
|
42631
42634
|
* 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.
|
|
42632
42635
|
*/
|
|
@@ -43081,9 +43084,9 @@ export type AgentsUpdateData = {
|
|
|
43081
43084
|
*/
|
|
43082
43085
|
version?: number;
|
|
43083
43086
|
/**
|
|
43084
|
-
* Immutable agent kind. personal requires computer_id;
|
|
43087
|
+
* Immutable agent kind. personal requires computer_id; service 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.
|
|
43085
43088
|
*/
|
|
43086
|
-
kind?: 'personal' | '
|
|
43089
|
+
kind?: 'personal' | 'service';
|
|
43087
43090
|
/**
|
|
43088
43091
|
* 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.
|
|
43089
43092
|
*/
|
|
@@ -43551,9 +43554,9 @@ export type AgentsUpdateResponses = {
|
|
|
43551
43554
|
*/
|
|
43552
43555
|
version: number;
|
|
43553
43556
|
/**
|
|
43554
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
43557
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
43555
43558
|
*/
|
|
43556
|
-
kind: 'personal' | '
|
|
43559
|
+
kind: 'personal' | 'service';
|
|
43557
43560
|
/**
|
|
43558
43561
|
* 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.
|
|
43559
43562
|
*/
|
|
@@ -44025,9 +44028,9 @@ export type AgentsArchiveResponses = {
|
|
|
44025
44028
|
*/
|
|
44026
44029
|
version: number;
|
|
44027
44030
|
/**
|
|
44028
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
44031
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
44029
44032
|
*/
|
|
44030
|
-
kind: 'personal' | '
|
|
44033
|
+
kind: 'personal' | 'service';
|
|
44031
44034
|
/**
|
|
44032
44035
|
* 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.
|
|
44033
44036
|
*/
|
|
@@ -44509,9 +44512,9 @@ export type AgentsVersionsListResponses = {
|
|
|
44509
44512
|
*/
|
|
44510
44513
|
version: number;
|
|
44511
44514
|
/**
|
|
44512
|
-
* Immutable agent kind. personal uses a durable computer;
|
|
44515
|
+
* Immutable agent kind. personal uses a durable computer; service uses a clean environment per session. Historical agents infer kind from their computer binding.
|
|
44513
44516
|
*/
|
|
44514
|
-
kind: 'personal' | '
|
|
44517
|
+
kind: 'personal' | 'service';
|
|
44515
44518
|
/**
|
|
44516
44519
|
* 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.
|
|
44517
44520
|
*/
|
|
@@ -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=service 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", "service"];
|
|
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", "service"];
|
|
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; service 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", "service"];
|
|
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; service 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 service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.";
|
|
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 service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.";
|
|
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 service 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 service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.";
|
|
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: "Service 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 service 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=service 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
|
+
"service"
|
|
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
|
+
"service"
|
|
137
137
|
],
|
|
138
138
|
"required": false,
|
|
139
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
139
|
+
"description": "Immutable agent kind. personal requires computer_id; service 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
|
+
"service"
|
|
305
305
|
],
|
|
306
306
|
"required": false,
|
|
307
|
-
"description": "Immutable agent kind. personal requires computer_id;
|
|
307
|
+
"description": "Immutable agent kind. personal requires computer_id; service 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 service agent.\n\nOrdered by last_active_at and external_user_id descending. q is a case-sensitive literal prefix, including underscores. limit is 1–100, default 20. Reuse next_page with the same organization, agent, q and limit. Preemptively blocked users without history do not appear. End-user credentials and inaccessible or personal agents return 404.",
|
|
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 service agent after explicit confirmation.\n\nDevelop only. Set confirm to the exact external_user_id; missing or mismatched confirmation returns 400. Returns 202 with a pending task id, not completion. Poll the deletion endpoint. Concurrent requests reuse the unfinished task; retry DELETE after failure to resume it. Tokens are revoked and the user is blocked before a seven-day recovery snapshot is verified. Sessions including child sessions, conversation data, grants and feedback are then removed. A pre-existing block remains; a temporary block is removed on success. Attachment metadata is recorded and File attachments are retained. No charge is introduced by this operation. Example: DELETE /agent/v1/agents/agent_example/end_users/customer_123?confirm=customer_123.",
|
|
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 service 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 service agent.\n\nRequires an active service agent in your organization with an embed policy. Pins the requested version or the latest version and snapshots the policy environment, vaults and resources; metadata comes from the request. Blocked users cannot receive tokens. Keep your API key on the backend and pass only the returned token to the frontend. Every call creates a new grant; issuance is not idempotent. Set hosted to true to also receive hosted_url; redirect the user there within 60 seconds. The agent must have an identity_number. The URL fragment contains a single-use exchange credential, not the token. Omit hosted or set false for ordinary token issuance.",
|
|
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": "Service 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 service 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" | "service";
|
|
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" | "service";
|
|
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" | "service";
|
|
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" | "service";
|
|
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" | "service";
|
|
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" | "service";
|
|
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" | "service";
|
|
1098
1098
|
computer_id?: string;
|
|
1099
1099
|
subagent_model?: string | null;
|
|
1100
1100
|
subagents?: Array<{
|