@deepraxis/sdk 0.1.1-dev.13dab28 → 0.1.1-dev.1538445

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.
@@ -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
  */
@@ -29771,37 +29787,45 @@ export type SetRunFeedbackResponses = {
29771
29787
  };
29772
29788
  };
29773
29789
  export type SetRunFeedbackResponse = SetRunFeedbackResponses[keyof SetRunFeedbackResponses];
29774
- export type ListEndUsersData = {
29790
+ export type ListCustomersData = {
29775
29791
  body?: never;
29776
29792
  path: {
29777
29793
  /**
29778
- * Active service agent identifier from agent creation or listing.
29794
+ * Active service agent id from agent creation or listing.
29779
29795
  */
29780
29796
  agent_id: string;
29781
29797
  };
29782
29798
  query?: {
29783
29799
  /**
29784
- * Maximum users per page; defaults to 20.
29800
+ * Maximum customers per page, 1 to 100; defaults to 20.
29785
29801
  */
29786
29802
  limit?: number;
29787
29803
  /**
29788
- * next_page from the previous response with the same agent, q and limit.
29804
+ * next_page from the previous response with the same q, type, blocked and limit.
29789
29805
  */
29790
29806
  page?: string;
29791
29807
  /**
29792
- * Case-sensitive literal prefix of external_user_id; omit or use an empty string for all users.
29808
+ * Case-sensitive literal prefix of the customer id; omit for all customers.
29793
29809
  */
29794
29810
  q?: string;
29811
+ /**
29812
+ * Only identified or only anonymous customers; omit for both.
29813
+ */
29814
+ type?: 'identified' | 'anonymous';
29815
+ /**
29816
+ * true for blocked customers only, false for customers who are not blocked; omit for both.
29817
+ */
29818
+ blocked?: boolean;
29795
29819
  };
29796
- url: '/agent/v1/agents/{agent_id}/end_users';
29820
+ url: '/agent/v1/agents/{agent_id}/customers';
29797
29821
  };
29798
- export type ListEndUsersErrors = {
29822
+ export type ListCustomersErrors = {
29799
29823
  /**
29800
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
29824
+ * 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.
29801
29825
  */
29802
29826
  400: unknown;
29803
29827
  /**
29804
- * Authenticate with a host credential.
29828
+ * Authenticate with your API key or a console session.
29805
29829
  */
29806
29830
  401: unknown;
29807
29831
  /**
@@ -29809,14 +29833,14 @@ export type ListEndUsersErrors = {
29809
29833
  */
29810
29834
  403: AgentError;
29811
29835
  /**
29812
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
29836
+ * The agent is not an active service agent of your organization, or the caller is a customer access token.
29813
29837
  */
29814
29838
  404: unknown;
29815
29839
  };
29816
- export type ListEndUsersError = ListEndUsersErrors[keyof ListEndUsersErrors];
29817
- export type ListEndUsersResponses = {
29840
+ export type ListCustomersError = ListCustomersErrors[keyof ListCustomersErrors];
29841
+ export type ListCustomersResponses = {
29818
29842
  /**
29819
- * Matching users and next page cursor.
29843
+ * Matching customers and the next page cursor.
29820
29844
  */
29821
29845
  200: {
29822
29846
  /**
@@ -29824,23 +29848,35 @@ export type ListEndUsersResponses = {
29824
29848
  */
29825
29849
  data: Array<{
29826
29850
  /**
29827
- * Host application's user identifier, scoped to this organization and agent.
29851
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
29852
+ */
29853
+ id: string;
29854
+ /**
29855
+ * 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.
29856
+ */
29857
+ type: 'identified' | 'anonymous';
29858
+ /**
29859
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
29860
+ */
29861
+ merged_into: string | null;
29862
+ /**
29863
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
29828
29864
  */
29829
- external_user_id: string;
29865
+ blocked: boolean;
29830
29866
  /**
29831
- * Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
29867
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
29832
29868
  */
29833
29869
  first_seen_at: string | null;
29834
29870
  /**
29835
- * Latest session update or token issuance time; null when there is no history.
29871
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
29836
29872
  */
29837
- last_active_at: string | null;
29873
+ last_seen_at: string | null;
29838
29874
  /**
29839
- * Total sessions for this end user on this agent.
29875
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
29840
29876
  */
29841
29877
  session_count: number;
29842
29878
  /**
29843
- * 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.
29879
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
29844
29880
  */
29845
29881
  cost: {
29846
29882
  /**
@@ -29852,45 +29888,41 @@ export type ListEndUsersResponses = {
29852
29888
  */
29853
29889
  currency: 'USD';
29854
29890
  };
29855
- /**
29856
- * Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
29857
- */
29858
- blocked: boolean;
29859
29891
  }>;
29860
29892
  /**
29861
- * Cursor for the same agent, q and limit; null when exhausted.
29893
+ * Cursor for the next page with the same agent, q, type, blocked and limit; null when exhausted.
29862
29894
  */
29863
29895
  next_page: string | null;
29864
29896
  };
29865
29897
  };
29866
- export type ListEndUsersResponse = ListEndUsersResponses[keyof ListEndUsersResponses];
29867
- export type DeleteEndUserData = {
29898
+ export type ListCustomersResponse = ListCustomersResponses[keyof ListCustomersResponses];
29899
+ export type DeleteCustomerData = {
29868
29900
  body?: never;
29869
29901
  path: {
29870
29902
  /**
29871
- * Active service agent identifier from agent creation or listing.
29903
+ * Active service agent id from agent creation or listing.
29872
29904
  */
29873
29905
  agent_id: string;
29874
29906
  /**
29875
- * Host user identifier supplied at issuance or from end-user listing.
29907
+ * Customer id from customer listing, or your own customer_id.
29876
29908
  */
29877
- external_user_id: string;
29909
+ customer_id: string;
29878
29910
  };
29879
29911
  query: {
29880
29912
  /**
29881
- * Must exactly equal the external_user_id path parameter to confirm destructive deletion.
29913
+ * Must equal the customer_id path parameter exactly, confirming the destructive deletion.
29882
29914
  */
29883
29915
  confirm: string;
29884
29916
  };
29885
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}';
29917
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
29886
29918
  };
29887
- export type DeleteEndUserErrors = {
29919
+ export type DeleteCustomerErrors = {
29888
29920
  /**
29889
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
29921
+ * INVALID_PARAMS: confirm is missing or differs from customer_id; send ?confirm=<customer_id>.
29890
29922
  */
29891
29923
  400: unknown;
29892
29924
  /**
29893
- * Authenticate with a host credential.
29925
+ * Authenticate with your API key or a console session.
29894
29926
  */
29895
29927
  401: unknown;
29896
29928
  /**
@@ -29898,12 +29930,12 @@ export type DeleteEndUserErrors = {
29898
29930
  */
29899
29931
  403: AgentError;
29900
29932
  /**
29901
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
29933
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
29902
29934
  */
29903
29935
  404: unknown;
29904
29936
  };
29905
- export type DeleteEndUserError = DeleteEndUserErrors[keyof DeleteEndUserErrors];
29906
- export type DeleteEndUserResponses = {
29937
+ export type DeleteCustomerError = DeleteCustomerErrors[keyof DeleteCustomerErrors];
29938
+ export type DeleteCustomerResponses = {
29907
29939
  /**
29908
29940
  * Deletion accepted; poll the deletion endpoint until done or failed.
29909
29941
  */
@@ -29918,29 +29950,25 @@ export type DeleteEndUserResponses = {
29918
29950
  status: 'pending';
29919
29951
  };
29920
29952
  };
29921
- export type DeleteEndUserResponse = DeleteEndUserResponses[keyof DeleteEndUserResponses];
29922
- export type GetEndUserData = {
29953
+ export type DeleteCustomerResponse = DeleteCustomerResponses[keyof DeleteCustomerResponses];
29954
+ export type GetCustomerData = {
29923
29955
  body?: never;
29924
29956
  path: {
29925
29957
  /**
29926
- * Active service agent identifier from agent creation or listing.
29958
+ * Active service agent id from agent creation or listing.
29927
29959
  */
29928
29960
  agent_id: string;
29929
29961
  /**
29930
- * Host user identifier supplied at issuance or from end-user listing.
29962
+ * Customer id from customer listing, or your own customer_id.
29931
29963
  */
29932
- external_user_id: string;
29964
+ customer_id: string;
29933
29965
  };
29934
29966
  query?: never;
29935
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}';
29967
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
29936
29968
  };
29937
- export type GetEndUserErrors = {
29938
- /**
29939
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
29940
- */
29941
- 400: unknown;
29969
+ export type GetCustomerErrors = {
29942
29970
  /**
29943
- * Authenticate with a host credential.
29971
+ * Authenticate with your API key or a console session.
29944
29972
  */
29945
29973
  401: unknown;
29946
29974
  /**
@@ -29948,34 +29976,46 @@ export type GetEndUserErrors = {
29948
29976
  */
29949
29977
  403: AgentError;
29950
29978
  /**
29951
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
29979
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
29952
29980
  */
29953
29981
  404: unknown;
29954
29982
  };
29955
- export type GetEndUserError = GetEndUserErrors[keyof GetEndUserErrors];
29956
- export type GetEndUserResponses = {
29983
+ export type GetCustomerError = GetCustomerErrors[keyof GetCustomerErrors];
29984
+ export type GetCustomerResponses = {
29957
29985
  /**
29958
- * Current end-user view.
29986
+ * The customer with its recent sessions.
29959
29987
  */
29960
29988
  200: {
29961
29989
  /**
29962
- * Host application's user identifier, scoped to this organization and agent.
29990
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
29991
+ */
29992
+ id: string;
29993
+ /**
29994
+ * 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.
29995
+ */
29996
+ type: 'identified' | 'anonymous';
29997
+ /**
29998
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
29999
+ */
30000
+ merged_into: string | null;
30001
+ /**
30002
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
29963
30003
  */
29964
- external_user_id: string;
30004
+ blocked: boolean;
29965
30005
  /**
29966
- * Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
30006
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
29967
30007
  */
29968
30008
  first_seen_at: string | null;
29969
30009
  /**
29970
- * Latest session update or token issuance time; null when there is no history.
30010
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
29971
30011
  */
29972
- last_active_at: string | null;
30012
+ last_seen_at: string | null;
29973
30013
  /**
29974
- * Total sessions for this end user on this agent.
30014
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
29975
30015
  */
29976
30016
  session_count: number;
29977
30017
  /**
29978
- * 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.
30018
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
29979
30019
  */
29980
30020
  cost: {
29981
30021
  /**
@@ -29988,11 +30028,7 @@ export type GetEndUserResponses = {
29988
30028
  currency: 'USD';
29989
30029
  };
29990
30030
  /**
29991
- * Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
29992
- */
29993
- blocked: boolean;
29994
- /**
29995
- * Up to twenty sessions, ordered by most recent update first.
30031
+ * Up to twenty sessions of the customer, and of anonymous customers merged into it, most recently updated first.
29996
30032
  */
29997
30033
  recent_sessions: Array<{
29998
30034
  /**
@@ -30018,29 +30054,25 @@ export type GetEndUserResponses = {
30018
30054
  }>;
30019
30055
  };
30020
30056
  };
30021
- export type GetEndUserResponse = GetEndUserResponses[keyof GetEndUserResponses];
30022
- export type GetEndUserDeletionData = {
30057
+ export type GetCustomerResponse = GetCustomerResponses[keyof GetCustomerResponses];
30058
+ export type GetCustomerDeletionData = {
30023
30059
  body?: never;
30024
30060
  path: {
30025
30061
  /**
30026
- * Active service agent identifier from agent creation or listing.
30062
+ * Active service agent id from agent creation or listing.
30027
30063
  */
30028
30064
  agent_id: string;
30029
30065
  /**
30030
- * Host user identifier supplied at issuance or from end-user listing.
30066
+ * Customer id from customer listing, or your own customer_id.
30031
30067
  */
30032
- external_user_id: string;
30068
+ customer_id: string;
30033
30069
  };
30034
30070
  query?: never;
30035
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/deletion';
30071
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion';
30036
30072
  };
30037
- export type GetEndUserDeletionErrors = {
30038
- /**
30039
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
30040
- */
30041
- 400: unknown;
30073
+ export type GetCustomerDeletionErrors = {
30042
30074
  /**
30043
- * Authenticate with a host credential.
30075
+ * Authenticate with your API key or a console session.
30044
30076
  */
30045
30077
  401: unknown;
30046
30078
  /**
@@ -30048,14 +30080,14 @@ export type GetEndUserDeletionErrors = {
30048
30080
  */
30049
30081
  403: AgentError;
30050
30082
  /**
30051
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
30083
+ * CUSTOMER_NOT_FOUND or no deletion task: the customer or task is unknown, or the caller is a customer access token.
30052
30084
  */
30053
30085
  404: unknown;
30054
30086
  };
30055
- export type GetEndUserDeletionError = GetEndUserDeletionErrors[keyof GetEndUserDeletionErrors];
30056
- export type GetEndUserDeletionResponses = {
30087
+ export type GetCustomerDeletionError = GetCustomerDeletionErrors[keyof GetCustomerDeletionErrors];
30088
+ export type GetCustomerDeletionResponses = {
30057
30089
  /**
30058
- * Latest deletion task and snapshot counts.
30090
+ * The latest deletion task and its snapshot counts.
30059
30091
  */
30060
30092
  200: {
30061
30093
  /**
@@ -30109,29 +30141,25 @@ export type GetEndUserDeletionResponses = {
30109
30141
  updated_at: string;
30110
30142
  };
30111
30143
  };
30112
- export type GetEndUserDeletionResponse = GetEndUserDeletionResponses[keyof GetEndUserDeletionResponses];
30113
- export type RevokeEndUserTokensData = {
30144
+ export type GetCustomerDeletionResponse = GetCustomerDeletionResponses[keyof GetCustomerDeletionResponses];
30145
+ export type BlockCustomerData = {
30114
30146
  body?: never;
30115
30147
  path: {
30116
30148
  /**
30117
- * Active service agent identifier from agent creation or listing.
30149
+ * Active service agent id from agent creation or listing.
30118
30150
  */
30119
30151
  agent_id: string;
30120
30152
  /**
30121
- * Host user identifier supplied at issuance or from end-user listing.
30153
+ * Customer id from customer listing, or your own customer_id.
30122
30154
  */
30123
- external_user_id: string;
30155
+ customer_id: string;
30124
30156
  };
30125
30157
  query?: never;
30126
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/revoke_tokens';
30158
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/block';
30127
30159
  };
30128
- export type RevokeEndUserTokensErrors = {
30129
- /**
30130
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
30131
- */
30132
- 400: unknown;
30160
+ export type BlockCustomerErrors = {
30133
30161
  /**
30134
- * Authenticate with a host credential.
30162
+ * Authenticate with your API key or a console session.
30135
30163
  */
30136
30164
  401: unknown;
30137
30165
  /**
@@ -30139,92 +30167,50 @@ export type RevokeEndUserTokensErrors = {
30139
30167
  */
30140
30168
  403: AgentError;
30141
30169
  /**
30142
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
30170
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30143
30171
  */
30144
30172
  404: unknown;
30145
30173
  /**
30146
- * Credential revocation failed; grant timestamps remain unchanged. A requested block remains in effect; retry to finish revocation.
30174
+ * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30147
30175
  */
30148
30176
  502: unknown;
30149
30177
  };
30150
- export type RevokeEndUserTokensError = RevokeEndUserTokensErrors[keyof RevokeEndUserTokensErrors];
30151
- export type RevokeEndUserTokensResponses = {
30178
+ export type BlockCustomerError = BlockCustomerErrors[keyof BlockCustomerErrors];
30179
+ export type BlockCustomerResponses = {
30152
30180
  /**
30153
- * Number of newly revoked grants.
30181
+ * The customer after the change.
30154
30182
  */
30155
30183
  200: {
30156
30184
  /**
30157
- * Number of previously unrevoked grants marked revoked by this request.
30185
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30158
30186
  */
30159
- revoked: number;
30160
- };
30161
- };
30162
- export type RevokeEndUserTokensResponse = RevokeEndUserTokensResponses[keyof RevokeEndUserTokensResponses];
30163
- export type BlockEndUserData = {
30164
- body?: never;
30165
- path: {
30187
+ id: string;
30166
30188
  /**
30167
- * Active service agent identifier from agent creation or listing.
30189
+ * 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.
30168
30190
  */
30169
- agent_id: string;
30191
+ type: 'identified' | 'anonymous';
30170
30192
  /**
30171
- * Host user identifier supplied at issuance or from end-user listing.
30193
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30172
30194
  */
30173
- external_user_id: string;
30174
- };
30175
- query?: never;
30176
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/block';
30177
- };
30178
- export type BlockEndUserErrors = {
30179
- /**
30180
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
30181
- */
30182
- 400: unknown;
30183
- /**
30184
- * Authenticate with a host credential.
30185
- */
30186
- 401: unknown;
30187
- /**
30188
- * 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.
30189
- */
30190
- 403: AgentError;
30191
- /**
30192
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
30193
- */
30194
- 404: unknown;
30195
- /**
30196
- * Configure an embed policy before blocking or unblocking; retry if a concurrent policy update caused the conflict.
30197
- */
30198
- 409: unknown;
30199
- /**
30200
- * Credential revocation failed; grant timestamps remain unchanged. A requested block remains in effect; retry to finish revocation.
30201
- */
30202
- 502: unknown;
30203
- };
30204
- export type BlockEndUserError = BlockEndUserErrors[keyof BlockEndUserErrors];
30205
- export type BlockEndUserResponses = {
30206
- /**
30207
- * Current end-user view.
30208
- */
30209
- 200: {
30195
+ merged_into: string | null;
30210
30196
  /**
30211
- * Host application's user identifier, scoped to this organization and agent.
30197
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30212
30198
  */
30213
- external_user_id: string;
30199
+ blocked: boolean;
30214
30200
  /**
30215
- * Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
30201
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30216
30202
  */
30217
30203
  first_seen_at: string | null;
30218
30204
  /**
30219
- * Latest session update or token issuance time; null when there is no history.
30205
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30220
30206
  */
30221
- last_active_at: string | null;
30207
+ last_seen_at: string | null;
30222
30208
  /**
30223
- * Total sessions for this end user on this agent.
30209
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30224
30210
  */
30225
30211
  session_count: number;
30226
30212
  /**
30227
- * 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.
30213
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30228
30214
  */
30229
30215
  cost: {
30230
30216
  /**
@@ -30236,35 +30222,27 @@ export type BlockEndUserResponses = {
30236
30222
  */
30237
30223
  currency: 'USD';
30238
30224
  };
30239
- /**
30240
- * Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
30241
- */
30242
- blocked: boolean;
30243
30225
  };
30244
30226
  };
30245
- export type BlockEndUserResponse = BlockEndUserResponses[keyof BlockEndUserResponses];
30246
- export type UnblockEndUserData = {
30227
+ export type BlockCustomerResponse = BlockCustomerResponses[keyof BlockCustomerResponses];
30228
+ export type UnblockCustomerData = {
30247
30229
  body?: never;
30248
30230
  path: {
30249
30231
  /**
30250
- * Active service agent identifier from agent creation or listing.
30232
+ * Active service agent id from agent creation or listing.
30251
30233
  */
30252
30234
  agent_id: string;
30253
30235
  /**
30254
- * Host user identifier supplied at issuance or from end-user listing.
30236
+ * Customer id from customer listing, or your own customer_id.
30255
30237
  */
30256
- external_user_id: string;
30238
+ customer_id: string;
30257
30239
  };
30258
30240
  query?: never;
30259
- url: '/agent/v1/agents/{agent_id}/end_users/{external_user_id}/unblock';
30241
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock';
30260
30242
  };
30261
- export type UnblockEndUserErrors = {
30262
- /**
30263
- * Invalid identifier, prefix, limit, cursor or blocklist size; correct the reported input.
30264
- */
30265
- 400: unknown;
30243
+ export type UnblockCustomerErrors = {
30266
30244
  /**
30267
- * Authenticate with a host credential.
30245
+ * Authenticate with your API key or a console session.
30268
30246
  */
30269
30247
  401: unknown;
30270
30248
  /**
@@ -30272,38 +30250,46 @@ export type UnblockEndUserErrors = {
30272
30250
  */
30273
30251
  403: AgentError;
30274
30252
  /**
30275
- * Agent or requested user is unavailable to this caller, or the caller is an end user.
30253
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30276
30254
  */
30277
30255
  404: unknown;
30278
- /**
30279
- * Configure an embed policy before blocking or unblocking; retry if a concurrent policy update caused the conflict.
30280
- */
30281
- 409: unknown;
30282
30256
  };
30283
- export type UnblockEndUserError = UnblockEndUserErrors[keyof UnblockEndUserErrors];
30284
- export type UnblockEndUserResponses = {
30257
+ export type UnblockCustomerError = UnblockCustomerErrors[keyof UnblockCustomerErrors];
30258
+ export type UnblockCustomerResponses = {
30285
30259
  /**
30286
- * Current end-user view.
30260
+ * The customer after the change.
30287
30261
  */
30288
30262
  200: {
30289
30263
  /**
30290
- * Host application's user identifier, scoped to this organization and agent.
30264
+ * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30265
+ */
30266
+ id: string;
30267
+ /**
30268
+ * 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.
30269
+ */
30270
+ type: 'identified' | 'anonymous';
30271
+ /**
30272
+ * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30273
+ */
30274
+ merged_into: string | null;
30275
+ /**
30276
+ * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30291
30277
  */
30292
- external_user_id: string;
30278
+ blocked: boolean;
30293
30279
  /**
30294
- * Earliest session creation or token issuance time; null for a preemptively blocked user with no history.
30280
+ * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30295
30281
  */
30296
30282
  first_seen_at: string | null;
30297
30283
  /**
30298
- * Latest session update or token issuance time; null when there is no history.
30284
+ * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30299
30285
  */
30300
- last_active_at: string | null;
30286
+ last_seen_at: string | null;
30301
30287
  /**
30302
- * Total sessions for this end user on this agent.
30288
+ * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30303
30289
  */
30304
30290
  session_count: number;
30305
30291
  /**
30306
- * 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.
30292
+ * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30307
30293
  */
30308
30294
  cost: {
30309
30295
  /**
@@ -30315,50 +30301,25 @@ export type UnblockEndUserResponses = {
30315
30301
  */
30316
30302
  currency: 'USD';
30317
30303
  };
30318
- /**
30319
- * Whether the embed policy currently prevents this user from receiving tokens and creating sessions.
30320
- */
30321
- blocked: boolean;
30322
30304
  };
30323
30305
  };
30324
- export type UnblockEndUserResponse = UnblockEndUserResponses[keyof UnblockEndUserResponses];
30325
- export type ListCustomersData = {
30306
+ export type UnblockCustomerResponse = UnblockCustomerResponses[keyof UnblockCustomerResponses];
30307
+ export type RevokeCustomerTokensData = {
30326
30308
  body?: never;
30327
30309
  path: {
30328
30310
  /**
30329
30311
  * Active service agent id from agent creation or listing.
30330
30312
  */
30331
30313
  agent_id: string;
30332
- };
30333
- query?: {
30334
- /**
30335
- * Maximum customers per page, 1 to 100; defaults to 20.
30336
- */
30337
- limit?: number;
30338
- /**
30339
- * next_page from the previous response with the same q, type, blocked and limit.
30340
- */
30341
- page?: string;
30342
- /**
30343
- * Case-sensitive literal prefix of the customer id; omit for all customers.
30344
- */
30345
- q?: string;
30346
- /**
30347
- * Only identified or only anonymous customers; omit for both.
30348
- */
30349
- type?: 'identified' | 'anonymous';
30350
30314
  /**
30351
- * true for blocked customers only, false for customers who are not blocked; omit for both.
30315
+ * Customer id from customer listing, or your own customer_id.
30352
30316
  */
30353
- blocked?: boolean;
30317
+ customer_id: string;
30354
30318
  };
30355
- url: '/agent/v1/agents/{agent_id}/customers';
30319
+ query?: never;
30320
+ url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens';
30356
30321
  };
30357
- export type ListCustomersErrors = {
30358
- /**
30359
- * 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.
30360
- */
30361
- 400: unknown;
30322
+ export type RevokeCustomerTokensErrors = {
30362
30323
  /**
30363
30324
  * Authenticate with your API key or a console session.
30364
30325
  */
@@ -30368,142 +30329,41 @@ export type ListCustomersErrors = {
30368
30329
  */
30369
30330
  403: AgentError;
30370
30331
  /**
30371
- * The agent is not an active service agent of your organization, or the caller is a customer access token.
30332
+ * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30372
30333
  */
30373
30334
  404: unknown;
30374
- };
30375
- export type ListCustomersError = ListCustomersErrors[keyof ListCustomersErrors];
30376
- export type ListCustomersResponses = {
30377
- /**
30378
- * Matching customers and the next page cursor.
30379
- */
30380
- 200: {
30381
- /**
30382
- * Items of this page, in the order requested by the call.
30383
- */
30384
- data: Array<{
30385
- /**
30386
- * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30387
- */
30388
- id: string;
30389
- /**
30390
- * 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.
30391
- */
30392
- type: 'identified' | 'anonymous';
30393
- /**
30394
- * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30395
- */
30396
- merged_into: string | null;
30397
- /**
30398
- * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30399
- */
30400
- blocked: boolean;
30401
- /**
30402
- * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30403
- */
30404
- first_seen_at: string | null;
30405
- /**
30406
- * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30407
- */
30408
- last_seen_at: string | null;
30409
- /**
30410
- * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30411
- */
30412
- session_count: number;
30413
- /**
30414
- * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30415
- */
30416
- cost: {
30417
- /**
30418
- * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30419
- */
30420
- amount: string;
30421
- /**
30422
- * Always USD.
30423
- */
30424
- currency: 'USD';
30425
- };
30426
- }>;
30427
- /**
30428
- * Cursor for the next page with the same agent, q, type, blocked and limit; null when exhausted.
30429
- */
30430
- next_page: string | null;
30431
- };
30432
- };
30433
- export type ListCustomersResponse = ListCustomersResponses[keyof ListCustomersResponses];
30434
- export type DeleteCustomerData = {
30435
- body?: never;
30436
- path: {
30437
- /**
30438
- * Active service agent id from agent creation or listing.
30439
- */
30440
- agent_id: string;
30441
- /**
30442
- * Customer id from customer listing, or your own customer_id.
30443
- */
30444
- customer_id: string;
30445
- };
30446
- query: {
30447
- /**
30448
- * Must equal the customer_id path parameter exactly, confirming the destructive deletion.
30449
- */
30450
- confirm: string;
30451
- };
30452
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
30453
- };
30454
- export type DeleteCustomerErrors = {
30455
- /**
30456
- * INVALID_PARAMS: confirm is missing or differs from customer_id; send ?confirm=<customer_id>.
30457
- */
30458
- 400: unknown;
30459
- /**
30460
- * Authenticate with your API key or a console session.
30461
- */
30462
- 401: unknown;
30463
- /**
30464
- * 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.
30465
- */
30466
- 403: AgentError;
30467
30335
  /**
30468
- * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30336
+ * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30469
30337
  */
30470
- 404: unknown;
30338
+ 502: unknown;
30471
30339
  };
30472
- export type DeleteCustomerError = DeleteCustomerErrors[keyof DeleteCustomerErrors];
30473
- export type DeleteCustomerResponses = {
30340
+ export type RevokeCustomerTokensError = RevokeCustomerTokensErrors[keyof RevokeCustomerTokensErrors];
30341
+ export type RevokeCustomerTokensResponses = {
30474
30342
  /**
30475
- * Deletion accepted; poll the deletion endpoint until done or failed.
30343
+ * How many access tokens this request revoked.
30476
30344
  */
30477
- 202: {
30478
- /**
30479
- * Deletion task identifier.
30480
- */
30481
- id: string;
30345
+ 200: {
30482
30346
  /**
30483
- * Accepted for asynchronous processing; poll deletion for progress.
30347
+ * Number of access tokens this request revoked; 0 when none was live.
30484
30348
  */
30485
- status: 'pending';
30349
+ revoked: number;
30486
30350
  };
30487
30351
  };
30488
- export type DeleteCustomerResponse = DeleteCustomerResponses[keyof DeleteCustomerResponses];
30489
- export type GetCustomerData = {
30352
+ export type RevokeCustomerTokensResponse = RevokeCustomerTokensResponses[keyof RevokeCustomerTokensResponses];
30353
+ export type GetAgentAppearanceData = {
30490
30354
  body?: never;
30491
30355
  path: {
30492
30356
  /**
30493
- * Active service agent id from agent creation or listing.
30357
+ * Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
30494
30358
  */
30495
30359
  agent_id: string;
30496
- /**
30497
- * Customer id from customer listing, or your own customer_id.
30498
- */
30499
- customer_id: string;
30500
30360
  };
30501
30361
  query?: never;
30502
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}';
30362
+ url: '/agent/v1/agents/{agent_id}/appearance';
30503
30363
  };
30504
- export type GetCustomerErrors = {
30364
+ export type GetAgentAppearanceErrors = {
30505
30365
  /**
30506
- * Authenticate with your API key or a console session.
30366
+ * Authenticate with a customer access token of this agent, your API key or a console session.
30507
30367
  */
30508
30368
  401: unknown;
30509
30369
  /**
@@ -30511,1368 +30371,540 @@ export type GetCustomerErrors = {
30511
30371
  */
30512
30372
  403: AgentError;
30513
30373
  /**
30514
- * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30374
+ * AGENT_NOT_FOUND: the agent is absent, archived or not a service agent, or the customer access token belongs to another agent.
30515
30375
  */
30516
30376
  404: unknown;
30377
+ /**
30378
+ * Appearance is temporarily unavailable; use the default appearance and continue the conversation.
30379
+ */
30380
+ 503: unknown;
30517
30381
  };
30518
- export type GetCustomerError = GetCustomerErrors[keyof GetCustomerErrors];
30519
- export type GetCustomerResponses = {
30382
+ export type GetAgentAppearanceError = GetAgentAppearanceErrors[keyof GetAgentAppearanceErrors];
30383
+ export type GetAgentAppearanceResponses = {
30520
30384
  /**
30521
- * The customer with its recent sessions.
30385
+ * Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
30522
30386
  */
30523
30387
  200: {
30524
30388
  /**
30525
- * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30526
- */
30527
- id: string;
30528
- /**
30529
- * 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.
30530
- */
30531
- type: 'identified' | 'anonymous';
30532
- /**
30533
- * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30534
- */
30535
- merged_into: string | null;
30536
- /**
30537
- * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30538
- */
30539
- blocked: boolean;
30540
- /**
30541
- * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30542
- */
30543
- first_seen_at: string | null;
30544
- /**
30545
- * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30546
- */
30547
- last_seen_at: string | null;
30548
- /**
30549
- * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30550
- */
30551
- session_count: number;
30552
- /**
30553
- * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30389
+ * Public identity displayed on the chat page, independent of the internal agent name.
30554
30390
  */
30555
- cost: {
30391
+ agent?: {
30556
30392
  /**
30557
- * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30393
+ * Display name; omission keeps the neutral browser-language default.
30558
30394
  */
30559
- amount: string;
30395
+ name?: string;
30560
30396
  /**
30561
- * Always USD.
30397
+ * Optional HTTPS avatar image URL; non-HTTPS images are rejected.
30562
30398
  */
30563
- currency: 'USD';
30399
+ avatar?: string;
30564
30400
  };
30565
30401
  /**
30566
- * Up to twenty sessions of the customer, and of anonymous customers merged into it, most recently updated first.
30402
+ * 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.
30567
30403
  */
30568
- recent_sessions: Array<{
30404
+ layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
30405
+ /**
30406
+ * Default entry button for the loader; an explicit script data-launcher takes precedence.
30407
+ */
30408
+ launcher?: {
30569
30409
  /**
30570
- * Public sesn_ session identifier, usable with session retrieval.
30410
+ * 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.
30571
30411
  */
30572
- id: string;
30412
+ type: 'none' | 'bubble' | 'mascot';
30573
30413
  /**
30574
- * Session title, or null when unset.
30414
+ * Mascot images: exactly one of preset or images. Send pack, not image.
30575
30415
  */
30576
- title: string | null;
30416
+ pack?: {
30417
+ /**
30418
+ * Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
30419
+ */
30420
+ preset?: 'mint' | 'cat' | 'bot';
30421
+ /**
30422
+ * 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.
30423
+ */
30424
+ images?: {
30425
+ /**
30426
+ * Resting state.
30427
+ */
30428
+ idle: string;
30429
+ /**
30430
+ * Page open and while the greeting bubble shows.
30431
+ */
30432
+ greet?: string;
30433
+ /**
30434
+ * The visitor is typing in the composer.
30435
+ */
30436
+ listening?: string;
30437
+ /**
30438
+ * After the visitor sends, before the first reply text.
30439
+ */
30440
+ thinking?: string;
30441
+ /**
30442
+ * While the reply streams; alternates with talking-2 every 220 ms.
30443
+ */
30444
+ talking?: string;
30445
+ /**
30446
+ * Second mouth frame of talking, mouth closed; without it talking alternates with idle.
30447
+ */
30448
+ 'talking-2'?: string;
30449
+ /**
30450
+ * The last turn failed or was refused.
30451
+ */
30452
+ sorry?: string;
30453
+ /**
30454
+ * No interaction for 60 seconds; hover or click wakes the mascot.
30455
+ */
30456
+ sleep?: string;
30457
+ };
30458
+ };
30577
30459
  /**
30578
- * Session entry surface, or null when no surface was recorded.
30460
+ * Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
30579
30461
  */
30580
- source: string | null;
30462
+ image?: string;
30581
30463
  /**
30582
- * Session creation time in UTC.
30464
+ * float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
30583
30465
  */
30584
- created_at: string;
30466
+ motion?: 'float' | 'none';
30585
30467
  /**
30586
- * Most recent session update time in UTC.
30468
+ * Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
30587
30469
  */
30588
- updated_at: string;
30589
- }>;
30590
- };
30591
- };
30592
- export type GetCustomerResponse = GetCustomerResponses[keyof GetCustomerResponses];
30593
- export type GetCustomerDeletionData = {
30594
- body?: never;
30595
- path: {
30596
- /**
30597
- * Active service agent id from agent creation or listing.
30598
- */
30599
- agent_id: string;
30600
- /**
30601
- * Customer id from customer listing, or your own customer_id.
30602
- */
30603
- customer_id: string;
30604
- };
30605
- query?: never;
30606
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/deletion';
30607
- };
30608
- export type GetCustomerDeletionErrors = {
30609
- /**
30610
- * Authenticate with your API key or a console session.
30611
- */
30612
- 401: unknown;
30613
- /**
30614
- * 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.
30615
- */
30616
- 403: AgentError;
30617
- /**
30618
- * CUSTOMER_NOT_FOUND or no deletion task: the customer or task is unknown, or the caller is a customer access token.
30619
- */
30620
- 404: unknown;
30621
- };
30622
- export type GetCustomerDeletionError = GetCustomerDeletionErrors[keyof GetCustomerDeletionErrors];
30623
- export type GetCustomerDeletionResponses = {
30624
- /**
30625
- * The latest deletion task and its snapshot counts.
30626
- */
30627
- 200: {
30628
- /**
30629
- * Deletion task identifier.
30630
- */
30631
- id: string;
30470
+ position?: 'bottom-right' | 'bottom-left';
30471
+ /**
30472
+ * Accessible entry button label and bubble text; omission uses the default chat label.
30473
+ */
30474
+ label?: string;
30475
+ };
30632
30476
  /**
30633
- * 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.
30477
+ * Visible chat heading; omitted title uses the public agent name.
30634
30478
  */
30635
- status: 'pending' | 'snapshotting' | 'deleting' | 'done' | 'failed';
30479
+ header?: {
30480
+ /**
30481
+ * Optional heading text shown instead of the public agent name.
30482
+ */
30483
+ title?: string;
30484
+ /**
30485
+ * Optional secondary line beneath the heading.
30486
+ */
30487
+ subtitle?: string;
30488
+ /**
30489
+ * Optional HTTPS image shown in the heading avatar position.
30490
+ */
30491
+ icon?: string;
30492
+ };
30636
30493
  /**
30637
- * Counts from the verified snapshot; empty until snapshotting completes.
30494
+ * Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
30638
30495
  */
30639
- counts: {
30496
+ theme?: {
30640
30497
  /**
30641
- * Number of primary and child sessions in the snapshot.
30498
+ * light or dark selects a fixed scheme; system follows the device preference.
30642
30499
  */
30643
- sessions?: number;
30500
+ colorScheme?: 'light' | 'dark' | 'system';
30644
30501
  /**
30645
- * Number of durable session events captured without changing the history.
30502
+ * Explicit opaque CSS accent color, for example #167A43.
30646
30503
  */
30647
- events?: number;
30504
+ accent?: string;
30648
30505
  /**
30649
- * Number of stored transcript messages in the snapshot.
30506
+ * Explicit opaque CSS background color, for example #ffffff.
30650
30507
  */
30651
- messages?: number;
30508
+ surface?: string;
30652
30509
  /**
30653
- * Number of backed-up directory, authorization, feedback and projection rows.
30510
+ * neutral uses grayscale surfaces, warm uses warm tones, cool uses cool tones.
30654
30511
  */
30655
- d1_rows?: number;
30512
+ grayscale?: 'neutral' | 'warm' | 'cool';
30656
30513
  /**
30657
- * Number of session attachment references; their file bytes are retained.
30514
+ * Corner rounding: none is square, sm is small, md is medium, lg is large, full is fully rounded.
30658
30515
  */
30659
- attachments?: number;
30516
+ radius?: 'none' | 'sm' | 'md' | 'lg' | 'full';
30517
+ /**
30518
+ * Spacing: compact reduces gaps, normal uses defaults, spacious increases gaps.
30519
+ */
30520
+ density?: 'compact' | 'normal' | 'spacious';
30521
+ /**
30522
+ * CSS font family list using fonts available on the device; external font loading is not configured here.
30523
+ */
30524
+ fontFamily?: string;
30525
+ /**
30526
+ * Positive base font size in CSS pixels; omission preserves Kit sizing.
30527
+ */
30528
+ fontSize?: number;
30660
30529
  };
30661
30530
  /**
30662
- * Operator recovery snapshot key, retained for seven days. Attachment bytes are not copied or deleted.
30663
- */
30664
- snapshot_key?: string;
30665
- /**
30666
- * Content-free failure summary; retry the confirmed deletion to resume.
30667
- */
30668
- error?: string;
30669
- /**
30670
- * Task creation time in RFC 3339 format.
30671
- */
30672
- created_at: string;
30673
- /**
30674
- * Latest task update time in RFC 3339 format.
30675
- */
30676
- updated_at: string;
30677
- };
30678
- };
30679
- export type GetCustomerDeletionResponse = GetCustomerDeletionResponses[keyof GetCustomerDeletionResponses];
30680
- export type BlockCustomerData = {
30681
- body?: never;
30682
- path: {
30683
- /**
30684
- * Active service agent id from agent creation or listing.
30685
- */
30686
- agent_id: string;
30687
- /**
30688
- * Customer id from customer listing, or your own customer_id.
30689
- */
30690
- customer_id: string;
30691
- };
30692
- query?: never;
30693
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/block';
30694
- };
30695
- export type BlockCustomerErrors = {
30696
- /**
30697
- * Authenticate with your API key or a console session.
30698
- */
30699
- 401: unknown;
30700
- /**
30701
- * 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.
30702
- */
30703
- 403: AgentError;
30704
- /**
30705
- * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30706
- */
30707
- 404: unknown;
30708
- /**
30709
- * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30710
- */
30711
- 502: unknown;
30712
- };
30713
- export type BlockCustomerError = BlockCustomerErrors[keyof BlockCustomerErrors];
30714
- export type BlockCustomerResponses = {
30715
- /**
30716
- * The customer after the change.
30717
- */
30718
- 200: {
30719
- /**
30720
- * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30721
- */
30722
- id: string;
30723
- /**
30724
- * 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.
30725
- */
30726
- type: 'identified' | 'anonymous';
30727
- /**
30728
- * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30531
+ * Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
30729
30532
  */
30730
- merged_into: string | null;
30533
+ locale?: 'zh' | 'en';
30731
30534
  /**
30732
- * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30535
+ * Content displayed before the first message in a conversation.
30733
30536
  */
30734
- blocked: boolean;
30537
+ startScreen?: {
30538
+ /**
30539
+ * Optional welcome text on the empty conversation.
30540
+ */
30541
+ greeting?: string;
30542
+ /**
30543
+ * Up to four suggested questions; clicking a label sends its prompt text.
30544
+ */
30545
+ prompts?: Array<{
30546
+ /**
30547
+ * Visible suggested-question button text.
30548
+ */
30549
+ label: string;
30550
+ /**
30551
+ * User message sent when this suggestion is selected.
30552
+ */
30553
+ prompt: string;
30554
+ }>;
30555
+ };
30735
30556
  /**
30736
- * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30557
+ * Message input appearance; transport and attachment settings are excluded.
30737
30558
  */
30738
- first_seen_at: string | null;
30559
+ composer?: {
30560
+ /**
30561
+ * Hint shown when the message input is empty.
30562
+ */
30563
+ placeholder?: string;
30564
+ };
30739
30565
  /**
30740
- * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30566
+ * Optional notice displayed beside the conversation composer.
30741
30567
  */
30742
- last_seen_at: string | null;
30568
+ disclaimer?: string;
30743
30569
  /**
30744
- * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30570
+ * Optional text below the conversation.
30745
30571
  */
30746
- session_count: number;
30572
+ footer?: string;
30747
30573
  /**
30748
- * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30574
+ * Availability of the conversation history control.
30749
30575
  */
30750
- cost: {
30751
- /**
30752
- * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30753
- */
30754
- amount: string;
30576
+ history?: {
30755
30577
  /**
30756
- * Always USD.
30578
+ * False hides history; omission uses the default enabled state.
30757
30579
  */
30758
- currency: 'USD';
30580
+ enabled?: boolean;
30759
30581
  };
30760
30582
  };
30761
30583
  };
30762
- export type BlockCustomerResponse = BlockCustomerResponses[keyof BlockCustomerResponses];
30763
- export type UnblockCustomerData = {
30764
- body?: never;
30765
- path: {
30766
- /**
30767
- * Active service agent id from agent creation or listing.
30768
- */
30769
- agent_id: string;
30584
+ export type GetAgentAppearanceResponse = GetAgentAppearanceResponses[keyof GetAgentAppearanceResponses];
30585
+ export type CreateCustomerGrantCodeData = {
30586
+ body: {
30770
30587
  /**
30771
- * Customer id from customer listing, or your own customer_id.
30772
- */
30773
- customer_id: string;
30774
- };
30775
- query?: never;
30776
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/unblock';
30777
- };
30778
- export type UnblockCustomerErrors = {
30779
- /**
30780
- * Authenticate with your API key or a console session.
30781
- */
30782
- 401: unknown;
30783
- /**
30784
- * 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.
30785
- */
30786
- 403: AgentError;
30787
- /**
30788
- * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30789
- */
30790
- 404: unknown;
30791
- };
30792
- export type UnblockCustomerError = UnblockCustomerErrors[keyof UnblockCustomerErrors];
30793
- export type UnblockCustomerResponses = {
30794
- /**
30795
- * The customer after the change.
30796
- */
30797
- 200: {
30798
- /**
30799
- * The customer id: your customer_id for an identified customer, or anon_ followed by 16 characters for an anonymous one.
30800
- */
30801
- id: string;
30802
- /**
30803
- * 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.
30804
- */
30805
- type: 'identified' | 'anonymous';
30806
- /**
30807
- * For an anonymous customer who later signed in, the identified customer it joined; their conversations count toward that customer. null otherwise.
30808
- */
30809
- merged_into: string | null;
30810
- /**
30811
- * Whether the customer is blocked: no grant code, sign-in, renewal or new session is accepted for this id until it is unblocked.
30812
- */
30813
- blocked: boolean;
30814
- /**
30815
- * Earliest sign-in, session or token issuance for this customer, in RFC 3339; null when nothing is recorded.
30816
- */
30817
- first_seen_at: string | null;
30818
- /**
30819
- * Latest sign-in, token renewal, session update or token issuance, in RFC 3339; the list is ordered by it, newest first.
30820
- */
30821
- last_seen_at: string | null;
30822
- /**
30823
- * Sessions of this customer on this agent, including those of anonymous customers merged into it.
30824
- */
30825
- session_count: number;
30826
- /**
30827
- * Recorded cost of those sessions: model usage (threads included) plus session runtime; "0.000000" when nothing has been recorded.
30828
- */
30829
- cost: {
30830
- /**
30831
- * Amount in US dollars, as a decimal string with exactly 6 decimals and no exponent, e.g. "0.000345" or "12.500000".
30832
- */
30833
- amount: string;
30834
- /**
30835
- * Always USD.
30836
- */
30837
- currency: 'USD';
30838
- };
30839
- };
30840
- };
30841
- export type UnblockCustomerResponse = UnblockCustomerResponses[keyof UnblockCustomerResponses];
30842
- export type RevokeCustomerTokensData = {
30843
- body?: never;
30844
- path: {
30845
- /**
30846
- * Active service agent id from agent creation or listing.
30847
- */
30848
- agent_id: string;
30849
- /**
30850
- * Customer id from customer listing, or your own customer_id.
30851
- */
30852
- customer_id: string;
30853
- };
30854
- query?: never;
30855
- url: '/agent/v1/agents/{agent_id}/customers/{customer_id}/revoke_tokens';
30856
- };
30857
- export type RevokeCustomerTokensErrors = {
30858
- /**
30859
- * Authenticate with your API key or a console session.
30860
- */
30861
- 401: unknown;
30862
- /**
30863
- * 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.
30864
- */
30865
- 403: AgentError;
30866
- /**
30867
- * CUSTOMER_NOT_FOUND: the customer is unknown on this agent, or the caller is a customer access token.
30868
- */
30869
- 404: unknown;
30870
- /**
30871
- * Credential revocation failed; the customer stays blocked if you asked to block it. Retry to finish revoking.
30872
- */
30873
- 502: unknown;
30874
- };
30875
- export type RevokeCustomerTokensError = RevokeCustomerTokensErrors[keyof RevokeCustomerTokensErrors];
30876
- export type RevokeCustomerTokensResponses = {
30877
- /**
30878
- * How many access tokens this request revoked.
30879
- */
30880
- 200: {
30881
- /**
30882
- * Number of access tokens this request revoked; 0 when none was live.
30883
- */
30884
- revoked: number;
30885
- };
30886
- };
30887
- export type RevokeCustomerTokensResponse = RevokeCustomerTokensResponses[keyof RevokeCustomerTokensResponses];
30888
- export type GetAgentAppearanceData = {
30889
- body?: never;
30890
- path: {
30891
- /**
30892
- * Service agent id from agent creation or listing; with a customer access token, the agent the token was issued for.
30893
- */
30894
- agent_id: string;
30895
- };
30896
- query?: never;
30897
- url: '/agent/v1/agents/{agent_id}/appearance';
30898
- };
30899
- export type GetAgentAppearanceErrors = {
30900
- /**
30901
- * Authenticate with a customer access token of this agent, your API key or a console session.
30902
- */
30903
- 401: unknown;
30904
- /**
30905
- * 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.
30906
- */
30907
- 403: AgentError;
30908
- /**
30909
- * AGENT_NOT_FOUND: the agent is absent, archived or not a service agent, or the customer access token belongs to another agent.
30910
- */
30911
- 404: unknown;
30912
- /**
30913
- * Appearance is temporarily unavailable; use the default appearance and continue the conversation.
30914
- */
30915
- 503: unknown;
30916
- };
30917
- export type GetAgentAppearanceError = GetAgentAppearanceErrors[keyof GetAgentAppearanceErrors];
30918
- export type GetAgentAppearanceResponses = {
30919
- /**
30920
- * Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
30921
- */
30922
- 200: {
30923
- /**
30924
- * Public identity displayed on the chat page, independent of the internal agent name.
30925
- */
30926
- agent?: {
30927
- /**
30928
- * Display name; omission keeps the neutral browser-language default.
30929
- */
30930
- name?: string;
30931
- /**
30932
- * Optional HTTPS avatar image URL; non-HTTPS images are rejected.
30933
- */
30934
- avatar?: string;
30935
- };
30936
- /**
30937
- * 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.
30938
- */
30939
- layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
30940
- /**
30941
- * Default entry button for the loader; an explicit script data-launcher takes precedence.
30942
- */
30943
- launcher?: {
30944
- /**
30945
- * 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.
30946
- */
30947
- type: 'none' | 'bubble' | 'mascot';
30948
- /**
30949
- * Mascot images: exactly one of preset or images. Send pack, not image.
30950
- */
30951
- pack?: {
30952
- /**
30953
- * Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
30954
- */
30955
- preset?: 'mint' | 'cat' | 'bot';
30956
- /**
30957
- * 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.
30958
- */
30959
- images?: {
30960
- /**
30961
- * Resting state.
30962
- */
30963
- idle: string;
30964
- /**
30965
- * Page open and while the greeting bubble shows.
30966
- */
30967
- greet?: string;
30968
- /**
30969
- * The visitor is typing in the composer.
30970
- */
30971
- listening?: string;
30972
- /**
30973
- * After the visitor sends, before the first reply text.
30974
- */
30975
- thinking?: string;
30976
- /**
30977
- * While the reply streams; alternates with talking-2 every 220 ms.
30978
- */
30979
- talking?: string;
30980
- /**
30981
- * Second mouth frame of talking, mouth closed; without it talking alternates with idle.
30982
- */
30983
- 'talking-2'?: string;
30984
- /**
30985
- * The last turn failed or was refused.
30986
- */
30987
- sorry?: string;
30988
- /**
30989
- * No interaction for 60 seconds; hover or click wakes the mascot.
30990
- */
30991
- sleep?: string;
30992
- };
30993
- };
30994
- /**
30995
- * Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
30996
- */
30997
- image?: string;
30998
- /**
30999
- * float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
31000
- */
31001
- motion?: 'float' | 'none';
31002
- /**
31003
- * Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
31004
- */
31005
- position?: 'bottom-right' | 'bottom-left';
31006
- /**
31007
- * Accessible entry button label and bubble text; omission uses the default chat label.
31008
- */
31009
- label?: string;
31010
- };
31011
- /**
31012
- * Visible chat heading; omitted title uses the public agent name.
31013
- */
31014
- header?: {
31015
- /**
31016
- * Optional heading text shown instead of the public agent name.
31017
- */
31018
- title?: string;
31019
- /**
31020
- * Optional secondary line beneath the heading.
31021
- */
31022
- subtitle?: string;
31023
- /**
31024
- * Optional HTTPS image shown in the heading avatar position.
31025
- */
31026
- icon?: string;
31027
- };
31028
- /**
31029
- * Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
31030
- */
31031
- theme?: {
31032
- /**
31033
- * light or dark selects a fixed scheme; system follows the device preference.
31034
- */
31035
- colorScheme?: 'light' | 'dark' | 'system';
31036
- /**
31037
- * Explicit opaque CSS accent color, for example #167A43.
31038
- */
31039
- accent?: string;
31040
- /**
31041
- * Explicit opaque CSS background color, for example #ffffff.
31042
- */
31043
- surface?: string;
31044
- /**
31045
- * neutral uses grayscale surfaces, warm uses warm tones, cool uses cool tones.
31046
- */
31047
- grayscale?: 'neutral' | 'warm' | 'cool';
31048
- /**
31049
- * Corner rounding: none is square, sm is small, md is medium, lg is large, full is fully rounded.
31050
- */
31051
- radius?: 'none' | 'sm' | 'md' | 'lg' | 'full';
31052
- /**
31053
- * Spacing: compact reduces gaps, normal uses defaults, spacious increases gaps.
31054
- */
31055
- density?: 'compact' | 'normal' | 'spacious';
31056
- /**
31057
- * CSS font family list using fonts available on the device; external font loading is not configured here.
31058
- */
31059
- fontFamily?: string;
31060
- /**
31061
- * Positive base font size in CSS pixels; omission preserves Kit sizing.
31062
- */
31063
- fontSize?: number;
31064
- };
31065
- /**
31066
- * Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
31067
- */
31068
- locale?: 'zh' | 'en';
31069
- /**
31070
- * Content displayed before the first message in a conversation.
31071
- */
31072
- startScreen?: {
31073
- /**
31074
- * Optional welcome text on the empty conversation.
31075
- */
31076
- greeting?: string;
31077
- /**
31078
- * Up to four suggested questions; clicking a label sends its prompt text.
31079
- */
31080
- prompts?: Array<{
31081
- /**
31082
- * Visible suggested-question button text.
31083
- */
31084
- label: string;
31085
- /**
31086
- * User message sent when this suggestion is selected.
31087
- */
31088
- prompt: string;
31089
- }>;
31090
- };
31091
- /**
31092
- * Message input appearance; transport and attachment settings are excluded.
31093
- */
31094
- composer?: {
31095
- /**
31096
- * Hint shown when the message input is empty.
31097
- */
31098
- placeholder?: string;
31099
- };
31100
- /**
31101
- * Optional notice displayed beside the conversation composer.
31102
- */
31103
- disclaimer?: string;
31104
- /**
31105
- * Optional text below the conversation.
31106
- */
31107
- footer?: string;
31108
- /**
31109
- * Availability of the conversation history control.
31110
- */
31111
- history?: {
31112
- /**
31113
- * False hides history; omission uses the default enabled state.
31114
- */
31115
- enabled?: boolean;
31116
- };
31117
- };
31118
- };
31119
- export type GetAgentAppearanceResponse = GetAgentAppearanceResponses[keyof GetAgentAppearanceResponses];
31120
- export type CreateCustomerGrantCodeData = {
31121
- body: {
31122
- /**
31123
- * Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. "auth" is reserved, and ids starting with anon_ are reserved for anonymous customers.
31124
- */
31125
- customer_id: string;
31126
- /**
31127
- * Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued.
31128
- */
31129
- version?: number;
31130
- /**
31131
- * 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.
31132
- */
31133
- budget?: {
31134
- /**
31135
- * Budget kind; always limit.
31136
- */
31137
- type: 'limit';
31138
- /**
31139
- * Spending limit of each session the customer starts.
31140
- */
31141
- max_list_cost: {
31142
- /**
31143
- * 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.
31144
- */
31145
- amount: string;
31146
- /**
31147
- * Always USD.
31148
- */
31149
- currency: 'USD';
31150
- };
31151
- };
31152
- /**
31153
- * Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.
31154
- */
31155
- system_message?: Array<{
31156
- /**
31157
- * The text block kind; text is the only supported kind.
31158
- */
31159
- type: 'text';
31160
- /**
31161
- * Context text about this customer. All blocks together must fit within 8192 UTF-8 bytes.
31162
- */
31163
- text: string;
31164
- }>;
31165
- /**
31166
- * Optional system prompt override, accepted only when the embed policy allows agent overrides.
31167
- */
31168
- agent_override?: {
31169
- /**
31170
- * Replacement system prompt, or null to clear it for this sign-in.
31171
- */
31172
- system: string | null;
31173
- };
31174
- /**
31175
- * Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved.
31176
- */
31177
- metadata?: {
31178
- [key: string]: string;
31179
- };
31180
- /**
31181
- * Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin.
31182
- */
31183
- origin?: string;
31184
- /**
31185
- * Seconds the code stays redeemable, from 60 to 86400. Defaults to 900.
31186
- */
31187
- expires_in?: number;
31188
- /**
31189
- * Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800.
31190
- */
31191
- max_session_seconds?: number;
31192
- /**
31193
- * The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange.
31194
- */
31195
- anonymous_access_token?: string;
31196
- /**
31197
- * Set true to also return hosted_url, a link to the agent's Hosted chat page that carries the code in its fragment. The page exchanges the code only when the customer clicks to start, so link previews in email or chat apps do not use it up. The agent must have an identity_number, and origin cannot be set: the code is bound to no origin. Defaults to false.
31198
- */
31199
- hosted?: boolean;
31200
- };
31201
- path: {
31202
- /**
31203
- * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31204
- */
31205
- agent_id: string;
31206
- };
31207
- query?: never;
31208
- url: '/agent/v1/agents/{agent_id}/customers/auth/grant_codes';
31209
- };
31210
- export type CreateCustomerGrantCodeErrors = {
31211
- /**
31212
- * INVALID_PARAMS: an unknown field, a reserved or malformed customer_id, an origin outside the policy, a value outside its range, or an anonymous_access_token that is not a live anonymous token of this agent. The message names the field to correct.
31213
- */
31214
- 400: unknown;
31215
- /**
31216
- * Authenticate with your backend API key or a console session.
31217
- */
31218
- 401: unknown;
31219
- /**
31220
- * CUSTOMER_BLOCKED: the customer is on the agent's blocked list; unblock them in the console first.
31221
- */
31222
- 403: unknown;
31223
- /**
31224
- * The agent is not an active service agent of your organization, or the caller is a customer access token.
31225
- */
31226
- 404: unknown;
31227
- };
31228
- export type CreateCustomerGrantCodeResponses = {
31229
- /**
31230
- * The one-time grant code and its expiry. Only its hash is stored; it cannot be read again.
31231
- */
31232
- 201: {
31233
- /**
31234
- * Object type, always customer_grant_code.
31235
- */
31236
- type: 'customer_grant_code';
31237
- /**
31238
- * One-time grant code (cgc_…). Hand it to Agent Kit in the browser, which exchanges it for an access token; it is never shown again.
31239
- */
31240
- code: string;
31241
- /**
31242
- * The customer_id that the code signs in.
31243
- */
31244
- customer_id: string;
31245
- /**
31246
- * RFC 3339 time after which the code can no longer be exchanged.
31247
- */
31248
- expires_at: string;
31249
- /**
31250
- * Returned only when hosted is true: https://chat.praxisusercontent.com/a/{identity_number}?mode=hosted#grant={code}. Send it to the customer before expires_at; the code stays in the fragment and never reaches a server log.
31251
- */
31252
- hosted_url?: string;
31253
- };
31254
- };
31255
- export type CreateCustomerGrantCodeResponse = CreateCustomerGrantCodeResponses[keyof CreateCustomerGrantCodeResponses];
31256
- export type CreateCustomerAccessTokenData = {
31257
- /**
31258
- * Exactly one of grant_code (a signed-in customer) or publishable_key (an anonymous visitor).
31259
- */
31260
- body: {
31261
- /**
31262
- * The grant code your backend received from grant_codes. It works once.
31263
- */
31264
- grant_code: string;
31265
- } | {
31266
- /**
31267
- * The agent's publishable key, for a visitor who has not signed in. Creates a new anonymous customer.
31268
- */
31269
- publishable_key: string;
31270
- };
31271
- headers?: {
31272
- /**
31273
- * Browser page origin. Required for publishable_key and for a grant code bound to an origin; it must be in the agent's allowed_origins.
31274
- */
31275
- Origin?: string;
31276
- };
31277
- path: {
31278
- /**
31279
- * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31280
- */
31281
- agent_id: string;
31282
- };
31283
- query?: never;
31284
- url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens';
31285
- };
31286
- export type CreateCustomerAccessTokenErrors = {
31287
- /**
31288
- * INVALID_PARAMS: send exactly one of grant_code or publishable_key, nothing else.
31289
- */
31290
- 400: unknown;
31291
- /**
31292
- * GRANT_CODE_INVALID: the code is unknown, already used, expired or for another agent (one answer for all four); request a new grant code from your backend. UNAUTHENTICATED: the publishable key is unknown, disabled or for another agent.
31293
- */
31294
- 401: unknown;
31295
- /**
31296
- * EMBED_BUDGET_EXHAUSTED: the publishable key's daily spending cap is reached; wait for the UTC reset or ask the owner to raise it.
31297
- */
31298
- 402: unknown;
31299
- /**
31300
- * ORIGIN_NOT_ALLOWED or EMBED_ORIGIN_NOT_ALLOWED: call from the origin the code was issued for, or from one in the agent's allowed_origins. CUSTOMER_BLOCKED: the merchant blocked this customer.
31301
- */
31302
- 403: unknown;
31303
- /**
31304
- * EMBED_RATE_LIMITED: the per-IP minute limit or the key's daily session cap is reached; wait for Retry-After or the UTC reset.
31305
- */
31306
- 429: unknown;
31307
- /**
31308
- * Issuance or rate limiting is unavailable; retry later with a new grant code if this one expires.
31309
- */
31310
- 503: unknown;
31311
- };
31312
- export type CreateCustomerAccessTokenResponses = {
31313
- /**
31314
- * A customer access token, its expiry and the end of the sign-in.
31315
- */
31316
- 201: {
31317
- /**
31318
- * Object type, always customer_access_token.
31319
- */
31320
- type: 'customer_access_token';
31321
- /**
31322
- * Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
31323
- */
31324
- access_token: string;
31325
- /**
31326
- * RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
31327
- */
31328
- expires_at: string;
31329
- /**
31330
- * RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
31331
- */
31332
- session_expires_at: string;
31333
- /**
31334
- * The customer this token acts for.
31335
- */
31336
- customer: {
31337
- /**
31338
- * The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
31339
- */
31340
- id: string;
31341
- /**
31342
- * identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
31343
- */
31344
- type: 'identified' | 'anonymous';
31345
- };
31346
- };
31347
- };
31348
- export type CreateCustomerAccessTokenResponse = CreateCustomerAccessTokenResponses[keyof CreateCustomerAccessTokenResponses];
31349
- export type RenewCustomerAccessTokenData = {
31350
- body?: never;
31351
- path: {
31352
- /**
31353
- * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31354
- */
31355
- agent_id: string;
31356
- };
31357
- query?: never;
31358
- url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew';
31359
- };
31360
- export type RenewCustomerAccessTokenErrors = {
31361
- /**
31362
- * ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at. CUSTOMER_SESSION_EXPIRED: less than 60 seconds of the sign-in remain; sign in again: request a new grant code from your backend.
31363
- */
31364
- 401: unknown;
31365
- /**
31366
- * CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
31367
- */
31368
- 403: unknown;
31369
- /**
31370
- * The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
31371
- */
31372
- 404: unknown;
31373
- };
31374
- export type RenewCustomerAccessTokenResponses = {
31375
- /**
31376
- * A new access token in the same sign-in. The presented token stays valid until its own expiry.
31377
- */
31378
- 201: {
31379
- /**
31380
- * Object type, always customer_access_token.
31381
- */
31382
- type: 'customer_access_token';
31383
- /**
31384
- * Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
30588
+ * Your stable, opaque identifier for the signed-in customer, such as your database user id. Do not use an email address or phone number. "auth" is reserved, and ids starting with anon_ are reserved for anonymous customers.
31385
30589
  */
31386
- access_token: string;
30590
+ customer_id: string;
31387
30591
  /**
31388
- * RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
30592
+ * Existing agent version that every token of this sign-in pins. Defaults to the agent's active_version when the code is issued.
31389
30593
  */
31390
- expires_at: string;
30594
+ version?: number;
31391
30595
  /**
31392
- * RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
30596
+ * 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.
31393
30597
  */
31394
- session_expires_at: string;
30598
+ budget?: {
30599
+ /**
30600
+ * Budget kind; always limit.
30601
+ */
30602
+ type: 'limit';
30603
+ /**
30604
+ * Spending limit of each session the customer starts.
30605
+ */
30606
+ max_list_cost: {
30607
+ /**
30608
+ * 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.
30609
+ */
30610
+ amount: string;
30611
+ /**
30612
+ * Always USD.
30613
+ */
30614
+ currency: 'USD';
30615
+ };
30616
+ };
31395
30617
  /**
31396
- * The customer this token acts for.
30618
+ * Optional context the agent receives at the start of each session, as text blocks, limited to 8192 UTF-8 bytes in total.
31397
30619
  */
31398
- customer: {
30620
+ system_message?: Array<{
31399
30621
  /**
31400
- * The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
30622
+ * The text block kind; text is the only supported kind.
31401
30623
  */
31402
- id: string;
30624
+ type: 'text';
31403
30625
  /**
31404
- * identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
30626
+ * Context text about this customer. All blocks together must fit within 8192 UTF-8 bytes.
31405
30627
  */
31406
- type: 'identified' | 'anonymous';
30628
+ text: string;
30629
+ }>;
30630
+ /**
30631
+ * Optional system prompt override, accepted only when the embed policy allows agent overrides.
30632
+ */
30633
+ agent_override?: {
30634
+ /**
30635
+ * Replacement system prompt, or null to clear it for this sign-in.
30636
+ */
30637
+ system: string | null;
31407
30638
  };
31408
- };
31409
- };
31410
- export type RenewCustomerAccessTokenResponse = RenewCustomerAccessTokenResponses[keyof RenewCustomerAccessTokenResponses];
31411
- export type DeleteCurrentCustomerAccessTokenData = {
31412
- body?: never;
31413
- path: {
31414
30639
  /**
31415
- * Service agent id (agent_…) or its short identity number, from agent creation or listing.
30640
+ * Up to 16 string pairs copied onto every session the customer starts. The playground key is reserved.
31416
30641
  */
31417
- agent_id: string;
31418
- };
31419
- query?: never;
31420
- url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current';
31421
- };
31422
- export type DeleteCurrentCustomerAccessTokenErrors = {
31423
- /**
31424
- * ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at.
31425
- */
31426
- 401: unknown;
31427
- /**
31428
- * CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
31429
- */
31430
- 403: unknown;
31431
- /**
31432
- * The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
31433
- */
31434
- 404: unknown;
31435
- };
31436
- export type DeleteCurrentCustomerAccessTokenResponses = {
31437
- /**
31438
- * Logged out: the sign-in and every access token in it are revoked, and their live event streams close.
31439
- */
31440
- 204: void;
31441
- };
31442
- export type DeleteCurrentCustomerAccessTokenResponse = DeleteCurrentCustomerAccessTokenResponses[keyof DeleteCurrentCustomerAccessTokenResponses];
31443
- export type ExchangeEmbedCodeData = {
31444
- body: {
30642
+ metadata?: {
30643
+ [key: string]: string;
30644
+ };
31445
30645
  /**
31446
- * Single-use credential from the c fragment parameter of hosted_url returned by embed token creation. Valid for 60 seconds.
30646
+ * Page origin, such as https://shop.example.com, that must be one of the agent policy's allowed_origins (or localhost when the policy allows it). When set, every token of this sign-in works only from exactly this origin. Omit to accept any policy origin.
31447
30647
  */
31448
- code: string;
31449
- };
31450
- path?: never;
31451
- query?: never;
31452
- url: '/agent/v1/embed/exchange';
31453
- };
31454
- export type ExchangeEmbedCodeErrors = {
31455
- /**
31456
- * Expected a JSON object containing only code. Correct the request body.
31457
- */
31458
- 400: unknown;
31459
- /**
31460
- * UNAUTHENTICATED (or INVALID_API_KEY, API_KEY_DISABLED, API_KEY_EXPIRED, INVALID_API_TOKEN, API_TOKEN_EXPIRED, API_TOKEN_REVOKED): the API key is missing, invalid or revoked. Send a valid key as X-API-Key or as a Bearer token.
31461
- */
31462
- 401: AgentError;
31463
- /**
31464
- * 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.
31465
- */
31466
- 403: AgentError;
31467
- /**
31468
- * The code is expired, already used or unknown. Return to the host website for a new link; all three cases have the same response body.
31469
- */
31470
- 404: unknown;
31471
- /**
31472
- * The IP minute limit is reached. Wait for Retry-After before trying a fresh link.
31473
- */
31474
- 429: unknown;
31475
- /**
31476
- * Exchange or rate limiting is unavailable. Return to the host website for a new link later.
31477
- */
31478
- 503: unknown;
31479
- };
31480
- export type ExchangeEmbedCodeError = ExchangeEmbedCodeErrors[keyof ExchangeEmbedCodeErrors];
31481
- export type ExchangeEmbedCodeResponses = {
31482
- /**
31483
- * The end-user token and its expiration; the code has been consumed.
31484
- */
31485
- 200: {
30648
+ origin?: string;
31486
30649
  /**
31487
- * End-user credential for the hosted conversation. Keep it in memory; it cannot be refreshed here.
30650
+ * Seconds the code stays redeemable, from 60 to 86400. Defaults to 900.
31488
30651
  */
31489
- token: string;
30652
+ expires_in?: number;
31490
30653
  /**
31491
- * Token expiration as an ISO 8601 UTC timestamp. Return to the host website after expiration.
30654
+ * Total lifetime of the sign-in in seconds, from 3600 to 604800 (7 days). Tokens renew within it; after it the customer signs in again. Defaults to 604800.
31492
30655
  */
31493
- expires_at: string;
31494
- };
31495
- };
31496
- export type ExchangeEmbedCodeResponse = ExchangeEmbedCodeResponses[keyof ExchangeEmbedCodeResponses];
31497
- export type CreateAnonymousEmbedTokenData = {
31498
- body: {
30656
+ max_session_seconds?: number;
31499
30657
  /**
31500
- * Public key created by the service agent owner; safe to include in browser code.
30658
+ * The current access token of the anonymous customer who used this agent before signing in. Their conversations become visible to the identified customer, and the anonymous sign-in ends at exchange.
31501
30659
  */
31502
- publishable_key: string;
30660
+ anonymous_access_token?: string;
31503
30661
  /**
31504
- * Secret returned by a previous anonymous issuance for this key. Omit for a new visitor; an unknown secret creates a new visitor.
30662
+ * Set true to also return hosted_url, a link to the agent's Hosted chat page that carries the code in its fragment. The page exchanges the code only when the customer clicks to start, so link previews in email or chat apps do not use it up. The agent must have an identity_number, and origin cannot be set: the code is bound to no origin. Defaults to false.
31505
30663
  */
31506
- visitor_secret?: string;
30664
+ hosted?: boolean;
31507
30665
  };
31508
- headers: {
30666
+ path: {
31509
30667
  /**
31510
- * Browser page origin from the agent policy allowlist.
30668
+ * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31511
30669
  */
31512
- Origin: string;
30670
+ agent_id: string;
31513
30671
  };
31514
- path?: never;
31515
30672
  query?: never;
31516
- url: '/agent/v1/embed_tokens/anonymous';
30673
+ url: '/agent/v1/agents/{agent_id}/customers/auth/grant_codes';
31517
30674
  };
31518
- export type CreateAnonymousEmbedTokenErrors = {
30675
+ export type CreateCustomerGrantCodeErrors = {
31519
30676
  /**
31520
- * Unknown or invalid request fields, or key budget exceeds policy. Correct the request or ask the owner to update the key.
30677
+ * INVALID_PARAMS: an unknown field, a reserved or malformed customer_id, an origin outside the policy, a value outside its range, or an anonymous_access_token that is not a live anonymous token of this agent. The message names the field to correct.
31521
30678
  */
31522
30679
  400: unknown;
31523
30680
  /**
31524
- * Unknown or disabled publishable key. Ask the agent owner for an active key.
30681
+ * Authenticate with your backend API key or a console session.
31525
30682
  */
31526
30683
  401: unknown;
31527
30684
  /**
31528
- * EMBED_BUDGET_EXHAUSTED. The daily spending cap is reached; wait for the UTC reset or ask the owner to raise it.
31529
- */
31530
- 402: unknown;
31531
- /**
31532
- * EMBED_ORIGIN_NOT_ALLOWED or EMBED_USER_BLOCKED. Use an allowed page origin or contact the owner.
30685
+ * CUSTOMER_BLOCKED: the customer is on the agent's blocked list; unblock them in the console first.
31533
30686
  */
31534
30687
  403: unknown;
31535
30688
  /**
31536
- * EMBED_RATE_LIMITED. Wait for the IP minute window or UTC daily session cap reset.
31537
- */
31538
- 429: unknown;
31539
- /**
31540
- * Anonymous issuance or rate limiting is unavailable; retry later.
30689
+ * The agent is not an active service agent of your organization, or the caller is a customer access token.
31541
30690
  */
31542
- 503: unknown;
30691
+ 404: unknown;
31543
30692
  };
31544
- export type CreateAnonymousEmbedTokenResponses = {
30693
+ export type CreateCustomerGrantCodeResponses = {
31545
30694
  /**
31546
- * End-user token and expiration, with a visitor secret only for a new visitor.
30695
+ * The one-time grant code and its expiry. Only its hash is stored; it cannot be read again.
31547
30696
  */
31548
- 200: {
31549
- /**
31550
- * Short-lived end-user bearer credential for this agent's embedded sessions.
31551
- */
31552
- token: string;
31553
- /**
31554
- * RFC 3339 expiration; refresh before this time using the same visitor_secret.
31555
- */
31556
- expires_at: string;
30697
+ 201: {
31557
30698
  /**
31558
- * Newly generated visitor secret; save it locally and include it on later requests. Absent when the supplied secret was recognized.
30699
+ * Object type, always customer_grant_code.
31559
30700
  */
31560
- visitor_secret?: string;
31561
- };
31562
- };
31563
- export type CreateAnonymousEmbedTokenResponse = CreateAnonymousEmbedTokenResponses[keyof CreateAnonymousEmbedTokenResponses];
31564
- export type ListEmbedTokensData = {
31565
- body?: never;
31566
- path?: never;
31567
- query?: {
30701
+ type: 'customer_grant_code';
31568
30702
  /**
31569
- * Filter by service agent identifier (agent_ or agt_ prefix).
30703
+ * One-time grant code (cgc_…). Hand it to Agent Kit in the browser, which exchanges it for an access token; it is never shown again.
31570
30704
  */
31571
- agent_id?: string;
30705
+ code: string;
31572
30706
  /**
31573
- * Exact host user identifier supplied at issuance.
30707
+ * The customer_id that the code signs in.
31574
30708
  */
31575
- external_user_id?: string;
30709
+ customer_id: string;
31576
30710
  /**
31577
- * Maximum records per page; defaults to 20.
30711
+ * RFC 3339 time after which the code can no longer be exchanged.
31578
30712
  */
31579
- limit?: number;
30713
+ expires_at: string;
31580
30714
  /**
31581
- * next_page from a previous response with the same filters.
30715
+ * Returned only when hosted is true: https://chat.praxisusercontent.com/a/{identity_number}?mode=hosted#grant={code}. Send it to the customer before expires_at; the code stays in the fragment and never reaches a server log.
31582
30716
  */
31583
- page?: string;
30717
+ hosted_url?: string;
31584
30718
  };
31585
- url: '/agent/v1/embed_tokens';
31586
- };
31587
- export type ListEmbedTokensErrors = {
31588
- /**
31589
- * Invalid filter, limit or cursor; reuse the cursor with its original filters.
31590
- */
31591
- 400: unknown;
31592
- /**
31593
- * Authenticate with a host credential.
31594
- */
31595
- 401: unknown;
31596
- /**
31597
- * 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.
31598
- */
31599
- 403: AgentError;
31600
- /**
31601
- * The grant is missing or belongs to another organization, or the caller is an end user.
31602
- */
31603
- 404: unknown;
31604
- /**
31605
- * Upstream revocation failed; the record remains unrevoked and the request may be retried.
31606
- */
31607
- 502: unknown;
31608
30719
  };
31609
- export type ListEmbedTokensError = ListEmbedTokensErrors[keyof ListEmbedTokensErrors];
31610
- export type ListEmbedTokensResponses = {
30720
+ export type CreateCustomerGrantCodeResponse = CreateCustomerGrantCodeResponses[keyof CreateCustomerGrantCodeResponses];
30721
+ export type CreateCustomerAccessTokenData = {
31611
30722
  /**
31612
- * Issuance records and next page cursor.
30723
+ * Exactly one of grant_code (a signed-in customer) or publishable_key (an anonymous visitor).
31613
30724
  */
31614
- 200: {
31615
- /**
31616
- * Items of this page, in the order requested by the call.
31617
- */
31618
- data: Array<{
31619
- /**
31620
- * Grant identifier returned by embed token creation.
31621
- */
31622
- id: string;
31623
- /**
31624
- * Toolset type id as used in an agent's tools entry, for example agent_toolset_20260401.
31625
- */
31626
- type: 'embed_token';
31627
- /**
31628
- * Service agent identifier.
31629
- */
31630
- agent_id: string;
31631
- /**
31632
- * Pinned agent version.
31633
- */
31634
- agent_version: number;
31635
- /**
31636
- * Exact host user identifier supplied at issuance.
31637
- */
31638
- external_user_id: string;
31639
- /**
31640
- * Issuance time in RFC 3339 format.
31641
- */
31642
- created_at: string;
31643
- /**
31644
- * Expiration time in RFC 3339 format.
31645
- */
31646
- expires_at: string;
31647
- /**
31648
- * Revocation time in RFC 3339 format, or null while not revoked.
31649
- */
31650
- revoked_at: string | null;
31651
- /**
31652
- * Host origin recorded at issuance, or null when absent.
31653
- */
31654
- host_origin: string | null;
31655
- /**
31656
- * User or API key that issued the token.
31657
- */
31658
- issued_by: {
31659
- /**
31660
- * user identifies a signed-in organization member; api_key identifies the issuing API key.
31661
- */
31662
- type: 'user' | 'api_key';
31663
- /**
31664
- * Identifier of the object, as returned by the API; pass it in the path of follow-up calls on the same resource.
31665
- */
31666
- id: string;
31667
- };
31668
- }>;
31669
- /**
31670
- * Cursor for the next page using the same filters, or null when exhausted.
31671
- */
31672
- next_page: string | null;
31673
- };
31674
- };
31675
- export type ListEmbedTokensResponse = ListEmbedTokensResponses[keyof ListEmbedTokensResponses];
31676
- export type CreateEmbedTokenData = {
31677
30725
  body: {
31678
30726
  /**
31679
- * Set true to also return a hosted chat URL with a single-use credential valid for 60 seconds. Defaults to false; the agent must have an identity_number.
31680
- */
31681
- hosted?: boolean;
31682
- /**
31683
- * Service agent ID or identity_number from agent retrieval; it must belong to your organization and be active.
31684
- */
31685
- agent: string;
31686
- /**
31687
- * Existing agent version to pin. Omit to pin the latest version at issuance.
31688
- */
31689
- version?: number;
31690
- /**
31691
- * Your application's stable end-user identifier, scoped to this organization and agent.
31692
- */
31693
- external_user_id: string;
31694
- /**
31695
- * Token lifetime in seconds. Defaults to the embed policy TTL and cannot exceed its maximum or 3600 seconds.
31696
- */
31697
- ttl_seconds?: number;
31698
- /**
31699
- * Session budget in cents. Defaults to the embed policy session budget and cannot exceed its maximum.
31700
- */
31701
- budget_cents?: number;
31702
- /**
31703
- * Optional host context as text blocks, limited to 8192 UTF-8 bytes in total.
30727
+ * The grant code your backend received from grant_codes. It works once.
31704
30728
  */
31705
- system_message?: Array<{
31706
- /**
31707
- * The text block kind; text is the only supported kind.
31708
- */
31709
- type: 'text';
31710
- /**
31711
- * Host context text. All blocks together must fit within 8192 UTF-8 bytes.
31712
- */
31713
- text: string;
31714
- }>;
30729
+ grant_code: string;
30730
+ } | {
31715
30731
  /**
31716
- * Optional system prompt override, accepted only when the embed policy allows agent overrides.
30732
+ * The agent's publishable key, for a visitor who has not signed in. Creates a new anonymous customer.
31717
30733
  */
31718
- agent_override?: {
31719
- /**
31720
- * Replacement system prompt, or null to clear it for this grant.
31721
- */
31722
- system: string | null;
31723
- };
30734
+ publishable_key: string;
30735
+ };
30736
+ headers?: {
31724
30737
  /**
31725
- * Optional subset of the policy origin entries, compared exactly. Omit to snapshot every policy origin.
30738
+ * Browser page origin. Required for publishable_key and for a grant code bound to an origin; it must be in the agent's allowed_origins.
31726
30739
  */
31727
- allowed_origins?: Array<string>;
30740
+ Origin?: string;
30741
+ };
30742
+ path: {
31728
30743
  /**
31729
- * Host metadata preserved verbatim; at most 16 keys of 1–64 characters and string values of at most 512 characters. Defaults to an empty object.
30744
+ * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31730
30745
  */
31731
- metadata?: {
31732
- [key: string]: string;
31733
- };
30746
+ agent_id: string;
31734
30747
  };
31735
- path?: never;
31736
30748
  query?: never;
31737
- url: '/agent/v1/embed_tokens';
30749
+ url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens';
31738
30750
  };
31739
- export type CreateEmbedTokenErrors = {
30751
+ export type CreateCustomerAccessTokenErrors = {
31740
30752
  /**
31741
- * Request fields exceed policy limits, the policy or its environment is unavailable, or a hosted agent has no identity_number. Configure the policy or correct the reported field.
30753
+ * INVALID_PARAMS: send exactly one of grant_code or publishable_key, nothing else.
31742
30754
  */
31743
30755
  400: unknown;
31744
30756
  /**
31745
- * A valid host credential is required; authenticate with your backend API key.
30757
+ * GRANT_CODE_INVALID: the code is unknown, already used, expired or for another agent (one answer for all four); request a new grant code from your backend. UNAUTHENTICATED: the publishable key is unknown, disabled or for another agent.
31746
30758
  */
31747
30759
  401: unknown;
31748
30760
  /**
31749
- * The end user is blocked by the embed policy; contact the agent owner.
30761
+ * EMBED_BUDGET_EXHAUSTED: the publishable key's daily spending cap is reached; wait for the UTC reset or ask the owner to raise it.
30762
+ */
30763
+ 402: unknown;
30764
+ /**
30765
+ * ORIGIN_NOT_ALLOWED or EMBED_ORIGIN_NOT_ALLOWED: call from the origin the code was issued for, or from one in the agent's allowed_origins. CUSTOMER_BLOCKED: the merchant blocked this customer.
31750
30766
  */
31751
30767
  403: unknown;
31752
30768
  /**
31753
- * The service agent or requested version is unavailable to this caller; check the agent identifier and version.
30769
+ * EMBED_RATE_LIMITED: the per-IP minute limit or the key's daily session cap is reached; wait for Retry-After or the UTC reset.
31754
30770
  */
31755
- 404: unknown;
30771
+ 429: unknown;
31756
30772
  /**
31757
- * Token issuance is unavailable; no usable credential was returned.
30773
+ * Issuance or rate limiting is unavailable; retry later with a new grant code if this one expires.
31758
30774
  */
31759
- 502: unknown;
30775
+ 503: unknown;
31760
30776
  };
31761
- export type CreateEmbedTokenResponses = {
30777
+ export type CreateCustomerAccessTokenResponses = {
31762
30778
  /**
31763
- * Issued end-user token and its grant identifier and expiration.
30779
+ * A customer access token, its expiry and the end of the sign-in.
31764
30780
  */
31765
30781
  201: {
31766
30782
  /**
31767
- * Hosted chat link, returned only when hosted is true. Redirect the user here within 60 seconds; its fragment credential can be exchanged only once.
30783
+ * Object type, always customer_access_token.
31768
30784
  */
31769
- hosted_url?: string;
30785
+ type: 'customer_access_token';
31770
30786
  /**
31771
- * Grant identifier with the emb_ prefix, identifying this issuance.
30787
+ * Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
31772
30788
  */
31773
- id: string;
30789
+ access_token: string;
31774
30790
  /**
31775
- * Short-lived end-user credential to pass to your frontend; keep the host API key on your backend.
30791
+ * RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
31776
30792
  */
31777
- token: string;
30793
+ expires_at: string;
31778
30794
  /**
31779
- * Token expiration as an ISO 8601 UTC timestamp, as issued by identity.
30795
+ * RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
31780
30796
  */
31781
- expires_at: string;
30797
+ session_expires_at: string;
30798
+ /**
30799
+ * The customer this token acts for.
30800
+ */
30801
+ customer: {
30802
+ /**
30803
+ * The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
30804
+ */
30805
+ id: string;
30806
+ /**
30807
+ * identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
30808
+ */
30809
+ type: 'identified' | 'anonymous';
30810
+ };
31782
30811
  };
31783
30812
  };
31784
- export type CreateEmbedTokenResponse = CreateEmbedTokenResponses[keyof CreateEmbedTokenResponses];
31785
- export type RevokeEmbedTokenData = {
30813
+ export type CreateCustomerAccessTokenResponse = CreateCustomerAccessTokenResponses[keyof CreateCustomerAccessTokenResponses];
30814
+ export type RenewCustomerAccessTokenData = {
31786
30815
  body?: never;
31787
30816
  path: {
31788
30817
  /**
31789
- * Grant id returned by issuance or listing.
30818
+ * Service agent id (agent_…) or its short identity number, from agent creation or listing.
31790
30819
  */
31791
- id: string;
30820
+ agent_id: string;
31792
30821
  };
31793
30822
  query?: never;
31794
- url: '/agent/v1/embed_tokens/{id}/revoke';
30823
+ url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/renew';
31795
30824
  };
31796
- export type RevokeEmbedTokenErrors = {
31797
- /**
31798
- * Invalid filter, limit or cursor; reuse the cursor with its original filters.
31799
- */
31800
- 400: unknown;
30825
+ export type RenewCustomerAccessTokenErrors = {
31801
30826
  /**
31802
- * Authenticate with a host credential.
30827
+ * ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at. CUSTOMER_SESSION_EXPIRED: less than 60 seconds of the sign-in remain; sign in again: request a new grant code from your backend.
31803
30828
  */
31804
30829
  401: unknown;
31805
30830
  /**
31806
- * 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.
30831
+ * CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
31807
30832
  */
31808
- 403: AgentError;
30833
+ 403: unknown;
31809
30834
  /**
31810
- * The grant is missing or belongs to another organization, or the caller is an end user.
30835
+ * The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
31811
30836
  */
31812
30837
  404: unknown;
31813
- /**
31814
- * Upstream revocation failed; the record remains unrevoked and the request may be retried.
31815
- */
31816
- 502: unknown;
31817
30838
  };
31818
- export type RevokeEmbedTokenError = RevokeEmbedTokenErrors[keyof RevokeEmbedTokenErrors];
31819
- export type RevokeEmbedTokenResponses = {
30839
+ export type RenewCustomerAccessTokenResponses = {
31820
30840
  /**
31821
- * Revoked issuance record, including its original revocation time on repeated calls.
30841
+ * A new access token in the same sign-in. The presented token stays valid until its own expiry.
31822
30842
  */
31823
- 200: {
31824
- /**
31825
- * Grant identifier returned by embed token creation.
31826
- */
31827
- id: string;
31828
- /**
31829
- * Type tag of the object.
31830
- */
31831
- type: 'embed_token';
31832
- /**
31833
- * Service agent identifier.
31834
- */
31835
- agent_id: string;
31836
- /**
31837
- * Pinned agent version.
31838
- */
31839
- agent_version: number;
30843
+ 201: {
31840
30844
  /**
31841
- * Exact host user identifier supplied at issuance.
30845
+ * Object type, always customer_access_token.
31842
30846
  */
31843
- external_user_id: string;
30847
+ type: 'customer_access_token';
31844
30848
  /**
31845
- * Issuance time in RFC 3339 format.
30849
+ * Bearer credential for this agent's sessions on behalf of the customer. Renew it before expires_at.
31846
30850
  */
31847
- created_at: string;
30851
+ access_token: string;
31848
30852
  /**
31849
- * Expiration time in RFC 3339 format.
30853
+ * RFC 3339 expiry of this access token: at most two hours after issue and never after session_expires_at.
31850
30854
  */
31851
30855
  expires_at: string;
31852
30856
  /**
31853
- * Revocation time in RFC 3339 format, or null while not revoked.
31854
- */
31855
- revoked_at: string | null;
31856
- /**
31857
- * Host origin recorded at issuance, or null when absent.
30857
+ * RFC 3339 end of the sign-in. Renewal stops working here; the customer signs in again with a new grant code.
31858
30858
  */
31859
- host_origin: string | null;
30859
+ session_expires_at: string;
31860
30860
  /**
31861
- * User or API key that issued the token.
30861
+ * The customer this token acts for.
31862
30862
  */
31863
- issued_by: {
30863
+ customer: {
31864
30864
  /**
31865
- * user identifies a signed-in organization member; api_key identifies the issuing API key.
30865
+ * The customer id: your customer_id, or anon_ followed by 16 characters for an anonymous customer.
31866
30866
  */
31867
- type: 'user' | 'api_key';
30867
+ id: string;
31868
30868
  /**
31869
- * Identifier of the object, as returned by the API; pass it in the path of follow-up calls on the same resource.
30869
+ * identified: signed in through a grant code from your backend. anonymous: a visitor admitted with the publishable key.
31870
30870
  */
31871
- id: string;
30871
+ type: 'identified' | 'anonymous';
31872
30872
  };
31873
30873
  };
31874
30874
  };
31875
- export type RevokeEmbedTokenResponse = RevokeEmbedTokenResponses[keyof RevokeEmbedTokenResponses];
30875
+ export type RenewCustomerAccessTokenResponse = RenewCustomerAccessTokenResponses[keyof RenewCustomerAccessTokenResponses];
30876
+ export type DeleteCurrentCustomerAccessTokenData = {
30877
+ body?: never;
30878
+ path: {
30879
+ /**
30880
+ * Service agent id (agent_…) or its short identity number, from agent creation or listing.
30881
+ */
30882
+ agent_id: string;
30883
+ };
30884
+ query?: never;
30885
+ url: '/agent/v1/agents/{agent_id}/customers/auth/access_tokens/current';
30886
+ };
30887
+ export type DeleteCurrentCustomerAccessTokenErrors = {
30888
+ /**
30889
+ * ACCESS_TOKEN_REVOKED: the token or its sign-in was revoked (logout, merge, or revocation by the merchant); sign the customer in again with a new grant code. Other 401 responses mean the Bearer token is missing, invalid or expired; renew before expires_at.
30890
+ */
30891
+ 401: unknown;
30892
+ /**
30893
+ * CUSTOMER_BLOCKED: the merchant blocked this customer; unblock them before signing them in. ORIGIN_NOT_ALLOWED: the request Origin is not the origin this sign-in is bound to, or is not in the agent's allowed_origins; call from the page that signed in.
30894
+ */
30895
+ 403: unknown;
30896
+ /**
30897
+ * The token belongs to another agent, is not a customer access token, or the agent is archived or absent; use the agent_id the token was issued for.
30898
+ */
30899
+ 404: unknown;
30900
+ };
30901
+ export type DeleteCurrentCustomerAccessTokenResponses = {
30902
+ /**
30903
+ * Logged out: the sign-in and every access token in it are revoked, and their live event streams close.
30904
+ */
30905
+ 204: void;
30906
+ };
30907
+ export type DeleteCurrentCustomerAccessTokenResponse = DeleteCurrentCustomerAccessTokenResponses[keyof DeleteCurrentCustomerAccessTokenResponses];
31876
30908
  export type ComputersListData = {
31877
30909
  body?: never;
31878
30910
  path?: never;
@@ -37529,127 +36561,27 @@ export type GetSessionCompactionResponses = {
37529
36561
  * State of the compaction operation: queued and running are in progress, skipped means nothing needed compaction, succeeded and failed are final.
37530
36562
  */
37531
36563
  status: 'queued' | 'running' | 'skipped' | 'succeeded' | 'failed';
37532
- /**
37533
- * Why the compaction was skipped or failed; absent otherwise.
37534
- */
37535
- reason?: string;
37536
- };
37537
- };
37538
- export type GetSessionCompactionResponse = GetSessionCompactionResponses[keyof GetSessionCompactionResponses];
37539
- export type ListSessionCompactionsData = {
37540
- body?: never;
37541
- path: {
37542
- /**
37543
- * Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
37544
- */
37545
- session_id: string;
37546
- };
37547
- query?: never;
37548
- url: '/agent/v1/sessions/{session_id}/compactions';
37549
- };
37550
- export type ListSessionCompactionsErrors = {
37551
- /**
37552
- * Authentication required
37553
- */
37554
- 401: unknown;
37555
- /**
37556
- * 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.
37557
- */
37558
- 403: AgentError;
37559
- /**
37560
- * Session not found
37561
- */
37562
- 404: unknown;
37563
- /**
37564
- * Agent service failed
37565
- */
37566
- 502: unknown;
37567
- /**
37568
- * Agent service unavailable
37569
- */
37570
- 503: unknown;
37571
- };
37572
- export type ListSessionCompactionsError = ListSessionCompactionsErrors[keyof ListSessionCompactionsErrors];
37573
- export type ListSessionCompactionsResponses = {
37574
- /**
37575
- * Compaction history
37576
- */
37577
- 200: {
37578
- /**
37579
- * Items of this page, in the order requested by the call.
37580
- */
37581
- data: Array<{
37582
- /**
37583
- * Always `context_compaction`. Record of one past compaction.
37584
- */
37585
- type: 'context_compaction';
37586
- /**
37587
- * Compaction record id.
37588
- */
37589
- id: string;
37590
- /**
37591
- * Id of the agent.thread_context_compacted event emitted for this compaction; null when none.
37592
- */
37593
- event_id: string | null;
37594
- /**
37595
- * What started the compaction.
37596
- */
37597
- trigger: 'auto' | 'manual' | 'model_downshift';
37598
- /**
37599
- * Final outcome of the compaction.
37600
- */
37601
- status: 'succeeded' | 'failed';
37602
- /**
37603
- * Model that wrote the summary.
37604
- */
37605
- model: string;
37606
- /**
37607
- * Number of messages replaced by the summary.
37608
- */
37609
- compacted_message_count: number;
37610
- /**
37611
- * Context tokens before the compaction.
37612
- */
37613
- input_tokens_before: number;
37614
- /**
37615
- * Context tokens after the compaction; null when not measured.
37616
- */
37617
- input_tokens_after: number | null;
37618
- /**
37619
- * Summary text that replaced the messages; null when the compaction failed.
37620
- */
37621
- summary: string | null;
37622
- /**
37623
- * Failure reason; null when the compaction succeeded.
37624
- */
37625
- error: string | null;
37626
- /**
37627
- * RFC 3339 time at which the compaction was recorded.
37628
- */
37629
- created_at: string;
37630
- }>;
36564
+ /**
36565
+ * Why the compaction was skipped or failed; absent otherwise.
36566
+ */
36567
+ reason?: string;
37631
36568
  };
37632
36569
  };
37633
- export type ListSessionCompactionsResponse = ListSessionCompactionsResponses[keyof ListSessionCompactionsResponses];
37634
- export type GetEmbedAppearanceData = {
36570
+ export type GetSessionCompactionResponse = GetSessionCompactionResponses[keyof GetSessionCompactionResponses];
36571
+ export type ListSessionCompactionsData = {
37635
36572
  body?: never;
37636
- headers?: {
36573
+ path: {
37637
36574
  /**
37638
- * Active public key from the agent's console embed settings; alternative to an end-user Bearer token.
36575
+ * Session id (sesn_...), as returned by sessions.create or sessions.list. The same id is also accepted as the session_id query parameter on resource and thread calls, where it must equal the path value.
37639
36576
  */
37640
- 'Praxis-Publishable-Key'?: string;
36577
+ session_id: string;
37641
36578
  };
37642
- path?: never;
37643
36579
  query?: never;
37644
- url: '/agent/v1/embed/appearance';
36580
+ url: '/agent/v1/sessions/{session_id}/compactions';
37645
36581
  };
37646
- export type GetEmbedAppearanceErrors = {
37647
- /**
37648
- * Addressing parameters are not accepted; remove identity_number, agent_id and other query parameters.
37649
- */
37650
- 400: unknown;
36582
+ export type ListSessionCompactionsErrors = {
37651
36583
  /**
37652
- * Supply a valid embed token or an active publishable key; organization member credentials cannot read this surface.
36584
+ * Authentication required
37653
36585
  */
37654
36586
  401: unknown;
37655
36587
  /**
@@ -37657,217 +36589,80 @@ export type GetEmbedAppearanceErrors = {
37657
36589
  */
37658
36590
  403: AgentError;
37659
36591
  /**
37660
- * The credential's service agent is absent or archived; obtain credentials for an active service agent.
36592
+ * Session not found
37661
36593
  */
37662
36594
  404: unknown;
37663
36595
  /**
37664
- * Appearance is temporarily unavailable; use default appearance and continue the conversation.
36596
+ * Agent service failed
36597
+ */
36598
+ 502: unknown;
36599
+ /**
36600
+ * Agent service unavailable
37665
36601
  */
37666
36602
  503: unknown;
37667
36603
  };
37668
- export type GetEmbedAppearanceError = GetEmbedAppearanceErrors[keyof GetEmbedAppearanceErrors];
37669
- export type GetEmbedAppearanceResponses = {
36604
+ export type ListSessionCompactionsError = ListSessionCompactionsErrors[keyof ListSessionCompactionsErrors];
36605
+ export type ListSessionCompactionsResponses = {
37670
36606
  /**
37671
- * Saved Kit options, at most 8192 UTF-8 JSON bytes. Omitted groups use Kit defaults; an unconfigured agent returns an empty object.
36607
+ * Compaction history
37672
36608
  */
37673
36609
  200: {
37674
36610
  /**
37675
- * Public identity displayed on the chat page, independent of the internal agent name.
37676
- */
37677
- agent?: {
37678
- /**
37679
- * Display name; omission keeps the neutral browser-language default.
37680
- */
37681
- name?: string;
37682
- /**
37683
- * Optional HTTPS avatar image URL; non-HTTPS images are rejected.
37684
- */
37685
- avatar?: string;
37686
- };
37687
- /**
37688
- * 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.
37689
- */
37690
- layout?: 'inline' | 'sidebar' | 'popup' | 'modal';
37691
- /**
37692
- * Default entry button for the loader; an explicit script data-launcher takes precedence.
37693
- */
37694
- launcher?: {
37695
- /**
37696
- * 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.
37697
- */
37698
- type: 'none' | 'bubble' | 'mascot';
37699
- /**
37700
- * Mascot images: exactly one of preset or images. Send pack, not image.
37701
- */
37702
- pack?: {
37703
- /**
37704
- * Built-in character: mint (mint support girl), cat (cat-eared girl) or bot (small robot).
37705
- */
37706
- preset?: 'mint' | 'cat' | 'bot';
37707
- /**
37708
- * 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.
37709
- */
37710
- images?: {
37711
- /**
37712
- * Resting state.
37713
- */
37714
- idle: string;
37715
- /**
37716
- * Page open and while the greeting bubble shows.
37717
- */
37718
- greet?: string;
37719
- /**
37720
- * The visitor is typing in the composer.
37721
- */
37722
- listening?: string;
37723
- /**
37724
- * After the visitor sends, before the first reply text.
37725
- */
37726
- thinking?: string;
37727
- /**
37728
- * While the reply streams; alternates with talking-2 every 220 ms.
37729
- */
37730
- talking?: string;
37731
- /**
37732
- * Second mouth frame of talking, mouth closed; without it talking alternates with idle.
37733
- */
37734
- 'talking-2'?: string;
37735
- /**
37736
- * The last turn failed or was refused.
37737
- */
37738
- sorry?: string;
37739
- /**
37740
- * No interaction for 60 seconds; hover or click wakes the mascot.
37741
- */
37742
- sleep?: string;
37743
- };
37744
- };
37745
- /**
37746
- * Legacy single mascot image, read as pack.images.idle. When pack is present, pack wins.
37747
- */
37748
- image?: string;
37749
- /**
37750
- * float (default) gently floats the mascot, bounces on hover and waves with the greeting; none keeps it still. Reduced-motion settings always win.
37751
- */
37752
- motion?: 'float' | 'none';
37753
- /**
37754
- * Launcher corner: bottom-right is the default; bottom-left uses the opposite corner.
37755
- */
37756
- position?: 'bottom-right' | 'bottom-left';
37757
- /**
37758
- * Accessible entry button label and bubble text; omission uses the default chat label.
37759
- */
37760
- label?: string;
37761
- };
37762
- /**
37763
- * Visible chat heading; omitted title uses the public agent name.
37764
- */
37765
- header?: {
37766
- /**
37767
- * Optional heading text shown instead of the public agent name.
37768
- */
37769
- title?: string;
37770
- /**
37771
- * Optional secondary line beneath the heading.
37772
- */
37773
- subtitle?: string;
37774
- /**
37775
- * Optional HTTPS image shown in the heading avatar position.
37776
- */
37777
- icon?: string;
37778
- };
37779
- /**
37780
- * Visual tokens applied to the conversation and header; omitted fields use Kit defaults.
36611
+ * Items of this page, in the order requested by the call.
37781
36612
  */
37782
- theme?: {
36613
+ data: Array<{
37783
36614
  /**
37784
- * light or dark selects a fixed scheme; system follows the device preference.
36615
+ * Always `context_compaction`. Record of one past compaction.
37785
36616
  */
37786
- colorScheme?: 'light' | 'dark' | 'system';
36617
+ type: 'context_compaction';
37787
36618
  /**
37788
- * Explicit opaque CSS accent color, for example #167A43.
36619
+ * Compaction record id.
37789
36620
  */
37790
- accent?: string;
36621
+ id: string;
37791
36622
  /**
37792
- * Explicit opaque CSS background color, for example #ffffff.
36623
+ * Id of the agent.thread_context_compacted event emitted for this compaction; null when none.
37793
36624
  */
37794
- surface?: string;
36625
+ event_id: string | null;
37795
36626
  /**
37796
- * neutral uses grayscale surfaces, warm uses warm tones, cool uses cool tones.
36627
+ * What started the compaction.
37797
36628
  */
37798
- grayscale?: 'neutral' | 'warm' | 'cool';
36629
+ trigger: 'auto' | 'manual' | 'model_downshift';
37799
36630
  /**
37800
- * Corner rounding: none is square, sm is small, md is medium, lg is large, full is fully rounded.
36631
+ * Final outcome of the compaction.
37801
36632
  */
37802
- radius?: 'none' | 'sm' | 'md' | 'lg' | 'full';
36633
+ status: 'succeeded' | 'failed';
37803
36634
  /**
37804
- * Spacing: compact reduces gaps, normal uses defaults, spacious increases gaps.
36635
+ * Model that wrote the summary.
37805
36636
  */
37806
- density?: 'compact' | 'normal' | 'spacious';
36637
+ model: string;
37807
36638
  /**
37808
- * CSS font family list using fonts available on the device; external font loading is not configured here.
36639
+ * Number of messages replaced by the summary.
37809
36640
  */
37810
- fontFamily?: string;
36641
+ compacted_message_count: number;
37811
36642
  /**
37812
- * Positive base font size in CSS pixels; omission preserves Kit sizing.
36643
+ * Context tokens before the compaction.
37813
36644
  */
37814
- fontSize?: number;
37815
- };
37816
- /**
37817
- * Reserved Kit locale preference: zh for Chinese, en for English. Kit currently passes this option through without translating all controls.
37818
- */
37819
- locale?: 'zh' | 'en';
37820
- /**
37821
- * Content displayed before the first message in a conversation.
37822
- */
37823
- startScreen?: {
36645
+ input_tokens_before: number;
37824
36646
  /**
37825
- * Optional welcome text on the empty conversation.
36647
+ * Context tokens after the compaction; null when not measured.
37826
36648
  */
37827
- greeting?: string;
36649
+ input_tokens_after: number | null;
37828
36650
  /**
37829
- * Up to four suggested questions; clicking a label sends its prompt text.
36651
+ * Summary text that replaced the messages; null when the compaction failed.
37830
36652
  */
37831
- prompts?: Array<{
37832
- /**
37833
- * Visible suggested-question button text.
37834
- */
37835
- label: string;
37836
- /**
37837
- * User message sent when this suggestion is selected.
37838
- */
37839
- prompt: string;
37840
- }>;
37841
- };
37842
- /**
37843
- * Message input appearance; transport and attachment settings are excluded.
37844
- */
37845
- composer?: {
36653
+ summary: string | null;
37846
36654
  /**
37847
- * Hint shown when the message input is empty.
36655
+ * Failure reason; null when the compaction succeeded.
37848
36656
  */
37849
- placeholder?: string;
37850
- };
37851
- /**
37852
- * Optional notice displayed beside the conversation composer.
37853
- */
37854
- disclaimer?: string;
37855
- /**
37856
- * Optional text below the conversation.
37857
- */
37858
- footer?: string;
37859
- /**
37860
- * Availability of the conversation history control.
37861
- */
37862
- history?: {
36657
+ error: string | null;
37863
36658
  /**
37864
- * False hides history; omission uses the default enabled state.
36659
+ * RFC 3339 time at which the compaction was recorded.
37865
36660
  */
37866
- enabled?: boolean;
37867
- };
36661
+ created_at: string;
36662
+ }>;
37868
36663
  };
37869
36664
  };
37870
- export type GetEmbedAppearanceResponse = GetEmbedAppearanceResponses[keyof GetEmbedAppearanceResponses];
36665
+ export type ListSessionCompactionsResponse = ListSessionCompactionsResponses[keyof ListSessionCompactionsResponses];
37871
36666
  export type CreateAudioSpeechData = {
37872
36667
  body: unknown & {
37873
36668
  /**
@@ -44196,7 +42991,7 @@ export type ListOrganizationCostsResponses = {
44196
42991
  */
44197
42992
  ResourceName?: string;
44198
42993
  /**
44199
- * Decimal string in BillingCurrency.
42994
+ * Amount in BillingCurrency: US dollars for USD, decimal string, 6 decimals.
44200
42995
  */
44201
42996
  BilledCost: string;
44202
42997
  /**
@@ -44414,7 +43209,7 @@ export type ListOrganizationEventsResponses = {
44414
43209
  */
44415
43210
  ResourceName: string;
44416
43211
  /**
44417
- * Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles.
43212
+ * 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.
44418
43213
  */
44419
43214
  BilledCost: string;
44420
43215
  /**
@@ -44438,7 +43233,7 @@ export type ListOrganizationEventsResponses = {
44438
43233
  */
44439
43234
  status: 'settled' | 'no_charge' | 'rejected';
44440
43235
  /**
44441
- * USD amount that could not be charged, as a decimal string, when status is settled_with_shortfall; null otherwise.
43236
+ * Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
44442
43237
  */
44443
43238
  shortfall: string | null;
44444
43239
  /**
@@ -44535,7 +43330,7 @@ export type GetOrganizationEventResponses = {
44535
43330
  */
44536
43331
  ResourceName: string;
44537
43332
  /**
44538
- * Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles.
43333
+ * 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.
44539
43334
  */
44540
43335
  BilledCost: string;
44541
43336
  /**
@@ -44559,7 +43354,7 @@ export type GetOrganizationEventResponses = {
44559
43354
  */
44560
43355
  status: 'settled' | 'no_charge' | 'rejected';
44561
43356
  /**
44562
- * USD amount that could not be charged, as a decimal string, when status is settled_with_shortfall; null otherwise.
43357
+ * Amount that could not be charged: US dollars, decimal string, 6 decimals, when status is settled_with_shortfall; null otherwise.
44563
43358
  */
44564
43359
  shortfall: string | null;
44565
43360
  /**
@@ -44596,7 +43391,7 @@ export type GetOrganizationEventResponses = {
44596
43391
  */
44597
43392
  PricingUnit: string | null;
44598
43393
  /**
44599
- * Amount billed for this line in USD as a decimal string.
43394
+ * Amount billed for this line: US dollars for USD (otherwise BillingCurrency), decimal string, 6 decimals (for example `0.001700`).
44600
43395
  */
44601
43396
  BilledCost: string;
44602
43397
  }>;
@@ -44609,7 +43404,7 @@ export type GetOrganizationEventResponses = {
44609
43404
  */
44610
43405
  transaction_id: string;
44611
43406
  /**
44612
- * Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles.
43407
+ * 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.
44613
43408
  */
44614
43409
  BilledCost: string;
44615
43410
  /**
@@ -44663,7 +43458,7 @@ export type ExportOrganizationChargesResponses = {
44663
43458
  */
44664
43459
  ChargePeriodEnd: string;
44665
43460
  /**
44666
- * Amount billed in USD as an exact decimal string; unsettled usage counts as 0 until it settles.
43461
+ * 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.
44667
43462
  */
44668
43463
  BilledCost: string;
44669
43464
  /**
@@ -46198,7 +44993,7 @@ export type AgentsListResponses = {
46198
44993
  */
46199
44994
  note: string | null;
46200
44995
  /**
46201
- * 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.
44996
+ * 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.
46202
44997
  */
46203
44998
  bindings: Array<{
46204
44999
  /**
@@ -46217,6 +45012,10 @@ export type AgentsListResponses = {
46217
45012
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
46218
45013
  */
46219
45014
  instructions?: string;
45015
+ /**
45016
+ * 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.
45017
+ */
45018
+ readonly verified?: boolean;
46220
45019
  /**
46221
45020
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
46222
45021
  */
@@ -46226,6 +45025,10 @@ export type AgentsListResponses = {
46226
45025
  * Service type. Opens the whole service to codemode; there is no per-resource id.
46227
45026
  */
46228
45027
  type: 'search' | 'browser';
45028
+ /**
45029
+ * 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.
45030
+ */
45031
+ readonly verified?: boolean;
46229
45032
  /**
46230
45033
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
46231
45034
  */
@@ -46702,7 +45505,7 @@ export type AgentsCreateData = {
46702
45505
  */
46703
45506
  tools?: Array<AgentManaged15 | AgentManaged29 | AgentManaged32>;
46704
45507
  /**
46705
- * 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.
45508
+ * 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.
46706
45509
  */
46707
45510
  bindings?: Array<{
46708
45511
  /**
@@ -46721,6 +45524,10 @@ export type AgentsCreateData = {
46721
45524
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
46722
45525
  */
46723
45526
  instructions?: string;
45527
+ /**
45528
+ * 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.
45529
+ */
45530
+ readonly verified?: boolean;
46724
45531
  /**
46725
45532
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
46726
45533
  */
@@ -46730,6 +45537,10 @@ export type AgentsCreateData = {
46730
45537
  * Service type. Opens the whole service to codemode; there is no per-resource id.
46731
45538
  */
46732
45539
  type: 'search' | 'browser';
45540
+ /**
45541
+ * 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.
45542
+ */
45543
+ readonly verified?: boolean;
46733
45544
  /**
46734
45545
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
46735
45546
  */
@@ -47267,7 +46078,7 @@ export type AgentsCreateResponses = {
47267
46078
  */
47268
46079
  note: string | null;
47269
46080
  /**
47270
- * 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.
46081
+ * 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.
47271
46082
  */
47272
46083
  bindings: Array<{
47273
46084
  /**
@@ -47286,6 +46097,10 @@ export type AgentsCreateResponses = {
47286
46097
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
47287
46098
  */
47288
46099
  instructions?: string;
46100
+ /**
46101
+ * 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.
46102
+ */
46103
+ readonly verified?: boolean;
47289
46104
  /**
47290
46105
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
47291
46106
  */
@@ -47295,6 +46110,10 @@ export type AgentsCreateResponses = {
47295
46110
  * Service type. Opens the whole service to codemode; there is no per-resource id.
47296
46111
  */
47297
46112
  type: 'search' | 'browser';
46113
+ /**
46114
+ * 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.
46115
+ */
46116
+ readonly verified?: boolean;
47298
46117
  /**
47299
46118
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
47300
46119
  */
@@ -47855,7 +46674,7 @@ export type AgentsRetrieveResponses = {
47855
46674
  */
47856
46675
  note: string | null;
47857
46676
  /**
47858
- * 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.
46677
+ * 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.
47859
46678
  */
47860
46679
  bindings: Array<{
47861
46680
  /**
@@ -47874,6 +46693,10 @@ export type AgentsRetrieveResponses = {
47874
46693
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
47875
46694
  */
47876
46695
  instructions?: string;
46696
+ /**
46697
+ * 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.
46698
+ */
46699
+ readonly verified?: boolean;
47877
46700
  /**
47878
46701
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
47879
46702
  */
@@ -47883,6 +46706,10 @@ export type AgentsRetrieveResponses = {
47883
46706
  * Service type. Opens the whole service to codemode; there is no per-resource id.
47884
46707
  */
47885
46708
  type: 'search' | 'browser';
46709
+ /**
46710
+ * 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.
46711
+ */
46712
+ readonly verified?: boolean;
47886
46713
  /**
47887
46714
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
47888
46715
  */
@@ -48390,6 +47217,10 @@ export type AgentsUpdateData = {
48390
47217
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
48391
47218
  */
48392
47219
  instructions?: string;
47220
+ /**
47221
+ * 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.
47222
+ */
47223
+ readonly verified?: boolean;
48393
47224
  /**
48394
47225
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
48395
47226
  */
@@ -48399,6 +47230,10 @@ export type AgentsUpdateData = {
48399
47230
  * Service type. Opens the whole service to codemode; there is no per-resource id.
48400
47231
  */
48401
47232
  type: 'search' | 'browser';
47233
+ /**
47234
+ * 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.
47235
+ */
47236
+ readonly verified?: boolean;
48402
47237
  /**
48403
47238
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
48404
47239
  */
@@ -48945,7 +47780,7 @@ export type AgentsUpdateResponses = {
48945
47780
  */
48946
47781
  note: string | null;
48947
47782
  /**
48948
- * 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.
47783
+ * 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.
48949
47784
  */
48950
47785
  bindings: Array<{
48951
47786
  /**
@@ -48964,6 +47799,10 @@ export type AgentsUpdateResponses = {
48964
47799
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
48965
47800
  */
48966
47801
  instructions?: string;
47802
+ /**
47803
+ * 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.
47804
+ */
47805
+ readonly verified?: boolean;
48967
47806
  /**
48968
47807
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
48969
47808
  */
@@ -48973,6 +47812,10 @@ export type AgentsUpdateResponses = {
48973
47812
  * Service type. Opens the whole service to codemode; there is no per-resource id.
48974
47813
  */
48975
47814
  type: 'search' | 'browser';
47815
+ /**
47816
+ * 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.
47817
+ */
47818
+ readonly verified?: boolean;
48976
47819
  /**
48977
47820
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
48978
47821
  */
@@ -49523,7 +48366,7 @@ export type AgentsArchiveResponses = {
49523
48366
  */
49524
48367
  note: string | null;
49525
48368
  /**
49526
- * 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.
48369
+ * 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.
49527
48370
  */
49528
48371
  bindings: Array<{
49529
48372
  /**
@@ -49542,6 +48385,10 @@ export type AgentsArchiveResponses = {
49542
48385
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
49543
48386
  */
49544
48387
  instructions?: string;
48388
+ /**
48389
+ * 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.
48390
+ */
48391
+ readonly verified?: boolean;
49545
48392
  /**
49546
48393
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
49547
48394
  */
@@ -49551,6 +48398,10 @@ export type AgentsArchiveResponses = {
49551
48398
  * Service type. Opens the whole service to codemode; there is no per-resource id.
49552
48399
  */
49553
48400
  type: 'search' | 'browser';
48401
+ /**
48402
+ * 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.
48403
+ */
48404
+ readonly verified?: boolean;
49554
48405
  /**
49555
48406
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
49556
48407
  */
@@ -50119,7 +48970,7 @@ export type AgentsVersionsListResponses = {
50119
48970
  */
50120
48971
  note: string | null;
50121
48972
  /**
50122
- * 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.
48973
+ * 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.
50123
48974
  */
50124
48975
  bindings: Array<{
50125
48976
  /**
@@ -50138,6 +48989,10 @@ export type AgentsVersionsListResponses = {
50138
48989
  * Optional guidance for using this resource, up to 4096 characters; does not expand access.
50139
48990
  */
50140
48991
  instructions?: string;
48992
+ /**
48993
+ * 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.
48994
+ */
48995
+ readonly verified?: boolean;
50141
48996
  /**
50142
48997
  * Whether this binding grants access. Defaults to true; false immediately disables it for running sessions.
50143
48998
  */
@@ -50147,6 +49002,10 @@ export type AgentsVersionsListResponses = {
50147
49002
  * Service type. Opens the whole service to codemode; there is no per-resource id.
50148
49003
  */
50149
49004
  type: 'search' | 'browser';
49005
+ /**
49006
+ * 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.
49007
+ */
49008
+ readonly verified?: boolean;
50150
49009
  /**
50151
49010
  * Whether the service is open. Defaults to true; false immediately closes it for running sessions.
50152
49011
  */