@deepraxis/sdk 0.1.1-dev.69cffcf → 0.1.1-dev.76902b6
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 +65 -1
- package/dist/generated/sdk.gen.js +160 -0
- package/dist/generated/types.gen.d.ts +931 -56
- package/dist/operations.generated.d.ts +176 -1
- package/dist/operations.generated.js +217 -1
- package/dist/resources.generated.d.ts +164 -0
- package/dist/resources.generated.js +14 -0
- package/package.json +1 -1
|
@@ -28050,7 +28050,7 @@ export type ApplyAgentVersionResponses = {
|
|
|
28050
28050
|
*/
|
|
28051
28051
|
note: string | null;
|
|
28052
28052
|
/**
|
|
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.
|
|
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.
|
|
28054
28054
|
*/
|
|
28055
28055
|
bindings: Array<{
|
|
28056
28056
|
/**
|
|
@@ -28069,6 +28069,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
28069
28069
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
28070
28070
|
*/
|
|
28071
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;
|
|
28072
28076
|
/**
|
|
28073
28077
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
28074
28078
|
*/
|
|
@@ -28078,6 +28082,10 @@ export type ApplyAgentVersionResponses = {
|
|
|
28078
28082
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
28079
28083
|
*/
|
|
28080
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;
|
|
28081
28089
|
/**
|
|
28082
28090
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
28083
28091
|
*/
|
|
@@ -29227,7 +29235,7 @@ export type UnarchiveAgentResponses = {
|
|
|
29227
29235
|
*/
|
|
29228
29236
|
note: string | null;
|
|
29229
29237
|
/**
|
|
29230
|
-
* 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.
|
|
29231
29239
|
*/
|
|
29232
29240
|
bindings: Array<{
|
|
29233
29241
|
/**
|
|
@@ -29246,6 +29254,10 @@ export type UnarchiveAgentResponses = {
|
|
|
29246
29254
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
29247
29255
|
*/
|
|
29248
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;
|
|
29249
29261
|
/**
|
|
29250
29262
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
29251
29263
|
*/
|
|
@@ -29255,6 +29267,10 @@ export type UnarchiveAgentResponses = {
|
|
|
29255
29267
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
29256
29268
|
*/
|
|
29257
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;
|
|
29258
29274
|
/**
|
|
29259
29275
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
29260
29276
|
*/
|
|
@@ -30237,34 +30253,668 @@ export type BlockEndUserResponses = {
|
|
|
30237
30253
|
currency: 'USD';
|
|
30238
30254
|
};
|
|
30239
30255
|
/**
|
|
30240
|
-
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30256
|
+
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30257
|
+
*/
|
|
30258
|
+
blocked: boolean;
|
|
30259
|
+
};
|
|
30260
|
+
};
|
|
30261
|
+
export type BlockEndUserResponse = BlockEndUserResponses[keyof BlockEndUserResponses];
|
|
30262
|
+
export type UnblockEndUserData = {
|
|
30263
|
+
body?: never;
|
|
30264
|
+
path: {
|
|
30265
|
+
/**
|
|
30266
|
+
* Active service agent identifier from agent creation or listing.
|
|
30267
|
+
*/
|
|
30268
|
+
agent_id: string;
|
|
30269
|
+
/**
|
|
30270
|
+
* Host user identifier supplied at issuance or from end-user listing.
|
|
30271
|
+
*/
|
|
30272
|
+
external_user_id: string;
|
|
30273
|
+
};
|
|
30274
|
+
query?: never;
|
|
30275
|
+
url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock';
|
|
30276
|
+
};
|
|
30277
|
+
export type UnblockEndUserErrors = {
|
|
30278
|
+
/**
|
|
30279
|
+
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30280
|
+
*/
|
|
30281
|
+
400: unknown;
|
|
30282
|
+
/**
|
|
30283
|
+
* Authenticate with a host credential.
|
|
30284
|
+
*/
|
|
30285
|
+
401: unknown;
|
|
30286
|
+
/**
|
|
30287
|
+
* 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.
|
|
30288
|
+
*/
|
|
30289
|
+
403: AgentError;
|
|
30290
|
+
/**
|
|
30291
|
+
* Agent or requested user is unavailable to this caller, or the caller is an end user.
|
|
30292
|
+
*/
|
|
30293
|
+
404: unknown;
|
|
30294
|
+
/**
|
|
30295
|
+
* Configure an embed policy before blocking or unblocking; retry if a concurrent policy update caused the conflict.
|
|
30296
|
+
*/
|
|
30297
|
+
409: unknown;
|
|
30298
|
+
};
|
|
30299
|
+
export type UnblockEndUserError = UnblockEndUserErrors[keyof UnblockEndUserErrors];
|
|
30300
|
+
export type UnblockEndUserResponses = {
|
|
30301
|
+
/**
|
|
30302
|
+
* Current end-user view.
|
|
30303
|
+
*/
|
|
30304
|
+
200: {
|
|
30305
|
+
/**
|
|
30306
|
+
* Host application's user identifier, scoped to this organization and agent.
|
|
30307
|
+
*/
|
|
30308
|
+
external_user_id: string;
|
|
30309
|
+
/**
|
|
30310
|
+
* Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
|
|
30311
|
+
*/
|
|
30312
|
+
first_seen_at: string | null;
|
|
30313
|
+
/**
|
|
30314
|
+
* Latest session update or token issuance time; null when there is no history.
|
|
30315
|
+
*/
|
|
30316
|
+
last_active_at: string | null;
|
|
30317
|
+
/**
|
|
30318
|
+
* Total sessions for this end user on this agent.
|
|
30319
|
+
*/
|
|
30320
|
+
session_count: number;
|
|
30321
|
+
/**
|
|
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.
|
|
30323
|
+
*/
|
|
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
|
+
};
|
|
30334
|
+
/**
|
|
30335
|
+
* Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
|
|
30336
|
+
*/
|
|
30337
|
+
blocked: boolean;
|
|
30338
|
+
};
|
|
30339
|
+
};
|
|
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.
|
|
30241
30899
|
*/
|
|
30242
|
-
|
|
30900
|
+
revoked: number;
|
|
30243
30901
|
};
|
|
30244
30902
|
};
|
|
30245
|
-
export type
|
|
30246
|
-
export type
|
|
30903
|
+
export type RevokeCustomerTokensResponse = RevokeCustomerTokensResponses[keyof RevokeCustomerTokensResponses];
|
|
30904
|
+
export type GetAgentAppearanceData = {
|
|
30247
30905
|
body?: never;
|
|
30248
30906
|
path: {
|
|
30249
30907
|
/**
|
|
30250
|
-
*
|
|
30908
|
+
* Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
|
|
30251
30909
|
*/
|
|
30252
30910
|
agent_id: string;
|
|
30253
|
-
/**
|
|
30254
|
-
* Host user identifier supplied at issuance or from end-user listing.
|
|
30255
|
-
*/
|
|
30256
|
-
external_user_id: string;
|
|
30257
30911
|
};
|
|
30258
30912
|
query?: never;
|
|
30259
|
-
url: '/agent/v1/agents/{agent_id}/
|
|
30913
|
+
url: '/agent/v1/agents/{agent_id}/appearance';
|
|
30260
30914
|
};
|
|
30261
|
-
export type
|
|
30262
|
-
/**
|
|
30263
|
-
* Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
|
|
30264
|
-
*/
|
|
30265
|
-
400: unknown;
|
|
30915
|
+
export type GetAgentAppearanceErrors = {
|
|
30266
30916
|
/**
|
|
30267
|
-
* Authenticate with a
|
|
30917
|
+
* Authenticate with a customer access token of this agent, your API key or a console session.
|
|
30268
30918
|
*/
|
|
30269
30919
|
401: unknown;
|
|
30270
30920
|
/**
|
|
@@ -30272,56 +30922,217 @@ export type UnblockEndUserErrors = {
|
|
|
30272
30922
|
*/
|
|
30273
30923
|
403: AgentError;
|
|
30274
30924
|
/**
|
|
30275
|
-
*
|
|
30925
|
+
* AGENT_NOT_FOUND: the agent is absent, archived or not a service agent, or the customer access token belongs to another agent.
|
|
30276
30926
|
*/
|
|
30277
30927
|
404: unknown;
|
|
30278
30928
|
/**
|
|
30279
|
-
*
|
|
30929
|
+
* Appearance is temporarily unavailable; use the default appearance and continue the conversation.
|
|
30280
30930
|
*/
|
|
30281
|
-
|
|
30931
|
+
503: unknown;
|
|
30282
30932
|
};
|
|
30283
|
-
export type
|
|
30284
|
-
export type
|
|
30933
|
+
export type GetAgentAppearanceError = GetAgentAppearanceErrors[keyof GetAgentAppearanceErrors];
|
|
30934
|
+
export type GetAgentAppearanceResponses = {
|
|
30285
30935
|
/**
|
|
30286
|
-
*
|
|
30936
|
+
* Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
|
|
30287
30937
|
*/
|
|
30288
30938
|
200: {
|
|
30289
30939
|
/**
|
|
30290
|
-
*
|
|
30940
|
+
* Public identity displayed on the chat page, independent of the internal agent name.
|
|
30291
30941
|
*/
|
|
30292
|
-
|
|
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
|
+
};
|
|
30293
30952
|
/**
|
|
30294
|
-
*
|
|
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.
|
|
30295
30954
|
*/
|
|
30296
|
-
|
|
30955
|
+
layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
|
|
30297
30956
|
/**
|
|
30298
|
-
*
|
|
30957
|
+
* Default entry button for the loader; an explicit script data-launcher takes precedence.
|
|
30299
30958
|
*/
|
|
30300
|
-
|
|
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
|
+
};
|
|
30301
31027
|
/**
|
|
30302
|
-
*
|
|
31028
|
+
* Visible chat heading; omitted title uses the public agent name.
|
|
30303
31029
|
*/
|
|
30304
|
-
|
|
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
|
+
};
|
|
30305
31044
|
/**
|
|
30306
|
-
*
|
|
31045
|
+
* Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
|
|
30307
31046
|
*/
|
|
30308
|
-
|
|
31047
|
+
theme?: {
|
|
30309
31048
|
/**
|
|
30310
|
-
*
|
|
31049
|
+
* light or dark selects a fixed scheme; system follows the device preference.
|
|
30311
31050
|
*/
|
|
30312
|
-
|
|
31051
|
+
colorScheme?: 'light' | 'dark' | 'system';
|
|
30313
31052
|
/**
|
|
30314
|
-
*
|
|
31053
|
+
* Explicit opaque CSS accent color, for example #167A43.
|
|
30315
31054
|
*/
|
|
30316
|
-
|
|
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;
|
|
30317
31080
|
};
|
|
30318
31081
|
/**
|
|
30319
|
-
*
|
|
31082
|
+
* Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
|
|
30320
31083
|
*/
|
|
30321
|
-
|
|
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
|
+
};
|
|
30322
31133
|
};
|
|
30323
31134
|
};
|
|
30324
|
-
export type
|
|
31135
|
+
export type GetAgentAppearanceResponse = GetAgentAppearanceResponses[keyof GetAgentAppearanceResponses];
|
|
30325
31136
|
export type CreateCustomerGrantCodeData = {
|
|
30326
31137
|
body: {
|
|
30327
31138
|
/**
|
|
@@ -43401,7 +44212,7 @@ export type ListOrganizationCostsResponses = {
|
|
|
43401
44212
|
*/
|
|
43402
44213
|
ResourceName?: string;
|
|
43403
44214
|
/**
|
|
43404
|
-
*
|
|
44215
|
+
* Amount in BillingCurrency: US dollars for USD, decimal string, 6 decimals.
|
|
43405
44216
|
*/
|
|
43406
44217
|
BilledCost: string;
|
|
43407
44218
|
/**
|
|
@@ -43619,7 +44430,7 @@ export type ListOrganizationEventsResponses = {
|
|
|
43619
44430
|
*/
|
|
43620
44431
|
ResourceName: string;
|
|
43621
44432
|
/**
|
|
43622
|
-
* 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.
|
|
43623
44434
|
*/
|
|
43624
44435
|
BilledCost: string;
|
|
43625
44436
|
/**
|
|
@@ -43643,7 +44454,7 @@ export type ListOrganizationEventsResponses = {
|
|
|
43643
44454
|
*/
|
|
43644
44455
|
status: 'settled' | 'no_charge' | 'rejected';
|
|
43645
44456
|
/**
|
|
43646
|
-
*
|
|
44457
|
+
* Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
|
|
43647
44458
|
*/
|
|
43648
44459
|
shortfall: string | null;
|
|
43649
44460
|
/**
|
|
@@ -43740,7 +44551,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43740
44551
|
*/
|
|
43741
44552
|
ResourceName: string;
|
|
43742
44553
|
/**
|
|
43743
|
-
* 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.
|
|
43744
44555
|
*/
|
|
43745
44556
|
BilledCost: string;
|
|
43746
44557
|
/**
|
|
@@ -43764,7 +44575,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43764
44575
|
*/
|
|
43765
44576
|
status: 'settled' | 'no_charge' | 'rejected';
|
|
43766
44577
|
/**
|
|
43767
|
-
*
|
|
44578
|
+
* Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
|
|
43768
44579
|
*/
|
|
43769
44580
|
shortfall: string | null;
|
|
43770
44581
|
/**
|
|
@@ -43801,7 +44612,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43801
44612
|
*/
|
|
43802
44613
|
PricingUnit: string | null;
|
|
43803
44614
|
/**
|
|
43804
|
-
* 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`).
|
|
43805
44616
|
*/
|
|
43806
44617
|
BilledCost: string;
|
|
43807
44618
|
}>;
|
|
@@ -43814,7 +44625,7 @@ export type GetOrganizationEventResponses = {
|
|
|
43814
44625
|
*/
|
|
43815
44626
|
transaction_id: string;
|
|
43816
44627
|
/**
|
|
43817
|
-
* 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.
|
|
43818
44629
|
*/
|
|
43819
44630
|
BilledCost: string;
|
|
43820
44631
|
/**
|
|
@@ -43868,7 +44679,7 @@ export type ExportOrganizationChargesResponses = {
|
|
|
43868
44679
|
*/
|
|
43869
44680
|
ChargePeriodEnd: string;
|
|
43870
44681
|
/**
|
|
43871
|
-
* 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.
|
|
43872
44683
|
*/
|
|
43873
44684
|
BilledCost: string;
|
|
43874
44685
|
/**
|
|
@@ -45403,7 +46214,7 @@ export type AgentsListResponses = {
|
|
|
45403
46214
|
*/
|
|
45404
46215
|
note: string | null;
|
|
45405
46216
|
/**
|
|
45406
|
-
* 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.
|
|
45407
46218
|
*/
|
|
45408
46219
|
bindings: Array<{
|
|
45409
46220
|
/**
|
|
@@ -45422,6 +46233,10 @@ export type AgentsListResponses = {
|
|
|
45422
46233
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
45423
46234
|
*/
|
|
45424
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;
|
|
45425
46240
|
/**
|
|
45426
46241
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45427
46242
|
*/
|
|
@@ -45431,6 +46246,10 @@ export type AgentsListResponses = {
|
|
|
45431
46246
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45432
46247
|
*/
|
|
45433
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;
|
|
45434
46253
|
/**
|
|
45435
46254
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45436
46255
|
*/
|
|
@@ -45907,7 +46726,7 @@ export type AgentsCreateData = {
|
|
|
45907
46726
|
*/
|
|
45908
46727
|
tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
|
|
45909
46728
|
/**
|
|
45910
|
-
* 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.
|
|
45911
46730
|
*/
|
|
45912
46731
|
bindings?: Array<{
|
|
45913
46732
|
/**
|
|
@@ -45926,6 +46745,10 @@ export type AgentsCreateData = {
|
|
|
45926
46745
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
45927
46746
|
*/
|
|
45928
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;
|
|
45929
46752
|
/**
|
|
45930
46753
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
45931
46754
|
*/
|
|
@@ -45935,6 +46758,10 @@ export type AgentsCreateData = {
|
|
|
45935
46758
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
45936
46759
|
*/
|
|
45937
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;
|
|
45938
46765
|
/**
|
|
45939
46766
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
45940
46767
|
*/
|
|
@@ -46472,7 +47299,7 @@ export type AgentsCreateResponses = {
|
|
|
46472
47299
|
*/
|
|
46473
47300
|
note: string | null;
|
|
46474
47301
|
/**
|
|
46475
|
-
* 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.
|
|
46476
47303
|
*/
|
|
46477
47304
|
bindings: Array<{
|
|
46478
47305
|
/**
|
|
@@ -46491,6 +47318,10 @@ export type AgentsCreateResponses = {
|
|
|
46491
47318
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
46492
47319
|
*/
|
|
46493
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;
|
|
46494
47325
|
/**
|
|
46495
47326
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
46496
47327
|
*/
|
|
@@ -46500,6 +47331,10 @@ export type AgentsCreateResponses = {
|
|
|
46500
47331
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
46501
47332
|
*/
|
|
46502
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;
|
|
46503
47338
|
/**
|
|
46504
47339
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
46505
47340
|
*/
|
|
@@ -47060,7 +47895,7 @@ export type AgentsRetrieveResponses = {
|
|
|
47060
47895
|
*/
|
|
47061
47896
|
note: string | null;
|
|
47062
47897
|
/**
|
|
47063
|
-
* 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.
|
|
47064
47899
|
*/
|
|
47065
47900
|
bindings: Array<{
|
|
47066
47901
|
/**
|
|
@@ -47079,6 +47914,10 @@ export type AgentsRetrieveResponses = {
|
|
|
47079
47914
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
47080
47915
|
*/
|
|
47081
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;
|
|
47082
47921
|
/**
|
|
47083
47922
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
47084
47923
|
*/
|
|
@@ -47088,6 +47927,10 @@ export type AgentsRetrieveResponses = {
|
|
|
47088
47927
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
47089
47928
|
*/
|
|
47090
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;
|
|
47091
47934
|
/**
|
|
47092
47935
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
47093
47936
|
*/
|
|
@@ -47595,6 +48438,10 @@ export type AgentsUpdateData = {
|
|
|
47595
48438
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
47596
48439
|
*/
|
|
47597
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;
|
|
47598
48445
|
/**
|
|
47599
48446
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
47600
48447
|
*/
|
|
@@ -47604,6 +48451,10 @@ export type AgentsUpdateData = {
|
|
|
47604
48451
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
47605
48452
|
*/
|
|
47606
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;
|
|
47607
48458
|
/**
|
|
47608
48459
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
47609
48460
|
*/
|
|
@@ -48150,7 +49001,7 @@ export type AgentsUpdateResponses = {
|
|
|
48150
49001
|
*/
|
|
48151
49002
|
note: string | null;
|
|
48152
49003
|
/**
|
|
48153
|
-
* 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.
|
|
48154
49005
|
*/
|
|
48155
49006
|
bindings: Array<{
|
|
48156
49007
|
/**
|
|
@@ -48169,6 +49020,10 @@ export type AgentsUpdateResponses = {
|
|
|
48169
49020
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
48170
49021
|
*/
|
|
48171
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;
|
|
48172
49027
|
/**
|
|
48173
49028
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
48174
49029
|
*/
|
|
@@ -48178,6 +49033,10 @@ export type AgentsUpdateResponses = {
|
|
|
48178
49033
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
48179
49034
|
*/
|
|
48180
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;
|
|
48181
49040
|
/**
|
|
48182
49041
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
48183
49042
|
*/
|
|
@@ -48728,7 +49587,7 @@ export type AgentsArchiveResponses = {
|
|
|
48728
49587
|
*/
|
|
48729
49588
|
note: string | null;
|
|
48730
49589
|
/**
|
|
48731
|
-
* 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.
|
|
48732
49591
|
*/
|
|
48733
49592
|
bindings: Array<{
|
|
48734
49593
|
/**
|
|
@@ -48747,6 +49606,10 @@ export type AgentsArchiveResponses = {
|
|
|
48747
49606
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
48748
49607
|
*/
|
|
48749
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;
|
|
48750
49613
|
/**
|
|
48751
49614
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
48752
49615
|
*/
|
|
@@ -48756,6 +49619,10 @@ export type AgentsArchiveResponses = {
|
|
|
48756
49619
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
48757
49620
|
*/
|
|
48758
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;
|
|
48759
49626
|
/**
|
|
48760
49627
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
48761
49628
|
*/
|
|
@@ -49324,7 +50191,7 @@ export type AgentsVersionsListResponses = {
|
|
|
49324
50191
|
*/
|
|
49325
50192
|
note: string | null;
|
|
49326
50193
|
/**
|
|
49327
|
-
* 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.
|
|
49328
50195
|
*/
|
|
49329
50196
|
bindings: Array<{
|
|
49330
50197
|
/**
|
|
@@ -49343,6 +50210,10 @@ export type AgentsVersionsListResponses = {
|
|
|
49343
50210
|
* Optional guidance for using this resource, up to 4096 characters; does not expand access.
|
|
49344
50211
|
*/
|
|
49345
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;
|
|
49346
50217
|
/**
|
|
49347
50218
|
* Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
|
|
49348
50219
|
*/
|
|
@@ -49352,6 +50223,10 @@ export type AgentsVersionsListResponses = {
|
|
|
49352
50223
|
* Service type. Opens the whole service to codemode; there is no per-resource id.
|
|
49353
50224
|
*/
|
|
49354
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;
|
|
49355
50230
|
/**
|
|
49356
50231
|
* Whether the service is open. Defaults to true; false immediately closes it for running sessions.
|
|
49357
50232
|
*/
|