@deepraxis/sdk 0.1.1-dev.b176367 → 0.1.1-dev.c64b603
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/METHODS.md +29 -1
- package/dist/generated/index.d.ts +2 -2
- package/dist/generated/index.js +1 -1
- package/dist/generated/sdk.gen.d.ts +66 -2
- package/dist/generated/sdk.gen.js +161 -1
- package/dist/generated/types.gen.d.ts +1025 -30
- package/dist/operations.generated.d.ts +191 -6
- package/dist/operations.generated.js +234 -6
- package/dist/resources.generated.d.ts +192 -4
- package/dist/resources.generated.js +14 -0
- package/package.json +1 -1
|
@@ -4215,7 +4215,7 @@ export type AgentManaged57 = {
|
|
|
4215
4215
|
type: 'custom';
|
|
4216
4216
|
};
|
|
4217
4217
|
/**
|
|
4218
|
-
* Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited.
|
|
4218
|
+
* Session spending limit, {type: "limit", max_list_cost: {amount, currency}}; null when unlimited. amount is in US dollars: send an integer or up to 2 decimals ("0.50"), and responses carry exactly 2 decimals ("20.00"). Creation defaults to USD 20.00 when omitted. More decimals, zero or a number return 400. Removing the limit with null prevents setting it again for that session.
|
|
4219
4219
|
*/
|
|
4220
4220
|
export type AgentManaged76 = {
|
|
4221
4221
|
/**
|
|
@@ -4408,6 +4408,19 @@ export type AgentManaged179 = {
|
|
|
4408
4408
|
* Cumulative count of server-executed tool invocations, broken down by tool.
|
|
4409
4409
|
*/
|
|
4410
4410
|
server_tool_use?: null | AgentManaged181;
|
|
4411
|
+
/**
|
|
4412
|
+
* Praxis extension: priced runtime of this session (the time it was running), billed separately from list_cost and not counted against the budget. amount is in US dollars as a decimal string with exactly 6 decimals, e.g. "0.000280". Each thread's runtime is reported on that thread. /agent/v1 only.
|
|
4413
|
+
*/
|
|
4414
|
+
runtime_cost?: {
|
|
4415
|
+
/**
|
|
4416
|
+
* Runtime cost in US dollars, decimal string with exactly 6 decimals.
|
|
4417
|
+
*/
|
|
4418
|
+
amount: string;
|
|
4419
|
+
/**
|
|
4420
|
+
* Always USD.
|
|
4421
|
+
*/
|
|
4422
|
+
currency: 'USD';
|
|
4423
|
+
};
|
|
4411
4424
|
};
|
|
4412
4425
|
export type AgentManaged183 = {
|
|
4413
4426
|
[key: string]: null | string;
|
|
@@ -18102,11 +18115,11 @@ export type AgentManaged33 = {
|
|
|
18102
18115
|
[key: string]: unknown;
|
|
18103
18116
|
};
|
|
18104
18117
|
/**
|
|
18105
|
-
* Largest list-price cost the session may reach, as {amount, currency}. amount is
|
|
18118
|
+
* Largest list-price cost the session may reach, as {amount, currency}. amount is in US dollars with at most 2 decimals, not cents.
|
|
18106
18119
|
*/
|
|
18107
18120
|
export type AgentManaged77 = {
|
|
18108
18121
|
/**
|
|
18109
|
-
*
|
|
18122
|
+
* Amount in US dollars as a decimal string. Costs (usage.list_cost) carry exactly 6 decimals, e.g. "0.000345"; budgets (budget.max_list_cost) carry exactly 2 decimals, e.g. "20.00", and accept an integer or up to 2 decimals on input.
|
|
18110
18123
|
*/
|
|
18111
18124
|
amount: string;
|
|
18112
18125
|
/**
|
|
@@ -28037,7 +28050,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
28037
28050
|
*/
|
|
28038
28051
|
note: string | null;
|
|
28039
28052
|
/**
|
|
28040
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
28053
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
28041
28054
|
*/
|
|
28042
28055
|
bindings: Array<{
|
|
28043
28056
|
/**
|
|
@@ -28056,6 +28069,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
28056
28069
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
28057
28070
|
*/
|
|
28058
28071
|
instructions?: string;
|
|
28072
|
+
/**
|
|
28073
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
28074
|
+
*/
|
|
28075
|
+
readonly verified?: boolean;
|
|
28059
28076
|
/**
|
|
28060
28077
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
28061
28078
|
*/
|
|
@@ -28065,6 +28082,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
28065
28082
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
28066
28083
|
*/
|
|
28067
28084
|
type: 'search' | 'browser';
|
|
28085
|
+
/**
|
|
28086
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
28087
|
+
*/
|
|
28088
|
+
readonly verified?: boolean;
|
|
28068
28089
|
/**
|
|
28069
28090
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
28070
28091
|
*/
|
|
@@ -28082,6 +28103,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
28082
28103
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
28083
28104
|
*/
|
|
28084
28105
|
subagent_model?: string | null;
|
|
28106
|
+
/**
|
|
28107
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
28108
|
+
*/
|
|
28109
|
+
image_model?: string | null;
|
|
28085
28110
|
/**
|
|
28086
28111
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
28087
28112
|
*/
|
|
@@ -29210,7 +29235,7 @@ export type UnarchiveAgentResponses = {
|
|
|
29210
29235
|
*/
|
|
29211
29236
|
note: string | null;
|
|
29212
29237
|
/**
|
|
29213
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
29238
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
29214
29239
|
*/
|
|
29215
29240
|
bindings: Array<{
|
|
29216
29241
|
/**
|
|
@@ -29229,6 +29254,10 @@ export type UnarchiveAgentResponses = {
|
|
|
29229
29254
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
29230
29255
|
*/
|
|
29231
29256
|
instructions?: string;
|
|
29257
|
+
/**
|
|
29258
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
29259
|
+
*/
|
|
29260
|
+
readonly verified?: boolean;
|
|
29232
29261
|
/**
|
|
29233
29262
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
29234
29263
|
*/
|
|
@@ -29238,6 +29267,10 @@ export type UnarchiveAgentResponses = {
|
|
|
29238
29267
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
29239
29268
|
*/
|
|
29240
29269
|
type: 'search' | 'browser';
|
|
29270
|
+
/**
|
|
29271
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
29272
|
+
*/
|
|
29273
|
+
readonly verified?: boolean;
|
|
29241
29274
|
/**
|
|
29242
29275
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
29243
29276
|
*/
|
|
@@ -29255,6 +29288,10 @@ export type UnarchiveAgentResponses = {
|
|
|
29255
29288
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
29256
29289
|
*/
|
|
29257
29290
|
subagent_model?: string | null;
|
|
29291
|
+
/**
|
|
29292
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
29293
|
+
*/
|
|
29294
|
+
image_model?: string | null;
|
|
29258
29295
|
/**
|
|
29259
29296
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
29260
29297
|
*/
|
|
@@ -29819,9 +29856,18 @@ export type ListEndUsersResponses = {
|
|
|
29819
29856
|
*/
|
|
29820
29857
|
session_count: number;
|
|
29821
29858
|
/**
|
|
29822
|
-
* Accumulated recorded
|
|
29859
|
+
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
29823
29860
|
*/
|
|
29824
|
-
|
|
29861
|
+
cost: {
|
|
29862
|
+
/**
|
|
29863
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
29864
|
+
*/
|
|
29865
|
+
amount: string;
|
|
29866
|
+
/**
|
|
29867
|
+
* Always USD.
|
|
29868
|
+
*/
|
|
29869
|
+
currency: 'USD';
|
|
29870
|
+
};
|
|
29825
29871
|
/**
|
|
29826
29872
|
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
29827
29873
|
*/
|
|
@@ -29945,9 +29991,18 @@ export type GetEndUserResponses = {
|
|
|
29945
29991
|
*/
|
|
29946
29992
|
session_count: number;
|
|
29947
29993
|
/**
|
|
29948
|
-
* Accumulated recorded
|
|
29994
|
+
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
29949
29995
|
*/
|
|
29950
|
-
|
|
29996
|
+
cost: {
|
|
29997
|
+
/**
|
|
29998
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
29999
|
+
*/
|
|
30000
|
+
amount: string;
|
|
30001
|
+
/**
|
|
30002
|
+
* Always USD.
|
|
30003
|
+
*/
|
|
30004
|
+
currency: 'USD';
|
|
30005
|
+
};
|
|
29951
30006
|
/**
|
|
29952
30007
|
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
29953
30008
|
*/
|
|
@@ -30185,9 +30240,18 @@ export type BlockEndUserResponses = {
|
|
|
30185
30240
|
*/
|
|
30186
30241
|
session_count: number;
|
|
30187
30242
|
/**
|
|
30188
|
-
* Accumulated recorded
|
|
30243
|
+
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
30189
30244
|
*/
|
|
30190
|
-
|
|
30245
|
+
cost: {
|
|
30246
|
+
/**
|
|
30247
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30248
|
+
*/
|
|
30249
|
+
amount: string;
|
|
30250
|
+
/**
|
|
30251
|
+
* Always USD.
|
|
30252
|
+
*/
|
|
30253
|
+
currency: 'USD';
|
|
30254
|
+
};
|
|
30191
30255
|
/**
|
|
30192
30256
|
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30193
30257
|
*/
|
|
@@ -30255,9 +30319,18 @@ export type UnblockEndUserResponses = {
|
|
|
30255
30319
|
*/
|
|
30256
30320
|
session_count: number;
|
|
30257
30321
|
/**
|
|
30258
|
-
* Accumulated recorded
|
|
30322
|
+
* Accumulated recorded cost of this customer's sessions on this agent: model usage (threads included) plus session runtime; amount "0.000000" when nothing has been recorded.
|
|
30259
30323
|
*/
|
|
30260
|
-
|
|
30324
|
+
cost: {
|
|
30325
|
+
/**
|
|
30326
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30327
|
+
*/
|
|
30328
|
+
amount: string;
|
|
30329
|
+
/**
|
|
30330
|
+
* Always USD.
|
|
30331
|
+
*/
|
|
30332
|
+
currency: 'USD';
|
|
30333
|
+
};
|
|
30261
30334
|
/**
|
|
30262
30335
|
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30263
30336
|
*/
|
|
@@ -30265,6 +30338,801 @@ export type UnblockEndUserResponses = {
|
|
|
30265
30338
|
};
|
|
30266
30339
|
};
|
|
30267
30340
|
export type UnblockEndUserResponse = UnblockEndUserResponses[keyof UnblockEndUserResponses];
|
|
30341
|
+
export type ListCustomersData = {
|
|
30342
|
+
body?: never;
|
|
30343
|
+
path: {
|
|
30344
|
+
/**
|
|
30345
|
+
* Active service agent id from agent creation or listing.
|
|
30346
|
+
*/
|
|
30347
|
+
agent_id: string;
|
|
30348
|
+
};
|
|
30349
|
+
query?: {
|
|
30350
|
+
/**
|
|
30351
|
+
* Maximum customers per page, 1 to 100; defaults to 20.
|
|
30352
|
+
*/
|
|
30353
|
+
limit?: number;
|
|
30354
|
+
/**
|
|
30355
|
+
* next_page from the previous response with the same q, type, blocked and limit.
|
|
30356
|
+
*/
|
|
30357
|
+
page?: string;
|
|
30358
|
+
/**
|
|
30359
|
+
* Case-sensitive literal prefix of the customer id; omit for all customers.
|
|
30360
|
+
*/
|
|
30361
|
+
q?: string;
|
|
30362
|
+
/**
|
|
30363
|
+
* Only identified or only anonymous customers; omit for both.
|
|
30364
|
+
*/
|
|
30365
|
+
type?: 'identified' | 'anonymous';
|
|
30366
|
+
/**
|
|
30367
|
+
* true for blocked customers only, false for customers who are not blocked; omit for both.
|
|
30368
|
+
*/
|
|
30369
|
+
blocked?: boolean;
|
|
30370
|
+
};
|
|
30371
|
+
url: '/agent/v1/agents/{agent_id}/customers';
|
|
30372
|
+
};
|
|
30373
|
+
export type ListCustomersErrors = {
|
|
30374
|
+
/**
|
|
30375
|
+
* INVALID_PARAMS: limit outside 1 to 100, type other than identified or anonymous, blocked other than true or false, or an unknown query parameter. INVALID_PAGE_TOKEN: next_page from another query; restart without page.
|
|
30376
|
+
*/
|
|
30377
|
+
400: unknown;
|
|
30378
|
+
/**
|
|
30379
|
+
* Authenticate with your API key or a console session.
|
|
30380
|
+
*/
|
|
30381
|
+
401: unknown;
|
|
30382
|
+
/**
|
|
30383
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30384
|
+
*/
|
|
30385
|
+
403: AgentError;
|
|
30386
|
+
/**
|
|
30387
|
+
* The agent is not an active service agent of your organization, or the caller is a customer access token.
|
|
30388
|
+
*/
|
|
30389
|
+
404: unknown;
|
|
30390
|
+
};
|
|
30391
|
+
export type ListCustomersError = ListCustomersErrors[keyof ListCustomersErrors];
|
|
30392
|
+
export type ListCustomersResponses = {
|
|
30393
|
+
/**
|
|
30394
|
+
* Matching customers and the next page cursor.
|
|
30395
|
+
*/
|
|
30396
|
+
200: {
|
|
30397
|
+
/**
|
|
30398
|
+
* Items of this page, in the order requested by the call.
|
|
30399
|
+
*/
|
|
30400
|
+
data: Array<{
|
|
30401
|
+
/**
|
|
30402
|
+
* The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
|
|
30403
|
+
*/
|
|
30404
|
+
id: string;
|
|
30405
|
+
/**
|
|
30406
|
+
* identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
|
|
30407
|
+
*/
|
|
30408
|
+
type: 'identified' | 'anonymous';
|
|
30409
|
+
/**
|
|
30410
|
+
* For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
|
|
30411
|
+
*/
|
|
30412
|
+
merged_into: string | null;
|
|
30413
|
+
/**
|
|
30414
|
+
* Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
|
|
30415
|
+
*/
|
|
30416
|
+
blocked: boolean;
|
|
30417
|
+
/**
|
|
30418
|
+
* Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
|
|
30419
|
+
*/
|
|
30420
|
+
first_seen_at: string | null;
|
|
30421
|
+
/**
|
|
30422
|
+
* Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
|
|
30423
|
+
*/
|
|
30424
|
+
last_seen_at: string | null;
|
|
30425
|
+
/**
|
|
30426
|
+
* Sessions of this customer on this agent, including those of anonymous customers merged into it.
|
|
30427
|
+
*/
|
|
30428
|
+
session_count: number;
|
|
30429
|
+
/**
|
|
30430
|
+
* Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
|
|
30431
|
+
*/
|
|
30432
|
+
cost: {
|
|
30433
|
+
/**
|
|
30434
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30435
|
+
*/
|
|
30436
|
+
amount: string;
|
|
30437
|
+
/**
|
|
30438
|
+
* Always USD.
|
|
30439
|
+
*/
|
|
30440
|
+
currency: 'USD';
|
|
30441
|
+
};
|
|
30442
|
+
}>;
|
|
30443
|
+
/**
|
|
30444
|
+
* Cursor for the next page with the same agent, q, type, blocked and limit; null when exhausted.
|
|
30445
|
+
*/
|
|
30446
|
+
next_page: string | null;
|
|
30447
|
+
};
|
|
30448
|
+
};
|
|
30449
|
+
export type ListCustomersResponse = ListCustomersResponses[keyof ListCustomersResponses];
|
|
30450
|
+
export type DeleteCustomerData = {
|
|
30451
|
+
body?: never;
|
|
30452
|
+
path: {
|
|
30453
|
+
/**
|
|
30454
|
+
* Active service agent id from agent creation or listing.
|
|
30455
|
+
*/
|
|
30456
|
+
agent_id: string;
|
|
30457
|
+
/**
|
|
30458
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30459
|
+
*/
|
|
30460
|
+
customer_id: string;
|
|
30461
|
+
};
|
|
30462
|
+
query: {
|
|
30463
|
+
/**
|
|
30464
|
+
* Must equal the customer_id path parameter exactly, confirming the destructive deletion.
|
|
30465
|
+
*/
|
|
30466
|
+
confirm: string;
|
|
30467
|
+
};
|
|
30468
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
|
|
30469
|
+
};
|
|
30470
|
+
export type DeleteCustomerErrors = {
|
|
30471
|
+
/**
|
|
30472
|
+
* INVALID_PARAMS: confirm is missing or differs from customer_id; send ?confirm=<customer_id>.
|
|
30473
|
+
*/
|
|
30474
|
+
400: unknown;
|
|
30475
|
+
/**
|
|
30476
|
+
* Authenticate with your API key or a console session.
|
|
30477
|
+
*/
|
|
30478
|
+
401: unknown;
|
|
30479
|
+
/**
|
|
30480
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30481
|
+
*/
|
|
30482
|
+
403: AgentError;
|
|
30483
|
+
/**
|
|
30484
|
+
* CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
|
|
30485
|
+
*/
|
|
30486
|
+
404: unknown;
|
|
30487
|
+
};
|
|
30488
|
+
export type DeleteCustomerError = DeleteCustomerErrors[keyof DeleteCustomerErrors];
|
|
30489
|
+
export type DeleteCustomerResponses = {
|
|
30490
|
+
/**
|
|
30491
|
+
* Deletion accepted; poll the deletion endpoint until done or failed.
|
|
30492
|
+
*/
|
|
30493
|
+
202: {
|
|
30494
|
+
/**
|
|
30495
|
+
* Deletion task identifier.
|
|
30496
|
+
*/
|
|
30497
|
+
id: string;
|
|
30498
|
+
/**
|
|
30499
|
+
* Accepted for asynchronous processing; poll deletion for progress.
|
|
30500
|
+
*/
|
|
30501
|
+
status: 'pending';
|
|
30502
|
+
};
|
|
30503
|
+
};
|
|
30504
|
+
export type DeleteCustomerResponse = DeleteCustomerResponses[keyof DeleteCustomerResponses];
|
|
30505
|
+
export type GetCustomerData = {
|
|
30506
|
+
body?: never;
|
|
30507
|
+
path: {
|
|
30508
|
+
/**
|
|
30509
|
+
* Active service agent id from agent creation or listing.
|
|
30510
|
+
*/
|
|
30511
|
+
agent_id: string;
|
|
30512
|
+
/**
|
|
30513
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30514
|
+
*/
|
|
30515
|
+
customer_id: string;
|
|
30516
|
+
};
|
|
30517
|
+
query?: never;
|
|
30518
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
|
|
30519
|
+
};
|
|
30520
|
+
export type GetCustomerErrors = {
|
|
30521
|
+
/**
|
|
30522
|
+
* Authenticate with your API key or a console session.
|
|
30523
|
+
*/
|
|
30524
|
+
401: unknown;
|
|
30525
|
+
/**
|
|
30526
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30527
|
+
*/
|
|
30528
|
+
403: AgentError;
|
|
30529
|
+
/**
|
|
30530
|
+
* CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
|
|
30531
|
+
*/
|
|
30532
|
+
404: unknown;
|
|
30533
|
+
};
|
|
30534
|
+
export type GetCustomerError = GetCustomerErrors[keyof GetCustomerErrors];
|
|
30535
|
+
export type GetCustomerResponses = {
|
|
30536
|
+
/**
|
|
30537
|
+
* The customer with its recent sessions.
|
|
30538
|
+
*/
|
|
30539
|
+
200: {
|
|
30540
|
+
/**
|
|
30541
|
+
* The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
|
|
30542
|
+
*/
|
|
30543
|
+
id: string;
|
|
30544
|
+
/**
|
|
30545
|
+
* identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
|
|
30546
|
+
*/
|
|
30547
|
+
type: 'identified' | 'anonymous';
|
|
30548
|
+
/**
|
|
30549
|
+
* For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
|
|
30550
|
+
*/
|
|
30551
|
+
merged_into: string | null;
|
|
30552
|
+
/**
|
|
30553
|
+
* Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
|
|
30554
|
+
*/
|
|
30555
|
+
blocked: boolean;
|
|
30556
|
+
/**
|
|
30557
|
+
* Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
|
|
30558
|
+
*/
|
|
30559
|
+
first_seen_at: string | null;
|
|
30560
|
+
/**
|
|
30561
|
+
* Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
|
|
30562
|
+
*/
|
|
30563
|
+
last_seen_at: string | null;
|
|
30564
|
+
/**
|
|
30565
|
+
* Sessions of this customer on this agent, including those of anonymous customers merged into it.
|
|
30566
|
+
*/
|
|
30567
|
+
session_count: number;
|
|
30568
|
+
/**
|
|
30569
|
+
* Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
|
|
30570
|
+
*/
|
|
30571
|
+
cost: {
|
|
30572
|
+
/**
|
|
30573
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30574
|
+
*/
|
|
30575
|
+
amount: string;
|
|
30576
|
+
/**
|
|
30577
|
+
* Always USD.
|
|
30578
|
+
*/
|
|
30579
|
+
currency: 'USD';
|
|
30580
|
+
};
|
|
30581
|
+
/**
|
|
30582
|
+
* Up to twenty sessions of the customer, and of anonymous customers merged into it, most recently updated first.
|
|
30583
|
+
*/
|
|
30584
|
+
recent_sessions: Array<{
|
|
30585
|
+
/**
|
|
30586
|
+
* Public sesn_ session identifier, usable with session retrieval.
|
|
30587
|
+
*/
|
|
30588
|
+
id: string;
|
|
30589
|
+
/**
|
|
30590
|
+
* Session title, or null when unset.
|
|
30591
|
+
*/
|
|
30592
|
+
title: string | null;
|
|
30593
|
+
/**
|
|
30594
|
+
* Session entry surface, or null when no surface was recorded.
|
|
30595
|
+
*/
|
|
30596
|
+
source: string | null;
|
|
30597
|
+
/**
|
|
30598
|
+
* Session creation time in UTC.
|
|
30599
|
+
*/
|
|
30600
|
+
created_at: string;
|
|
30601
|
+
/**
|
|
30602
|
+
* Most recent session update time in UTC.
|
|
30603
|
+
*/
|
|
30604
|
+
updated_at: string;
|
|
30605
|
+
}>;
|
|
30606
|
+
};
|
|
30607
|
+
};
|
|
30608
|
+
export type GetCustomerResponse = GetCustomerResponses[keyof GetCustomerResponses];
|
|
30609
|
+
export type GetCustomerDeletionData = {
|
|
30610
|
+
body?: never;
|
|
30611
|
+
path: {
|
|
30612
|
+
/**
|
|
30613
|
+
* Active service agent id from agent creation or listing.
|
|
30614
|
+
*/
|
|
30615
|
+
agent_id: string;
|
|
30616
|
+
/**
|
|
30617
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30618
|
+
*/
|
|
30619
|
+
customer_id: string;
|
|
30620
|
+
};
|
|
30621
|
+
query?: never;
|
|
30622
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion';
|
|
30623
|
+
};
|
|
30624
|
+
export type GetCustomerDeletionErrors = {
|
|
30625
|
+
/**
|
|
30626
|
+
* Authenticate with your API key or a console session.
|
|
30627
|
+
*/
|
|
30628
|
+
401: unknown;
|
|
30629
|
+
/**
|
|
30630
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30631
|
+
*/
|
|
30632
|
+
403: AgentError;
|
|
30633
|
+
/**
|
|
30634
|
+
* CUSTOMER_NOT_FOUND or no deletion task: the customer or task is unknown, or the caller is a customer access token.
|
|
30635
|
+
*/
|
|
30636
|
+
404: unknown;
|
|
30637
|
+
};
|
|
30638
|
+
export type GetCustomerDeletionError = GetCustomerDeletionErrors[keyof GetCustomerDeletionErrors];
|
|
30639
|
+
export type GetCustomerDeletionResponses = {
|
|
30640
|
+
/**
|
|
30641
|
+
* The latest deletion task and its snapshot counts.
|
|
30642
|
+
*/
|
|
30643
|
+
200: {
|
|
30644
|
+
/**
|
|
30645
|
+
* Deletion task identifier.
|
|
30646
|
+
*/
|
|
30647
|
+
id: string;
|
|
30648
|
+
/**
|
|
30649
|
+
* pending: accepted; snapshotting: exporting recovery data; deleting: verified snapshot exists and erasure is running; done: erasure completed; failed: stopped safely, retry DELETE to resume the same task.
|
|
30650
|
+
*/
|
|
30651
|
+
status: 'pending' | 'snapshotting' | 'deleting' | 'done' | 'failed';
|
|
30652
|
+
/**
|
|
30653
|
+
* Counts from the verified snapshot; empty until snapshotting completes.
|
|
30654
|
+
*/
|
|
30655
|
+
counts: {
|
|
30656
|
+
/**
|
|
30657
|
+
* Number of primary and child sessions in the snapshot.
|
|
30658
|
+
*/
|
|
30659
|
+
sessions?: number;
|
|
30660
|
+
/**
|
|
30661
|
+
* Number of durable session events captured without changing the history.
|
|
30662
|
+
*/
|
|
30663
|
+
events?: number;
|
|
30664
|
+
/**
|
|
30665
|
+
* Number of stored transcript messages in the snapshot.
|
|
30666
|
+
*/
|
|
30667
|
+
messages?: number;
|
|
30668
|
+
/**
|
|
30669
|
+
* Number of backed-up directory, authorization, feedback and projection rows.
|
|
30670
|
+
*/
|
|
30671
|
+
d1_rows?: number;
|
|
30672
|
+
/**
|
|
30673
|
+
* Number of session attachment references; their file bytes are retained.
|
|
30674
|
+
*/
|
|
30675
|
+
attachments?: number;
|
|
30676
|
+
};
|
|
30677
|
+
/**
|
|
30678
|
+
* Operator recovery snapshot key, retained for seven days. Attachment bytes are not copied or deleted.
|
|
30679
|
+
*/
|
|
30680
|
+
snapshot_key?: string;
|
|
30681
|
+
/**
|
|
30682
|
+
* Content-free failure summary; retry the confirmed deletion to resume.
|
|
30683
|
+
*/
|
|
30684
|
+
error?: string;
|
|
30685
|
+
/**
|
|
30686
|
+
* Task creation time in RFC 3339 format.
|
|
30687
|
+
*/
|
|
30688
|
+
created_at: string;
|
|
30689
|
+
/**
|
|
30690
|
+
* Latest task update time in RFC 3339 format.
|
|
30691
|
+
*/
|
|
30692
|
+
updated_at: string;
|
|
30693
|
+
};
|
|
30694
|
+
};
|
|
30695
|
+
export type GetCustomerDeletionResponse = GetCustomerDeletionResponses[keyof GetCustomerDeletionResponses];
|
|
30696
|
+
export type BlockCustomerData = {
|
|
30697
|
+
body?: never;
|
|
30698
|
+
path: {
|
|
30699
|
+
/**
|
|
30700
|
+
* Active service agent id from agent creation or listing.
|
|
30701
|
+
*/
|
|
30702
|
+
agent_id: string;
|
|
30703
|
+
/**
|
|
30704
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30705
|
+
*/
|
|
30706
|
+
customer_id: string;
|
|
30707
|
+
};
|
|
30708
|
+
query?: never;
|
|
30709
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/block';
|
|
30710
|
+
};
|
|
30711
|
+
export type BlockCustomerErrors = {
|
|
30712
|
+
/**
|
|
30713
|
+
* Authenticate with your API key or a console session.
|
|
30714
|
+
*/
|
|
30715
|
+
401: unknown;
|
|
30716
|
+
/**
|
|
30717
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30718
|
+
*/
|
|
30719
|
+
403: AgentError;
|
|
30720
|
+
/**
|
|
30721
|
+
* CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
|
|
30722
|
+
*/
|
|
30723
|
+
404: unknown;
|
|
30724
|
+
/**
|
|
30725
|
+
* Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
|
|
30726
|
+
*/
|
|
30727
|
+
502: unknown;
|
|
30728
|
+
};
|
|
30729
|
+
export type BlockCustomerError = BlockCustomerErrors[keyof BlockCustomerErrors];
|
|
30730
|
+
export type BlockCustomerResponses = {
|
|
30731
|
+
/**
|
|
30732
|
+
* The customer after the change.
|
|
30733
|
+
*/
|
|
30734
|
+
200: {
|
|
30735
|
+
/**
|
|
30736
|
+
* The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
|
|
30737
|
+
*/
|
|
30738
|
+
id: string;
|
|
30739
|
+
/**
|
|
30740
|
+
* identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
|
|
30741
|
+
*/
|
|
30742
|
+
type: 'identified' | 'anonymous';
|
|
30743
|
+
/**
|
|
30744
|
+
* For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
|
|
30745
|
+
*/
|
|
30746
|
+
merged_into: string | null;
|
|
30747
|
+
/**
|
|
30748
|
+
* Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
|
|
30749
|
+
*/
|
|
30750
|
+
blocked: boolean;
|
|
30751
|
+
/**
|
|
30752
|
+
* Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
|
|
30753
|
+
*/
|
|
30754
|
+
first_seen_at: string | null;
|
|
30755
|
+
/**
|
|
30756
|
+
* Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
|
|
30757
|
+
*/
|
|
30758
|
+
last_seen_at: string | null;
|
|
30759
|
+
/**
|
|
30760
|
+
* Sessions of this customer on this agent, including those of anonymous customers merged into it.
|
|
30761
|
+
*/
|
|
30762
|
+
session_count: number;
|
|
30763
|
+
/**
|
|
30764
|
+
* Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
|
|
30765
|
+
*/
|
|
30766
|
+
cost: {
|
|
30767
|
+
/**
|
|
30768
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30769
|
+
*/
|
|
30770
|
+
amount: string;
|
|
30771
|
+
/**
|
|
30772
|
+
* Always USD.
|
|
30773
|
+
*/
|
|
30774
|
+
currency: 'USD';
|
|
30775
|
+
};
|
|
30776
|
+
};
|
|
30777
|
+
};
|
|
30778
|
+
export type BlockCustomerResponse = BlockCustomerResponses[keyof BlockCustomerResponses];
|
|
30779
|
+
export type UnblockCustomerData = {
|
|
30780
|
+
body?: never;
|
|
30781
|
+
path: {
|
|
30782
|
+
/**
|
|
30783
|
+
* Active service agent id from agent creation or listing.
|
|
30784
|
+
*/
|
|
30785
|
+
agent_id: string;
|
|
30786
|
+
/**
|
|
30787
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30788
|
+
*/
|
|
30789
|
+
customer_id: string;
|
|
30790
|
+
};
|
|
30791
|
+
query?: never;
|
|
30792
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock';
|
|
30793
|
+
};
|
|
30794
|
+
export type UnblockCustomerErrors = {
|
|
30795
|
+
/**
|
|
30796
|
+
* Authenticate with your API key or a console session.
|
|
30797
|
+
*/
|
|
30798
|
+
401: unknown;
|
|
30799
|
+
/**
|
|
30800
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30801
|
+
*/
|
|
30802
|
+
403: AgentError;
|
|
30803
|
+
/**
|
|
30804
|
+
* CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
|
|
30805
|
+
*/
|
|
30806
|
+
404: unknown;
|
|
30807
|
+
};
|
|
30808
|
+
export type UnblockCustomerError = UnblockCustomerErrors[keyof UnblockCustomerErrors];
|
|
30809
|
+
export type UnblockCustomerResponses = {
|
|
30810
|
+
/**
|
|
30811
|
+
* The customer after the change.
|
|
30812
|
+
*/
|
|
30813
|
+
200: {
|
|
30814
|
+
/**
|
|
30815
|
+
* The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
|
|
30816
|
+
*/
|
|
30817
|
+
id: string;
|
|
30818
|
+
/**
|
|
30819
|
+
* identified: signed in through a grant code from your backend, or seen under your own id before customer sign-in existed. anonymous: a visitor admitted with the publishable key.
|
|
30820
|
+
*/
|
|
30821
|
+
type: 'identified' | 'anonymous';
|
|
30822
|
+
/**
|
|
30823
|
+
* For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
|
|
30824
|
+
*/
|
|
30825
|
+
merged_into: string | null;
|
|
30826
|
+
/**
|
|
30827
|
+
* Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
|
|
30828
|
+
*/
|
|
30829
|
+
blocked: boolean;
|
|
30830
|
+
/**
|
|
30831
|
+
* Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
|
|
30832
|
+
*/
|
|
30833
|
+
first_seen_at: string | null;
|
|
30834
|
+
/**
|
|
30835
|
+
* Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
|
|
30836
|
+
*/
|
|
30837
|
+
last_seen_at: string | null;
|
|
30838
|
+
/**
|
|
30839
|
+
* Sessions of this customer on this agent, including those of anonymous customers merged into it.
|
|
30840
|
+
*/
|
|
30841
|
+
session_count: number;
|
|
30842
|
+
/**
|
|
30843
|
+
* Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
|
|
30844
|
+
*/
|
|
30845
|
+
cost: {
|
|
30846
|
+
/**
|
|
30847
|
+
* Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
|
|
30848
|
+
*/
|
|
30849
|
+
amount: string;
|
|
30850
|
+
/**
|
|
30851
|
+
* Always USD.
|
|
30852
|
+
*/
|
|
30853
|
+
currency: 'USD';
|
|
30854
|
+
};
|
|
30855
|
+
};
|
|
30856
|
+
};
|
|
30857
|
+
export type UnblockCustomerResponse = UnblockCustomerResponses[keyof UnblockCustomerResponses];
|
|
30858
|
+
export type RevokeCustomerTokensData = {
|
|
30859
|
+
body?: never;
|
|
30860
|
+
path: {
|
|
30861
|
+
/**
|
|
30862
|
+
* Active service agent id from agent creation or listing.
|
|
30863
|
+
*/
|
|
30864
|
+
agent_id: string;
|
|
30865
|
+
/**
|
|
30866
|
+
* Customer id from customer listing, or your own customer_id.
|
|
30867
|
+
*/
|
|
30868
|
+
customer_id: string;
|
|
30869
|
+
};
|
|
30870
|
+
query?: never;
|
|
30871
|
+
url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens';
|
|
30872
|
+
};
|
|
30873
|
+
export type RevokeCustomerTokensErrors = {
|
|
30874
|
+
/**
|
|
30875
|
+
* Authenticate with your API key or a console session.
|
|
30876
|
+
*/
|
|
30877
|
+
401: unknown;
|
|
30878
|
+
/**
|
|
30879
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30880
|
+
*/
|
|
30881
|
+
403: AgentError;
|
|
30882
|
+
/**
|
|
30883
|
+
* CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
|
|
30884
|
+
*/
|
|
30885
|
+
404: unknown;
|
|
30886
|
+
/**
|
|
30887
|
+
* Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
|
|
30888
|
+
*/
|
|
30889
|
+
502: unknown;
|
|
30890
|
+
};
|
|
30891
|
+
export type RevokeCustomerTokensError = RevokeCustomerTokensErrors[keyof RevokeCustomerTokensErrors];
|
|
30892
|
+
export type RevokeCustomerTokensResponses = {
|
|
30893
|
+
/**
|
|
30894
|
+
* How many access tokens this request revoked.
|
|
30895
|
+
*/
|
|
30896
|
+
200: {
|
|
30897
|
+
/**
|
|
30898
|
+
* Number of access tokens this request revoked; 0 when none was live.
|
|
30899
|
+
*/
|
|
30900
|
+
revoked: number;
|
|
30901
|
+
};
|
|
30902
|
+
};
|
|
30903
|
+
export type RevokeCustomerTokensResponse = RevokeCustomerTokensResponses[keyof RevokeCustomerTokensResponses];
|
|
30904
|
+
export type GetAgentAppearanceData = {
|
|
30905
|
+
body?: never;
|
|
30906
|
+
path: {
|
|
30907
|
+
/**
|
|
30908
|
+
* Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
|
|
30909
|
+
*/
|
|
30910
|
+
agent_id: string;
|
|
30911
|
+
};
|
|
30912
|
+
query?: never;
|
|
30913
|
+
url: '/agent/v1/agents/{agent_id}/appearance';
|
|
30914
|
+
};
|
|
30915
|
+
export type GetAgentAppearanceErrors = {
|
|
30916
|
+
/**
|
|
30917
|
+
* Authenticate with a customer access token of this agent, your API key or a console session.
|
|
30918
|
+
*/
|
|
30919
|
+
401: unknown;
|
|
30920
|
+
/**
|
|
30921
|
+
* permission_error: the credential's role or bound resources do not allow this operation. Use a key with access to the agent domain and its resources.
|
|
30922
|
+
*/
|
|
30923
|
+
403: AgentError;
|
|
30924
|
+
/**
|
|
30925
|
+
* AGENT_NOT_FOUND: the agent is absent, archived or not a service agent, or the customer access token belongs to another agent.
|
|
30926
|
+
*/
|
|
30927
|
+
404: unknown;
|
|
30928
|
+
/**
|
|
30929
|
+
* Appearance is temporarily unavailable; use the default appearance and continue the conversation.
|
|
30930
|
+
*/
|
|
30931
|
+
503: unknown;
|
|
30932
|
+
};
|
|
30933
|
+
export type GetAgentAppearanceError = GetAgentAppearanceErrors[keyof GetAgentAppearanceErrors];
|
|
30934
|
+
export type GetAgentAppearanceResponses = {
|
|
30935
|
+
/**
|
|
30936
|
+
* Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
|
|
30937
|
+
*/
|
|
30938
|
+
200: {
|
|
30939
|
+
/**
|
|
30940
|
+
* Public identity displayed on the chat page, independent of the internal agent name.
|
|
30941
|
+
*/
|
|
30942
|
+
agent?: {
|
|
30943
|
+
/**
|
|
30944
|
+
* Display name; omission keeps the neutral browser-language default.
|
|
30945
|
+
*/
|
|
30946
|
+
name?: string;
|
|
30947
|
+
/**
|
|
30948
|
+
* Optional HTTPS avatar image URL; non-HTTPS images are rejected.
|
|
30949
|
+
*/
|
|
30950
|
+
avatar?: string;
|
|
30951
|
+
};
|
|
30952
|
+
/**
|
|
30953
|
+
* Loader default: inline stays in the page, sidebar attaches to the edge, popup floats above its launcher, modal centers an overlay. A script data-layout overrides it; Hosted always uses inline.
|
|
30954
|
+
*/
|
|
30955
|
+
layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
|
|
30956
|
+
/**
|
|
30957
|
+
* Default entry button for the loader; an explicit script data-launcher takes precedence.
|
|
30958
|
+
*/
|
|
30959
|
+
launcher?: {
|
|
30960
|
+
/**
|
|
30961
|
+
* Entry control: none hides the launcher, bubble shows a button, mascot shows a character that reacts while the visitor types and the agent thinks and answers. A mascot needs pack.
|
|
30962
|
+
*/
|
|
30963
|
+
type: 'none' | 'bubble' | 'mascot';
|
|
30964
|
+
/**
|
|
30965
|
+
* Mascot images: exactly one of preset or images. Send pack, not image.
|
|
30966
|
+
*/
|
|
30967
|
+
pack?: {
|
|
30968
|
+
/**
|
|
30969
|
+
* Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
|
|
30970
|
+
*/
|
|
30971
|
+
preset?: 'mint' | 'cat' | 'bot';
|
|
30972
|
+
/**
|
|
30973
|
+
* One HTTPS image per slot; only idle is required and a missing slot shows idle. Use 2:3 canvases with the feet bottom-centered on a transparent background; PNG or WebP stay still, GIF, WebP and APNG play as they are.
|
|
30974
|
+
*/
|
|
30975
|
+
images?: {
|
|
30976
|
+
/**
|
|
30977
|
+
* Resting state.
|
|
30978
|
+
*/
|
|
30979
|
+
idle: string;
|
|
30980
|
+
/**
|
|
30981
|
+
* Page open and while the greeting bubble shows.
|
|
30982
|
+
*/
|
|
30983
|
+
greet?: string;
|
|
30984
|
+
/**
|
|
30985
|
+
* The visitor is typing in the composer.
|
|
30986
|
+
*/
|
|
30987
|
+
listening?: string;
|
|
30988
|
+
/**
|
|
30989
|
+
* After the visitor sends, before the first reply text.
|
|
30990
|
+
*/
|
|
30991
|
+
thinking?: string;
|
|
30992
|
+
/**
|
|
30993
|
+
* While the reply streams; alternates with talking-2 every 220 ms.
|
|
30994
|
+
*/
|
|
30995
|
+
talking?: string;
|
|
30996
|
+
/**
|
|
30997
|
+
* Second mouth frame of talking, mouth closed; without it talking alternates with idle.
|
|
30998
|
+
*/
|
|
30999
|
+
'talking-2'?: string;
|
|
31000
|
+
/**
|
|
31001
|
+
* The last turn failed or was refused.
|
|
31002
|
+
*/
|
|
31003
|
+
sorry?: string;
|
|
31004
|
+
/**
|
|
31005
|
+
* No interaction for 60 seconds; hover or click wakes the mascot.
|
|
31006
|
+
*/
|
|
31007
|
+
sleep?: string;
|
|
31008
|
+
};
|
|
31009
|
+
};
|
|
31010
|
+
/**
|
|
31011
|
+
* Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
|
|
31012
|
+
*/
|
|
31013
|
+
image?: string;
|
|
31014
|
+
/**
|
|
31015
|
+
* float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
|
|
31016
|
+
*/
|
|
31017
|
+
motion?: 'float' | 'none';
|
|
31018
|
+
/**
|
|
31019
|
+
* Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
|
|
31020
|
+
*/
|
|
31021
|
+
position?: 'bottom-right' | 'bottom-left';
|
|
31022
|
+
/**
|
|
31023
|
+
* Accessible entry button label and bubble text; omission uses the default chat label.
|
|
31024
|
+
*/
|
|
31025
|
+
label?: string;
|
|
31026
|
+
};
|
|
31027
|
+
/**
|
|
31028
|
+
* Visible chat heading; omitted title uses the public agent name.
|
|
31029
|
+
*/
|
|
31030
|
+
header?: {
|
|
31031
|
+
/**
|
|
31032
|
+
* Optional heading text shown instead of the public agent name.
|
|
31033
|
+
*/
|
|
31034
|
+
title?: string;
|
|
31035
|
+
/**
|
|
31036
|
+
* Optional secondary line beneath the heading.
|
|
31037
|
+
*/
|
|
31038
|
+
subtitle?: string;
|
|
31039
|
+
/**
|
|
31040
|
+
* Optional HTTPS image shown in the heading avatar position.
|
|
31041
|
+
*/
|
|
31042
|
+
icon?: string;
|
|
31043
|
+
};
|
|
31044
|
+
/**
|
|
31045
|
+
* Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
|
|
31046
|
+
*/
|
|
31047
|
+
theme?: {
|
|
31048
|
+
/**
|
|
31049
|
+
* light or dark selects a fixed scheme; system follows the device preference.
|
|
31050
|
+
*/
|
|
31051
|
+
colorScheme?: 'light' | 'dark' | 'system';
|
|
31052
|
+
/**
|
|
31053
|
+
* Explicit opaque CSS accent color, for example #167A43.
|
|
31054
|
+
*/
|
|
31055
|
+
accent?: string;
|
|
31056
|
+
/**
|
|
31057
|
+
* Explicit opaque CSS background color, for example #ffffff.
|
|
31058
|
+
*/
|
|
31059
|
+
surface?: string;
|
|
31060
|
+
/**
|
|
31061
|
+
* neutral uses grayscale surfaces, warm uses warm tones, cool uses cool tones.
|
|
31062
|
+
*/
|
|
31063
|
+
grayscale?: 'neutral' | 'warm' | 'cool';
|
|
31064
|
+
/**
|
|
31065
|
+
* Corner rounding: none is square, sm is small, md is medium, lg is large, full is fully rounded.
|
|
31066
|
+
*/
|
|
31067
|
+
radius?: 'none' | 'sm' | 'md' | 'lg' | 'full';
|
|
31068
|
+
/**
|
|
31069
|
+
* Spacing: compact reduces gaps, normal uses defaults, spacious increases gaps.
|
|
31070
|
+
*/
|
|
31071
|
+
density?: 'compact' | 'normal' | 'spacious';
|
|
31072
|
+
/**
|
|
31073
|
+
* CSS font family list using fonts available on the device; external font loading is not configured here.
|
|
31074
|
+
*/
|
|
31075
|
+
fontFamily?: string;
|
|
31076
|
+
/**
|
|
31077
|
+
* Positive base font size in CSS pixels; omission preserves Kit sizing.
|
|
31078
|
+
*/
|
|
31079
|
+
fontSize?: number;
|
|
31080
|
+
};
|
|
31081
|
+
/**
|
|
31082
|
+
* Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
|
|
31083
|
+
*/
|
|
31084
|
+
locale?: 'zh' | 'en';
|
|
31085
|
+
/**
|
|
31086
|
+
* Content displayed before the first message in a conversation.
|
|
31087
|
+
*/
|
|
31088
|
+
startScreen?: {
|
|
31089
|
+
/**
|
|
31090
|
+
* Optional welcome text on the empty conversation.
|
|
31091
|
+
*/
|
|
31092
|
+
greeting?: string;
|
|
31093
|
+
/**
|
|
31094
|
+
* Up to four suggested questions; clicking a label sends its prompt text.
|
|
31095
|
+
*/
|
|
31096
|
+
prompts?: Array<{
|
|
31097
|
+
/**
|
|
31098
|
+
* Visible suggested-question button text.
|
|
31099
|
+
*/
|
|
31100
|
+
label: string;
|
|
31101
|
+
/**
|
|
31102
|
+
* User message sent when this suggestion is selected.
|
|
31103
|
+
*/
|
|
31104
|
+
prompt: string;
|
|
31105
|
+
}>;
|
|
31106
|
+
};
|
|
31107
|
+
/**
|
|
31108
|
+
* Message input appearance; transport and attachment settings are excluded.
|
|
31109
|
+
*/
|
|
31110
|
+
composer?: {
|
|
31111
|
+
/**
|
|
31112
|
+
* Hint shown when the message input is empty.
|
|
31113
|
+
*/
|
|
31114
|
+
placeholder?: string;
|
|
31115
|
+
};
|
|
31116
|
+
/**
|
|
31117
|
+
* Optional notice displayed beside the conversation composer.
|
|
31118
|
+
*/
|
|
31119
|
+
disclaimer?: string;
|
|
31120
|
+
/**
|
|
31121
|
+
* Optional text below the conversation.
|
|
31122
|
+
*/
|
|
31123
|
+
footer?: string;
|
|
31124
|
+
/**
|
|
31125
|
+
* Availability of the conversation history control.
|
|
31126
|
+
*/
|
|
31127
|
+
history?: {
|
|
31128
|
+
/**
|
|
31129
|
+
* False hides history; omission uses the default enabled state.
|
|
31130
|
+
*/
|
|
31131
|
+
enabled?: boolean;
|
|
31132
|
+
};
|
|
31133
|
+
};
|
|
31134
|
+
};
|
|
31135
|
+
export type GetAgentAppearanceResponse = GetAgentAppearanceResponses[keyof GetAgentAppearanceResponses];
|
|
30268
31136
|
export type CreateCustomerGrantCodeData = {
|
|
30269
31137
|
body: {
|
|
30270
31138
|
/**
|
|
@@ -30276,9 +31144,27 @@ export type CreateCustomerGrantCodeData = {
|
|
|
30276
31144
|
*/
|
|
30277
31145
|
version?: number;
|
|
30278
31146
|
/**
|
|
30279
|
-
* Budget
|
|
31147
|
+
* Budget for each session the customer starts, in the same shape as a session budget. Defaults to the embed policy session budget and cannot exceed its maximum.
|
|
30280
31148
|
*/
|
|
30281
|
-
|
|
31149
|
+
budget?: {
|
|
31150
|
+
/**
|
|
31151
|
+
* Budget kind; always limit.
|
|
31152
|
+
*/
|
|
31153
|
+
type: 'limit';
|
|
31154
|
+
/**
|
|
31155
|
+
* Spending limit of each session the customer starts.
|
|
31156
|
+
*/
|
|
31157
|
+
max_list_cost: {
|
|
31158
|
+
/**
|
|
31159
|
+
* Largest list cost of each session, in US dollars, as a decimal string with at most 2 fraction digits, e.g. "0.50". "0" lets the customer sign in without spending.
|
|
31160
|
+
*/
|
|
31161
|
+
amount: string;
|
|
31162
|
+
/**
|
|
31163
|
+
* Always USD.
|
|
31164
|
+
*/
|
|
31165
|
+
currency: 'USD';
|
|
31166
|
+
};
|
|
31167
|
+
};
|
|
30282
31168
|
/**
|
|
30283
31169
|
* Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.
|
|
30284
31170
|
*/
|
|
@@ -36159,6 +37045,19 @@ export type ForkSessionResponses = {
|
|
|
36159
37045
|
*/
|
|
36160
37046
|
web_search_requests?: number;
|
|
36161
37047
|
};
|
|
37048
|
+
/**
|
|
37049
|
+
* Praxis extension: priced runtime of this session (the time it was running), billed separately from list_cost and not counted against the budget. amount is in US dollars as a decimal string with exactly 6 decimals, e.g. "0.000280". Each thread's runtime is reported on that thread. /agent/v1 only.
|
|
37050
|
+
*/
|
|
37051
|
+
runtime_cost?: {
|
|
37052
|
+
/**
|
|
37053
|
+
* Runtime cost in US dollars, decimal string with exactly 6 decimals.
|
|
37054
|
+
*/
|
|
37055
|
+
amount: string;
|
|
37056
|
+
/**
|
|
37057
|
+
* Always USD.
|
|
37058
|
+
*/
|
|
37059
|
+
currency: 'USD';
|
|
37060
|
+
};
|
|
36162
37061
|
};
|
|
36163
37062
|
/**
|
|
36164
37063
|
* Vault IDs attached to the session at creation. Empty when no vaults were
|
|
@@ -43313,7 +44212,7 @@ export type ListOrganizationCostsResponses = {
|
|
|
43313
44212
|
*/
|
|
43314
44213
|
ResourceName?: string;
|
|
43315
44214
|
/**
|
|
43316
|
-
*
|
|
44215
|
+
* Amount in BillingCurrency: US dollars for USD, decimal string, 6 decimals.
|
|
43317
44216
|
*/
|
|
43318
44217
|
BilledCost: string;
|
|
43319
44218
|
/**
|
|
@@ -43531,7 +44430,7 @@ export type ListOrganizationEventsResponses = {
|
|
|
43531
44430
|
*/
|
|
43532
44431
|
ResourceName: string;
|
|
43533
44432
|
/**
|
|
43534
|
-
* Amount billed
|
|
44433
|
+
* Amount billed: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`); unsettled usage counts as `0.000000` until it settles.
|
|
43535
44434
|
*/
|
|
43536
44435
|
BilledCost: string;
|
|
43537
44436
|
/**
|
|
@@ -43555,7 +44454,7 @@ export type ListOrganizationEventsResponses = {
|
|
|
43555
44454
|
*/
|
|
43556
44455
|
status: 'settled' | 'no_charge' | 'rejected';
|
|
43557
44456
|
/**
|
|
43558
|
-
*
|
|
44457
|
+
* Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
|
|
43559
44458
|
*/
|
|
43560
44459
|
shortfall: string | null;
|
|
43561
44460
|
/**
|
|
@@ -43652,7 +44551,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43652
44551
|
*/
|
|
43653
44552
|
ResourceName: string;
|
|
43654
44553
|
/**
|
|
43655
|
-
* Amount billed
|
|
44554
|
+
* Amount billed: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`); unsettled usage counts as `0.000000` until it settles.
|
|
43656
44555
|
*/
|
|
43657
44556
|
BilledCost: string;
|
|
43658
44557
|
/**
|
|
@@ -43676,7 +44575,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43676
44575
|
*/
|
|
43677
44576
|
status: 'settled' | 'no_charge' | 'rejected';
|
|
43678
44577
|
/**
|
|
43679
|
-
*
|
|
44578
|
+
* Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
|
|
43680
44579
|
*/
|
|
43681
44580
|
shortfall: string | null;
|
|
43682
44581
|
/**
|
|
@@ -43713,7 +44612,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43713
44612
|
*/
|
|
43714
44613
|
PricingUnit: string | null;
|
|
43715
44614
|
/**
|
|
43716
|
-
* Amount billed for this line
|
|
44615
|
+
* Amount billed for this line: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`).
|
|
43717
44616
|
*/
|
|
43718
44617
|
BilledCost: string;
|
|
43719
44618
|
}>;
|
|
@@ -43726,7 +44625,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43726
44625
|
*/
|
|
43727
44626
|
transaction_id: string;
|
|
43728
44627
|
/**
|
|
43729
|
-
* Amount billed
|
|
44628
|
+
* Amount billed: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`); unsettled usage counts as `0.000000` until it settles.
|
|
43730
44629
|
*/
|
|
43731
44630
|
BilledCost: string;
|
|
43732
44631
|
/**
|
|
@@ -43780,7 +44679,7 @@ export type ExportOrganizationChargesResponses = {
|
|
|
43780
44679
|
*/
|
|
43781
44680
|
ChargePeriodEnd: string;
|
|
43782
44681
|
/**
|
|
43783
|
-
* Amount billed
|
|
44682
|
+
* Amount billed: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`); unsettled usage counts as `0.000000` until it settles.
|
|
43784
44683
|
*/
|
|
43785
44684
|
BilledCost: string;
|
|
43786
44685
|
/**
|
|
@@ -45315,7 +46214,7 @@ export type AgentsListResponses = {
|
|
|
45315
46214
|
*/
|
|
45316
46215
|
note: string | null;
|
|
45317
46216
|
/**
|
|
45318
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
46217
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
45319
46218
|
*/
|
|
45320
46219
|
bindings: Array<{
|
|
45321
46220
|
/**
|
|
@@ -45334,6 +46233,10 @@ export type AgentsListResponses = {
|
|
|
45334
46233
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
45335
46234
|
*/
|
|
45336
46235
|
instructions?: string;
|
|
46236
|
+
/**
|
|
46237
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
46238
|
+
*/
|
|
46239
|
+
readonly verified?: boolean;
|
|
45337
46240
|
/**
|
|
45338
46241
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45339
46242
|
*/
|
|
@@ -45343,6 +46246,10 @@ export type AgentsListResponses = {
|
|
|
45343
46246
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45344
46247
|
*/
|
|
45345
46248
|
type: 'search' | 'browser';
|
|
46249
|
+
/**
|
|
46250
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
46251
|
+
*/
|
|
46252
|
+
readonly verified?: boolean;
|
|
45346
46253
|
/**
|
|
45347
46254
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45348
46255
|
*/
|
|
@@ -45360,6 +46267,10 @@ export type AgentsListResponses = {
|
|
|
45360
46267
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
45361
46268
|
*/
|
|
45362
46269
|
subagent_model?: string | null;
|
|
46270
|
+
/**
|
|
46271
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
46272
|
+
*/
|
|
46273
|
+
image_model?: string | null;
|
|
45363
46274
|
/**
|
|
45364
46275
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
45365
46276
|
*/
|
|
@@ -45815,7 +46726,7 @@ export type AgentsCreateData = {
|
|
|
45815
46726
|
*/
|
|
45816
46727
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
45817
46728
|
/**
|
|
45818
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
46729
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
45819
46730
|
*/
|
|
45820
46731
|
bindings?: Array<{
|
|
45821
46732
|
/**
|
|
@@ -45834,6 +46745,10 @@ export type AgentsCreateData = {
|
|
|
45834
46745
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
45835
46746
|
*/
|
|
45836
46747
|
instructions?: string;
|
|
46748
|
+
/**
|
|
46749
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
46750
|
+
*/
|
|
46751
|
+
readonly verified?: boolean;
|
|
45837
46752
|
/**
|
|
45838
46753
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45839
46754
|
*/
|
|
@@ -45843,6 +46758,10 @@ export type AgentsCreateData = {
|
|
|
45843
46758
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45844
46759
|
*/
|
|
45845
46760
|
type: 'search' | 'browser';
|
|
46761
|
+
/**
|
|
46762
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
46763
|
+
*/
|
|
46764
|
+
readonly verified?: boolean;
|
|
45846
46765
|
/**
|
|
45847
46766
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45848
46767
|
*/
|
|
@@ -45860,6 +46779,10 @@ export type AgentsCreateData = {
|
|
|
45860
46779
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
45861
46780
|
*/
|
|
45862
46781
|
subagent_model?: string | null;
|
|
46782
|
+
/**
|
|
46783
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
46784
|
+
*/
|
|
46785
|
+
image_model?: string | null;
|
|
45863
46786
|
/**
|
|
45864
46787
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
45865
46788
|
*/
|
|
@@ -46376,7 +47299,7 @@ export type AgentsCreateResponses = {
|
|
|
46376
47299
|
*/
|
|
46377
47300
|
note: string | null;
|
|
46378
47301
|
/**
|
|
46379
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
47302
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
46380
47303
|
*/
|
|
46381
47304
|
bindings: Array<{
|
|
46382
47305
|
/**
|
|
@@ -46395,6 +47318,10 @@ export type AgentsCreateResponses = {
|
|
|
46395
47318
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46396
47319
|
*/
|
|
46397
47320
|
instructions?: string;
|
|
47321
|
+
/**
|
|
47322
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
47323
|
+
*/
|
|
47324
|
+
readonly verified?: boolean;
|
|
46398
47325
|
/**
|
|
46399
47326
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46400
47327
|
*/
|
|
@@ -46404,6 +47331,10 @@ export type AgentsCreateResponses = {
|
|
|
46404
47331
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
46405
47332
|
*/
|
|
46406
47333
|
type: 'search' | 'browser';
|
|
47334
|
+
/**
|
|
47335
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
47336
|
+
*/
|
|
47337
|
+
readonly verified?: boolean;
|
|
46407
47338
|
/**
|
|
46408
47339
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
46409
47340
|
*/
|
|
@@ -46421,6 +47352,10 @@ export type AgentsCreateResponses = {
|
|
|
46421
47352
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
46422
47353
|
*/
|
|
46423
47354
|
subagent_model?: string | null;
|
|
47355
|
+
/**
|
|
47356
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
47357
|
+
*/
|
|
47358
|
+
image_model?: string | null;
|
|
46424
47359
|
/**
|
|
46425
47360
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
46426
47361
|
*/
|
|
@@ -46960,7 +47895,7 @@ export type AgentsRetrieveResponses = {
|
|
|
46960
47895
|
*/
|
|
46961
47896
|
note: string | null;
|
|
46962
47897
|
/**
|
|
46963
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
47898
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
46964
47899
|
*/
|
|
46965
47900
|
bindings: Array<{
|
|
46966
47901
|
/**
|
|
@@ -46979,6 +47914,10 @@ export type AgentsRetrieveResponses = {
|
|
|
46979
47914
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46980
47915
|
*/
|
|
46981
47916
|
instructions?: string;
|
|
47917
|
+
/**
|
|
47918
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
47919
|
+
*/
|
|
47920
|
+
readonly verified?: boolean;
|
|
46982
47921
|
/**
|
|
46983
47922
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46984
47923
|
*/
|
|
@@ -46988,6 +47927,10 @@ export type AgentsRetrieveResponses = {
|
|
|
46988
47927
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
46989
47928
|
*/
|
|
46990
47929
|
type: 'search' | 'browser';
|
|
47930
|
+
/**
|
|
47931
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
47932
|
+
*/
|
|
47933
|
+
readonly verified?: boolean;
|
|
46991
47934
|
/**
|
|
46992
47935
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
46993
47936
|
*/
|
|
@@ -47005,6 +47948,10 @@ export type AgentsRetrieveResponses = {
|
|
|
47005
47948
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
47006
47949
|
*/
|
|
47007
47950
|
subagent_model?: string | null;
|
|
47951
|
+
/**
|
|
47952
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
47953
|
+
*/
|
|
47954
|
+
image_model?: string | null;
|
|
47008
47955
|
/**
|
|
47009
47956
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
47010
47957
|
*/
|
|
@@ -47491,6 +48438,10 @@ export type AgentsUpdateData = {
|
|
|
47491
48438
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
47492
48439
|
*/
|
|
47493
48440
|
instructions?: string;
|
|
48441
|
+
/**
|
|
48442
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
48443
|
+
*/
|
|
48444
|
+
readonly verified?: boolean;
|
|
47494
48445
|
/**
|
|
47495
48446
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
47496
48447
|
*/
|
|
@@ -47500,6 +48451,10 @@ export type AgentsUpdateData = {
|
|
|
47500
48451
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
47501
48452
|
*/
|
|
47502
48453
|
type: 'search' | 'browser';
|
|
48454
|
+
/**
|
|
48455
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
48456
|
+
*/
|
|
48457
|
+
readonly verified?: boolean;
|
|
47503
48458
|
/**
|
|
47504
48459
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
47505
48460
|
*/
|
|
@@ -47517,6 +48472,10 @@ export type AgentsUpdateData = {
|
|
|
47517
48472
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
47518
48473
|
*/
|
|
47519
48474
|
subagent_model?: string | null;
|
|
48475
|
+
/**
|
|
48476
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
48477
|
+
*/
|
|
48478
|
+
image_model?: string | null;
|
|
47520
48479
|
/**
|
|
47521
48480
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
47522
48481
|
*/
|
|
@@ -48042,7 +49001,7 @@ export type AgentsUpdateResponses = {
|
|
|
48042
49001
|
*/
|
|
48043
49002
|
note: string | null;
|
|
48044
49003
|
/**
|
|
48045
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
49004
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
48046
49005
|
*/
|
|
48047
49006
|
bindings: Array<{
|
|
48048
49007
|
/**
|
|
@@ -48061,6 +49020,10 @@ export type AgentsUpdateResponses = {
|
|
|
48061
49020
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
48062
49021
|
*/
|
|
48063
49022
|
instructions?: string;
|
|
49023
|
+
/**
|
|
49024
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
49025
|
+
*/
|
|
49026
|
+
readonly verified?: boolean;
|
|
48064
49027
|
/**
|
|
48065
49028
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
48066
49029
|
*/
|
|
@@ -48070,6 +49033,10 @@ export type AgentsUpdateResponses = {
|
|
|
48070
49033
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
48071
49034
|
*/
|
|
48072
49035
|
type: 'search' | 'browser';
|
|
49036
|
+
/**
|
|
49037
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
49038
|
+
*/
|
|
49039
|
+
readonly verified?: boolean;
|
|
48073
49040
|
/**
|
|
48074
49041
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
48075
49042
|
*/
|
|
@@ -48087,6 +49054,10 @@ export type AgentsUpdateResponses = {
|
|
|
48087
49054
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
48088
49055
|
*/
|
|
48089
49056
|
subagent_model?: string | null;
|
|
49057
|
+
/**
|
|
49058
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
49059
|
+
*/
|
|
49060
|
+
image_model?: string | null;
|
|
48090
49061
|
/**
|
|
48091
49062
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
48092
49063
|
*/
|
|
@@ -48616,7 +49587,7 @@ export type AgentsArchiveResponses = {
|
|
|
48616
49587
|
*/
|
|
48617
49588
|
note: string | null;
|
|
48618
49589
|
/**
|
|
48619
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
49590
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
48620
49591
|
*/
|
|
48621
49592
|
bindings: Array<{
|
|
48622
49593
|
/**
|
|
@@ -48635,6 +49606,10 @@ export type AgentsArchiveResponses = {
|
|
|
48635
49606
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
48636
49607
|
*/
|
|
48637
49608
|
instructions?: string;
|
|
49609
|
+
/**
|
|
49610
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
49611
|
+
*/
|
|
49612
|
+
readonly verified?: boolean;
|
|
48638
49613
|
/**
|
|
48639
49614
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
48640
49615
|
*/
|
|
@@ -48644,6 +49619,10 @@ export type AgentsArchiveResponses = {
|
|
|
48644
49619
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
48645
49620
|
*/
|
|
48646
49621
|
type: 'search' | 'browser';
|
|
49622
|
+
/**
|
|
49623
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
49624
|
+
*/
|
|
49625
|
+
readonly verified?: boolean;
|
|
48647
49626
|
/**
|
|
48648
49627
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
48649
49628
|
*/
|
|
@@ -48661,6 +49640,10 @@ export type AgentsArchiveResponses = {
|
|
|
48661
49640
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
48662
49641
|
*/
|
|
48663
49642
|
subagent_model?: string | null;
|
|
49643
|
+
/**
|
|
49644
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
49645
|
+
*/
|
|
49646
|
+
image_model?: string | null;
|
|
48664
49647
|
/**
|
|
48665
49648
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
48666
49649
|
*/
|
|
@@ -49208,7 +50191,7 @@ export type AgentsVersionsListResponses = {
|
|
|
49208
50191
|
*/
|
|
49209
50192
|
note: string | null;
|
|
49210
50193
|
/**
|
|
49211
|
-
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings.
|
|
50194
|
+
* Platform resources and services this service agent's codemode may reach, as one list of typed bindings. Only kind=service accepts a nonempty list; personal agents return 400. There are two kinds. A resource binding names one resource with id and access: database (id db_..., read_only or read_write), vector_store (id vs_..., read_only or read_write), file (id file- plus 24 letters or digits, as the File API returns it; read_only), media_library (any id without ':' or whitespace, read_only or read_write), model (a model catalog id, invoke), workflow and script (id <namespace>/<name>, invoke). A service binding opens a whole service and carries only enabled: search or browser. At most 20 bindings per type, no repeated type and id, and each service type at most once. A session is authorized by the agent version it runs: newly added bindings apply only to new sessions, and a version saved with apply=false changes no access until it is applied. Applying a version that disables, removes or downgrades a binding revokes it immediately in running sessions on older versions. A resource that is not bound returns 404, a service that is not opened returns 403, and a write to a resource bound read_only returns 403 BINDING_READ_ONLY. Unknown types, fields on the wrong kind (id, access or instructions on a service binding), wrong access and malformed ids return 400. The former databases, vector_stores and files fields are removed and return 400. Omit on create for no bindings. Saving checks added or changed database, vector_store, media_library and file bindings in the organization: unknown or deleted ids return 400. If an owner is unavailable or takes more than 3 seconds, saving succeeds with verified=false for the affected bindings. Unchanged bindings keep their previous verification result and are not rechecked. workflow and script ids are not verified at save time.
|
|
49212
50195
|
*/
|
|
49213
50196
|
bindings: Array<{
|
|
49214
50197
|
/**
|
|
@@ -49227,6 +50210,10 @@ export type AgentsVersionsListResponses = {
|
|
|
49227
50210
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
49228
50211
|
*/
|
|
49229
50212
|
instructions?: string;
|
|
50213
|
+
/**
|
|
50214
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
50215
|
+
*/
|
|
50216
|
+
readonly verified?: boolean;
|
|
49230
50217
|
/**
|
|
49231
50218
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
49232
50219
|
*/
|
|
@@ -49236,6 +50223,10 @@ export type AgentsVersionsListResponses = {
|
|
|
49236
50223
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
49237
50224
|
*/
|
|
49238
50225
|
type: 'search' | 'browser';
|
|
50226
|
+
/**
|
|
50227
|
+
* Save-time verification result. false means the resource owner was unavailable; saving still succeeded. Unchanged bindings retain their previous result. true is returned for other bindings, including workflow and script ids which are not verified at save time. Client values are ignored.
|
|
50228
|
+
*/
|
|
50229
|
+
readonly verified?: boolean;
|
|
49239
50230
|
/**
|
|
49240
50231
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
49241
50232
|
*/
|
|
@@ -49253,6 +50244,10 @@ export type AgentsVersionsListResponses = {
|
|
|
49253
50244
|
* Praxis extension: default subagent model ID, pinned in the agent revision. Call model overrides this; otherwise it overrides the roster member model or the parent model for built-ins. Null clears the default. /agent/v1 only.
|
|
49254
50245
|
*/
|
|
49255
50246
|
subagent_model?: string | null;
|
|
50247
|
+
/**
|
|
50248
|
+
* Model used by the imagine image tool; defaults to gpt-image-2 when unset. Only models that can generate images are accepted. Omit to preserve; null clears the configured model. /agent/v1 only.
|
|
50249
|
+
*/
|
|
50250
|
+
image_model?: string | null;
|
|
49256
50251
|
/**
|
|
49257
50252
|
* Praxis extension: inline subagent definitions stored in the configuration revision, separately from the multiagent roster. Omit to preserve; null clears. Names must be unique. Configuration storage only; runtime activation is not implemented. /agent/v1 only.
|
|
49258
50253
|
*/
|