@letta-ai/letta-client 1.0.0-alpha.17 → 1.0.0-alpha.19

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.
Files changed (140) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/README.md +5 -15
  3. package/client.d.mts +20 -20
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +20 -20
  6. package/client.d.ts.map +1 -1
  7. package/client.js +29 -23
  8. package/client.js.map +1 -1
  9. package/client.mjs +29 -23
  10. package/client.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/agents/agents.d.mts +319 -935
  13. package/resources/agents/agents.d.mts.map +1 -1
  14. package/resources/agents/agents.d.ts +319 -935
  15. package/resources/agents/agents.d.ts.map +1 -1
  16. package/resources/agents/agents.js +12 -4
  17. package/resources/agents/agents.js.map +1 -1
  18. package/resources/agents/agents.mjs +12 -4
  19. package/resources/agents/agents.mjs.map +1 -1
  20. package/resources/agents/archives.d.mts +31 -0
  21. package/resources/agents/archives.d.mts.map +1 -0
  22. package/resources/agents/archives.d.ts +31 -0
  23. package/resources/agents/archives.d.ts.map +1 -0
  24. package/resources/agents/archives.js +24 -0
  25. package/resources/agents/archives.js.map +1 -0
  26. package/resources/agents/archives.mjs +20 -0
  27. package/resources/agents/archives.mjs.map +1 -0
  28. package/resources/agents/folders.d.mts +1 -1
  29. package/resources/agents/folders.d.mts.map +1 -1
  30. package/resources/agents/folders.d.ts +1 -1
  31. package/resources/agents/folders.d.ts.map +1 -1
  32. package/resources/agents/identities.d.mts +31 -0
  33. package/resources/agents/identities.d.mts.map +1 -0
  34. package/resources/agents/identities.d.ts +31 -0
  35. package/resources/agents/identities.d.ts.map +1 -0
  36. package/resources/agents/identities.js +24 -0
  37. package/resources/agents/identities.js.map +1 -0
  38. package/resources/agents/identities.mjs +20 -0
  39. package/resources/agents/identities.mjs.map +1 -0
  40. package/resources/agents/index.d.mts +4 -2
  41. package/resources/agents/index.d.mts.map +1 -1
  42. package/resources/agents/index.d.ts +4 -2
  43. package/resources/agents/index.d.ts.map +1 -1
  44. package/resources/agents/index.js +5 -1
  45. package/resources/agents/index.js.map +1 -1
  46. package/resources/agents/index.mjs +2 -0
  47. package/resources/agents/index.mjs.map +1 -1
  48. package/resources/agents/messages.d.mts +244 -284
  49. package/resources/agents/messages.d.mts.map +1 -1
  50. package/resources/agents/messages.d.ts +244 -284
  51. package/resources/agents/messages.d.ts.map +1 -1
  52. package/resources/agents/messages.js.map +1 -1
  53. package/resources/agents/messages.mjs.map +1 -1
  54. package/resources/archives/archives.d.mts +111 -0
  55. package/resources/archives/archives.d.mts.map +1 -0
  56. package/resources/archives/archives.d.ts +111 -0
  57. package/resources/archives/archives.d.ts.map +1 -0
  58. package/resources/archives/archives.js +50 -0
  59. package/resources/archives/archives.js.map +1 -0
  60. package/resources/archives/archives.mjs +45 -0
  61. package/resources/archives/archives.mjs.map +1 -0
  62. package/resources/archives/index.d.mts +3 -0
  63. package/resources/archives/index.d.mts.map +1 -0
  64. package/resources/archives/index.d.ts +3 -0
  65. package/resources/archives/index.d.ts.map +1 -0
  66. package/resources/archives/index.js +9 -0
  67. package/resources/archives/index.js.map +1 -0
  68. package/resources/archives/index.mjs +4 -0
  69. package/resources/archives/index.mjs.map +1 -0
  70. package/resources/archives/passages.d.mts +112 -0
  71. package/resources/archives/passages.d.mts.map +1 -0
  72. package/resources/archives/passages.d.ts +112 -0
  73. package/resources/archives/passages.d.ts.map +1 -0
  74. package/resources/archives/passages.js +32 -0
  75. package/resources/archives/passages.js.map +1 -0
  76. package/resources/archives/passages.mjs +28 -0
  77. package/resources/archives/passages.mjs.map +1 -0
  78. package/resources/archives.d.mts +1 -106
  79. package/resources/archives.d.mts.map +1 -1
  80. package/resources/archives.d.ts +1 -106
  81. package/resources/archives.d.ts.map +1 -1
  82. package/resources/archives.js +2 -38
  83. package/resources/archives.js.map +1 -1
  84. package/resources/archives.mjs +1 -36
  85. package/resources/archives.mjs.map +1 -1
  86. package/resources/batches/messages.d.mts +3 -3
  87. package/resources/batches/messages.d.mts.map +1 -1
  88. package/resources/batches/messages.d.ts +3 -3
  89. package/resources/batches/messages.d.ts.map +1 -1
  90. package/resources/batches/messages.js.map +1 -1
  91. package/resources/batches/messages.mjs.map +1 -1
  92. package/resources/groups/messages.d.mts +3 -3
  93. package/resources/groups/messages.d.mts.map +1 -1
  94. package/resources/groups/messages.d.ts +3 -3
  95. package/resources/groups/messages.d.ts.map +1 -1
  96. package/resources/groups/messages.js +4 -1
  97. package/resources/groups/messages.js.map +1 -1
  98. package/resources/groups/messages.mjs +4 -1
  99. package/resources/groups/messages.mjs.map +1 -1
  100. package/resources/index.d.mts +2 -2
  101. package/resources/index.d.mts.map +1 -1
  102. package/resources/index.d.ts +2 -2
  103. package/resources/index.d.ts.map +1 -1
  104. package/resources/index.js +1 -1
  105. package/resources/index.js.map +1 -1
  106. package/resources/index.mjs +1 -1
  107. package/resources/index.mjs.map +1 -1
  108. package/resources/runs/messages.d.mts +3 -3
  109. package/resources/runs/messages.d.mts.map +1 -1
  110. package/resources/runs/messages.d.ts +3 -3
  111. package/resources/runs/messages.d.ts.map +1 -1
  112. package/resources/runs/messages.js +4 -1
  113. package/resources/runs/messages.js.map +1 -1
  114. package/resources/runs/messages.mjs +4 -1
  115. package/resources/runs/messages.mjs.map +1 -1
  116. package/resources/steps/steps.d.mts +1 -1
  117. package/resources/steps/steps.d.mts.map +1 -1
  118. package/resources/steps/steps.d.ts +1 -1
  119. package/resources/steps/steps.d.ts.map +1 -1
  120. package/src/client.ts +156 -130
  121. package/src/resources/agents/agents.ts +721 -1527
  122. package/src/resources/agents/archives.ts +51 -0
  123. package/src/resources/agents/folders.ts +1 -1
  124. package/src/resources/agents/identities.ts +51 -0
  125. package/src/resources/agents/index.ts +28 -3
  126. package/src/resources/agents/messages.ts +377 -424
  127. package/src/resources/archives/archives.ts +165 -0
  128. package/src/resources/archives/index.ts +17 -0
  129. package/src/resources/archives/passages.ts +149 -0
  130. package/src/resources/archives.ts +1 -150
  131. package/src/resources/batches/messages.ts +4 -4
  132. package/src/resources/groups/messages.ts +7 -8
  133. package/src/resources/index.ts +11 -1
  134. package/src/resources/runs/messages.ts +7 -8
  135. package/src/resources/steps/steps.ts +1 -1
  136. package/src/version.ts +1 -1
  137. package/version.d.mts +1 -1
  138. package/version.d.ts +1 -1
  139. package/version.js +1 -1
  140. package/version.mjs +1 -1
@@ -2,8 +2,15 @@
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as AgentsAPI from './agents';
5
- import * as ArchivesAPI from '../archives';
6
5
  import * as ToolsAPI from '../tools';
6
+ import * as ArchivesAPI from './archives';
7
+ import {
8
+ ArchiveAttachParams,
9
+ ArchiveAttachResponse,
10
+ ArchiveDetachParams,
11
+ ArchiveDetachResponse,
12
+ Archives,
13
+ } from './archives';
7
14
  import * as BlocksAPI from './blocks';
8
15
  import {
9
16
  Block,
@@ -38,20 +45,28 @@ import {
38
45
  } from './folders';
39
46
  import * as GroupsAPI from './groups';
40
47
  import { GroupListParams, Groups } from './groups';
48
+ import * as IdentitiesAPI from './identities';
49
+ import {
50
+ Identities,
51
+ IdentityAttachParams,
52
+ IdentityAttachResponse,
53
+ IdentityDetachParams,
54
+ IdentityDetachResponse,
55
+ } from './identities';
41
56
  import * as MessagesAPI from './messages';
42
57
  import {
43
58
  ApprovalCreate,
44
59
  ApprovalRequestMessage,
45
60
  ApprovalResponseMessage,
61
+ ApprovalReturn,
46
62
  AssistantMessage,
47
63
  EventMessage,
48
64
  HiddenReasoningMessage,
49
65
  ImageContent,
66
+ InternalMessage,
50
67
  JobStatus,
51
68
  JobType,
52
69
  LettaAssistantMessageContentUnion,
53
- LettaMessageUnion,
54
- LettaMessageUnionsArrayPage,
55
70
  LettaRequest,
56
71
  LettaResponse,
57
72
  LettaStreamingRequest,
@@ -72,6 +87,7 @@ import {
72
87
  MessageStreamParams,
73
88
  MessageType,
74
89
  Messages,
90
+ MessagesArrayPage,
75
91
  OmittedReasoningContent,
76
92
  ReasoningContent,
77
93
  ReasoningMessage,
@@ -94,9 +110,10 @@ import {
94
110
  } from './messages';
95
111
  import * as AgentsToolsAPI from './tools';
96
112
  import { ToolAttachParams, ToolDetachParams, ToolListParams, ToolUpdateApprovalParams, Tools } from './tools';
113
+ import * as ArchivesArchivesAPI from '../archives/archives';
97
114
  import * as BlocksBlocksAPI from '../blocks/blocks';
98
115
  import * as GroupsGroupsAPI from '../groups/groups';
99
- import * as IdentitiesAPI from '../identities/identities';
116
+ import * as IdentitiesIdentitiesAPI from '../identities/identities';
100
117
  import * as ModelsAPI from '../models/models';
101
118
  import * as RunsAPI from '../runs/runs';
102
119
  import { APIPromise } from '../../core/api-promise';
@@ -108,12 +125,14 @@ import { multipartFormRequestOptions } from '../../internal/uploads';
108
125
  import { path } from '../../internal/utils/path';
109
126
 
110
127
  export class Agents extends APIResource {
128
+ messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
129
+ blocks: BlocksAPI.Blocks = new BlocksAPI.Blocks(this._client);
111
130
  tools: AgentsToolsAPI.Tools = new AgentsToolsAPI.Tools(this._client);
112
131
  folders: FoldersAPI.Folders = new FoldersAPI.Folders(this._client);
113
132
  files: FilesAPI.Files = new FilesAPI.Files(this._client);
114
- blocks: BlocksAPI.Blocks = new BlocksAPI.Blocks(this._client);
115
133
  groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
116
- messages: MessagesAPI.Messages = new MessagesAPI.Messages(this._client);
134
+ archives: ArchivesAPI.Archives = new ArchivesAPI.Archives(this._client);
135
+ identities: IdentitiesAPI.Identities = new IdentitiesAPI.Identities(this._client);
117
136
 
118
137
  /**
119
138
  * Create an agent.
@@ -362,7 +381,7 @@ export interface AgentState {
362
381
  /**
363
382
  * The identities associated with this agent.
364
383
  */
365
- identities?: Array<IdentitiesAPI.Identity>;
384
+ identities?: Array<IdentitiesIdentitiesAPI.Identity>;
366
385
 
367
386
  /**
368
387
  * @deprecated Deprecated: Use `identities` field instead. The ids of the
@@ -427,16 +446,16 @@ export interface AgentState {
427
446
  * The model settings used by the agent.
428
447
  */
429
448
  model_settings?:
430
- | AgentState.OpenAIModelSettings
431
- | AgentState.AnthropicModelSettings
432
- | AgentState.GoogleAIModelSettings
433
- | AgentState.GoogleVertexModelSettings
434
- | AgentState.AzureModelSettings
435
- | AgentState.XaiModelSettings
436
- | AgentState.GroqModelSettings
437
- | AgentState.DeepseekModelSettings
438
- | AgentState.TogetherModelSettings
439
- | AgentState.BedrockModelSettings
449
+ | OpenAIModelSettings
450
+ | AnthropicModelSettings
451
+ | GoogleAIModelSettings
452
+ | GoogleVertexModelSettings
453
+ | AzureModelSettings
454
+ | XaiModelSettings
455
+ | GroqModelSettings
456
+ | DeepseekModelSettings
457
+ | TogetherModelSettings
458
+ | BedrockModelSettings
440
459
  | null;
441
460
 
442
461
  /**
@@ -702,431 +721,133 @@ export namespace AgentState {
702
721
  /**
703
722
  * The vector database provider used for this source's passages
704
723
  */
705
- vector_db_provider?: ArchivesAPI.VectorDBProvider;
706
- }
707
-
708
- export interface OpenAIModelSettings {
709
- /**
710
- * The maximum number of tokens the model can generate.
711
- */
712
- max_output_tokens?: number;
713
-
714
- /**
715
- * Whether to enable parallel tool calling.
716
- */
717
- parallel_tool_calls?: boolean;
718
-
719
- /**
720
- * The provider of the model.
721
- */
722
- provider?: 'openai';
723
-
724
- /**
725
- * The reasoning configuration for the model.
726
- */
727
- reasoning?: OpenAIModelSettings.Reasoning;
728
-
729
- /**
730
- * The response format for the model.
731
- */
732
- response_format?:
733
- | AgentsAPI.TextResponseFormat
734
- | AgentsAPI.JsonSchemaResponseFormat
735
- | AgentsAPI.JsonObjectResponseFormat
736
- | null;
737
-
738
- /**
739
- * The temperature of the model.
740
- */
741
- temperature?: number;
742
- }
743
-
744
- export namespace OpenAIModelSettings {
745
- /**
746
- * The reasoning configuration for the model.
747
- */
748
- export interface Reasoning {
749
- /**
750
- * The reasoning effort to use when generating text reasoning models
751
- */
752
- reasoning_effort?: 'minimal' | 'low' | 'medium' | 'high';
753
- }
754
- }
755
-
756
- export interface AnthropicModelSettings {
757
- /**
758
- * The maximum number of tokens the model can generate.
759
- */
760
- max_output_tokens?: number;
761
-
762
- /**
763
- * Whether to enable parallel tool calling.
764
- */
765
- parallel_tool_calls?: boolean;
766
-
767
- /**
768
- * The provider of the model.
769
- */
770
- provider?: 'anthropic';
771
-
772
- /**
773
- * The temperature of the model.
774
- */
775
- temperature?: number;
776
-
777
- /**
778
- * The thinking configuration for the model.
779
- */
780
- thinking?: AnthropicModelSettings.Thinking;
781
-
782
- /**
783
- * Soft control for how verbose model output should be, used for GPT-5 models.
784
- */
785
- verbosity?: 'low' | 'medium' | 'high' | null;
786
- }
787
-
788
- export namespace AnthropicModelSettings {
789
- /**
790
- * The thinking configuration for the model.
791
- */
792
- export interface Thinking {
793
- /**
794
- * The maximum number of tokens the model can use for extended thinking.
795
- */
796
- budget_tokens?: number;
797
-
798
- /**
799
- * The type of thinking to use.
800
- */
801
- type?: 'enabled' | 'disabled';
802
- }
803
- }
804
-
805
- export interface GoogleAIModelSettings {
806
- /**
807
- * The maximum number of tokens the model can generate.
808
- */
809
- max_output_tokens?: number;
810
-
811
- /**
812
- * Whether to enable parallel tool calling.
813
- */
814
- parallel_tool_calls?: boolean;
815
-
816
- /**
817
- * The provider of the model.
818
- */
819
- provider?: 'google_ai';
820
-
821
- /**
822
- * The response schema for the model.
823
- */
824
- response_schema?:
825
- | AgentsAPI.TextResponseFormat
826
- | AgentsAPI.JsonSchemaResponseFormat
827
- | AgentsAPI.JsonObjectResponseFormat
828
- | null;
829
-
830
- /**
831
- * The temperature of the model.
832
- */
833
- temperature?: number;
834
-
835
- /**
836
- * The thinking configuration for the model.
837
- */
838
- thinking_config?: GoogleAIModelSettings.ThinkingConfig;
839
- }
840
-
841
- export namespace GoogleAIModelSettings {
842
- /**
843
- * The thinking configuration for the model.
844
- */
845
- export interface ThinkingConfig {
846
- /**
847
- * Whether to include thoughts in the model's response.
848
- */
849
- include_thoughts?: boolean;
850
-
851
- /**
852
- * The thinking budget for the model.
853
- */
854
- thinking_budget?: number;
855
- }
856
- }
857
-
858
- export interface GoogleVertexModelSettings {
859
- /**
860
- * The maximum number of tokens the model can generate.
861
- */
862
- max_output_tokens?: number;
863
-
864
- /**
865
- * Whether to enable parallel tool calling.
866
- */
867
- parallel_tool_calls?: boolean;
868
-
869
- /**
870
- * The provider of the model.
871
- */
872
- provider?: 'google_vertex';
873
-
874
- /**
875
- * The response schema for the model.
876
- */
877
- response_schema?:
878
- | AgentsAPI.TextResponseFormat
879
- | AgentsAPI.JsonSchemaResponseFormat
880
- | AgentsAPI.JsonObjectResponseFormat
881
- | null;
882
-
883
- /**
884
- * The temperature of the model.
885
- */
886
- temperature?: number;
887
-
888
- /**
889
- * The thinking configuration for the model.
890
- */
891
- thinking_config?: GoogleVertexModelSettings.ThinkingConfig;
724
+ vector_db_provider?: ArchivesArchivesAPI.VectorDBProvider;
892
725
  }
726
+ }
893
727
 
894
- export namespace GoogleVertexModelSettings {
895
- /**
896
- * The thinking configuration for the model.
897
- */
898
- export interface ThinkingConfig {
899
- /**
900
- * Whether to include thoughts in the model's response.
901
- */
902
- include_thoughts?: boolean;
903
-
904
- /**
905
- * The thinking budget for the model.
906
- */
907
- thinking_budget?: number;
908
- }
909
- }
728
+ /**
729
+ * Enum to represent the type of agent.
730
+ */
731
+ export type AgentType =
732
+ | 'memgpt_agent'
733
+ | 'memgpt_v2_agent'
734
+ | 'letta_v1_agent'
735
+ | 'react_agent'
736
+ | 'workflow_agent'
737
+ | 'split_thread_agent'
738
+ | 'sleeptime_agent'
739
+ | 'voice_convo_agent'
740
+ | 'voice_sleeptime_agent';
910
741
 
742
+ export interface AnthropicModelSettings {
911
743
  /**
912
- * Azure OpenAI model configuration (OpenAI-compatible).
744
+ * The maximum number of tokens the model can generate.
913
745
  */
914
- export interface AzureModelSettings {
915
- /**
916
- * The maximum number of tokens the model can generate.
917
- */
918
- max_output_tokens?: number;
919
-
920
- /**
921
- * Whether to enable parallel tool calling.
922
- */
923
- parallel_tool_calls?: boolean;
924
-
925
- /**
926
- * The provider of the model.
927
- */
928
- provider?: 'azure';
929
-
930
- /**
931
- * The response format for the model.
932
- */
933
- response_format?:
934
- | AgentsAPI.TextResponseFormat
935
- | AgentsAPI.JsonSchemaResponseFormat
936
- | AgentsAPI.JsonObjectResponseFormat
937
- | null;
938
-
939
- /**
940
- * The temperature of the model.
941
- */
942
- temperature?: number;
943
- }
746
+ max_output_tokens?: number;
944
747
 
945
748
  /**
946
- * xAI model configuration (OpenAI-compatible).
749
+ * Whether to enable parallel tool calling.
947
750
  */
948
- export interface XaiModelSettings {
949
- /**
950
- * The maximum number of tokens the model can generate.
951
- */
952
- max_output_tokens?: number;
953
-
954
- /**
955
- * Whether to enable parallel tool calling.
956
- */
957
- parallel_tool_calls?: boolean;
958
-
959
- /**
960
- * The provider of the model.
961
- */
962
- provider?: 'xai';
963
-
964
- /**
965
- * The response format for the model.
966
- */
967
- response_format?:
968
- | AgentsAPI.TextResponseFormat
969
- | AgentsAPI.JsonSchemaResponseFormat
970
- | AgentsAPI.JsonObjectResponseFormat
971
- | null;
972
-
973
- /**
974
- * The temperature of the model.
975
- */
976
- temperature?: number;
977
- }
751
+ parallel_tool_calls?: boolean;
978
752
 
979
753
  /**
980
- * Groq model configuration (OpenAI-compatible).
754
+ * The type of the provider.
981
755
  */
982
- export interface GroqModelSettings {
983
- /**
984
- * The maximum number of tokens the model can generate.
985
- */
986
- max_output_tokens?: number;
987
-
988
- /**
989
- * Whether to enable parallel tool calling.
990
- */
991
- parallel_tool_calls?: boolean;
992
-
993
- /**
994
- * The provider of the model.
995
- */
996
- provider?: 'groq';
997
-
998
- /**
999
- * The response format for the model.
1000
- */
1001
- response_format?:
1002
- | AgentsAPI.TextResponseFormat
1003
- | AgentsAPI.JsonSchemaResponseFormat
1004
- | AgentsAPI.JsonObjectResponseFormat
1005
- | null;
1006
-
1007
- /**
1008
- * The temperature of the model.
1009
- */
1010
- temperature?: number;
1011
- }
756
+ provider_type?: 'anthropic';
1012
757
 
1013
758
  /**
1014
- * Deepseek model configuration (OpenAI-compatible).
759
+ * The temperature of the model.
1015
760
  */
1016
- export interface DeepseekModelSettings {
1017
- /**
1018
- * The maximum number of tokens the model can generate.
1019
- */
1020
- max_output_tokens?: number;
761
+ temperature?: number;
1021
762
 
1022
- /**
1023
- * Whether to enable parallel tool calling.
1024
- */
1025
- parallel_tool_calls?: boolean;
763
+ /**
764
+ * The thinking configuration for the model.
765
+ */
766
+ thinking?: AnthropicModelSettings.Thinking;
1026
767
 
1027
- /**
1028
- * The provider of the model.
1029
- */
1030
- provider?: 'deepseek';
768
+ /**
769
+ * Soft control for how verbose model output should be, used for GPT-5 models.
770
+ */
771
+ verbosity?: 'low' | 'medium' | 'high' | null;
772
+ }
1031
773
 
774
+ export namespace AnthropicModelSettings {
775
+ /**
776
+ * The thinking configuration for the model.
777
+ */
778
+ export interface Thinking {
1032
779
  /**
1033
- * The response format for the model.
780
+ * The maximum number of tokens the model can use for extended thinking.
1034
781
  */
1035
- response_format?:
1036
- | AgentsAPI.TextResponseFormat
1037
- | AgentsAPI.JsonSchemaResponseFormat
1038
- | AgentsAPI.JsonObjectResponseFormat
1039
- | null;
782
+ budget_tokens?: number;
1040
783
 
1041
784
  /**
1042
- * The temperature of the model.
785
+ * The type of thinking to use.
1043
786
  */
1044
- temperature?: number;
787
+ type?: 'enabled' | 'disabled';
1045
788
  }
789
+ }
1046
790
 
791
+ /**
792
+ * Azure OpenAI model configuration (OpenAI-compatible).
793
+ */
794
+ export interface AzureModelSettings {
1047
795
  /**
1048
- * Together AI model configuration (OpenAI-compatible).
796
+ * The maximum number of tokens the model can generate.
1049
797
  */
1050
- export interface TogetherModelSettings {
1051
- /**
1052
- * The maximum number of tokens the model can generate.
1053
- */
1054
- max_output_tokens?: number;
798
+ max_output_tokens?: number;
1055
799
 
1056
- /**
1057
- * Whether to enable parallel tool calling.
1058
- */
1059
- parallel_tool_calls?: boolean;
800
+ /**
801
+ * Whether to enable parallel tool calling.
802
+ */
803
+ parallel_tool_calls?: boolean;
1060
804
 
1061
- /**
1062
- * The provider of the model.
1063
- */
1064
- provider?: 'together';
805
+ /**
806
+ * The type of the provider.
807
+ */
808
+ provider_type?: 'azure';
1065
809
 
1066
- /**
1067
- * The response format for the model.
1068
- */
1069
- response_format?:
1070
- | AgentsAPI.TextResponseFormat
1071
- | AgentsAPI.JsonSchemaResponseFormat
1072
- | AgentsAPI.JsonObjectResponseFormat
1073
- | null;
810
+ /**
811
+ * The response format for the model.
812
+ */
813
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1074
814
 
1075
- /**
1076
- * The temperature of the model.
1077
- */
1078
- temperature?: number;
1079
- }
815
+ /**
816
+ * The temperature of the model.
817
+ */
818
+ temperature?: number;
819
+ }
1080
820
 
821
+ /**
822
+ * AWS Bedrock model configuration.
823
+ */
824
+ export interface BedrockModelSettings {
1081
825
  /**
1082
- * AWS Bedrock model configuration.
826
+ * The maximum number of tokens the model can generate.
1083
827
  */
1084
- export interface BedrockModelSettings {
1085
- /**
1086
- * The maximum number of tokens the model can generate.
1087
- */
1088
- max_output_tokens?: number;
828
+ max_output_tokens?: number;
1089
829
 
1090
- /**
1091
- * Whether to enable parallel tool calling.
1092
- */
1093
- parallel_tool_calls?: boolean;
830
+ /**
831
+ * Whether to enable parallel tool calling.
832
+ */
833
+ parallel_tool_calls?: boolean;
1094
834
 
1095
- /**
1096
- * The provider of the model.
1097
- */
1098
- provider?: 'bedrock';
835
+ /**
836
+ * The type of the provider.
837
+ */
838
+ provider_type?: 'bedrock';
1099
839
 
1100
- /**
1101
- * The response format for the model.
1102
- */
1103
- response_format?:
1104
- | AgentsAPI.TextResponseFormat
1105
- | AgentsAPI.JsonSchemaResponseFormat
1106
- | AgentsAPI.JsonObjectResponseFormat
1107
- | null;
840
+ /**
841
+ * The response format for the model.
842
+ */
843
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1108
844
 
1109
- /**
1110
- * The temperature of the model.
1111
- */
1112
- temperature?: number;
1113
- }
845
+ /**
846
+ * The temperature of the model.
847
+ */
848
+ temperature?: number;
1114
849
  }
1115
850
 
1116
- /**
1117
- * Enum to represent the type of agent.
1118
- */
1119
- export type AgentType =
1120
- | 'memgpt_agent'
1121
- | 'memgpt_v2_agent'
1122
- | 'letta_v1_agent'
1123
- | 'react_agent'
1124
- | 'workflow_agent'
1125
- | 'split_thread_agent'
1126
- | 'sleeptime_agent'
1127
- | 'voice_convo_agent'
1128
- | 'voice_sleeptime_agent';
1129
-
1130
851
  /**
1131
852
  * A ToolRule represents a tool that can be invoked by the agent.
1132
853
  */
@@ -1228,17 +949,175 @@ export interface ContinueToolRule {
1228
949
  }
1229
950
 
1230
951
  /**
1231
- * Represents the initial tool rule configuration.
952
+ * Deepseek model configuration (OpenAI-compatible).
1232
953
  */
1233
- export interface InitToolRule {
954
+ export interface DeepseekModelSettings {
1234
955
  /**
1235
- * The name of the tool. Must exist in the database for the user's organization.
956
+ * The maximum number of tokens the model can generate.
1236
957
  */
1237
- tool_name: string;
958
+ max_output_tokens?: number;
1238
959
 
1239
960
  /**
1240
- * Optional prefilled arguments for this tool. When present, these values will
1241
- * override any LLM-provided arguments with the same keys during invocation. Keys
961
+ * Whether to enable parallel tool calling.
962
+ */
963
+ parallel_tool_calls?: boolean;
964
+
965
+ /**
966
+ * The type of the provider.
967
+ */
968
+ provider_type?: 'deepseek';
969
+
970
+ /**
971
+ * The response format for the model.
972
+ */
973
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
974
+
975
+ /**
976
+ * The temperature of the model.
977
+ */
978
+ temperature?: number;
979
+ }
980
+
981
+ export interface GoogleAIModelSettings {
982
+ /**
983
+ * The maximum number of tokens the model can generate.
984
+ */
985
+ max_output_tokens?: number;
986
+
987
+ /**
988
+ * Whether to enable parallel tool calling.
989
+ */
990
+ parallel_tool_calls?: boolean;
991
+
992
+ /**
993
+ * The type of the provider.
994
+ */
995
+ provider_type?: 'google_ai';
996
+
997
+ /**
998
+ * The response schema for the model.
999
+ */
1000
+ response_schema?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1001
+
1002
+ /**
1003
+ * The temperature of the model.
1004
+ */
1005
+ temperature?: number;
1006
+
1007
+ /**
1008
+ * The thinking configuration for the model.
1009
+ */
1010
+ thinking_config?: GoogleAIModelSettings.ThinkingConfig;
1011
+ }
1012
+
1013
+ export namespace GoogleAIModelSettings {
1014
+ /**
1015
+ * The thinking configuration for the model.
1016
+ */
1017
+ export interface ThinkingConfig {
1018
+ /**
1019
+ * Whether to include thoughts in the model's response.
1020
+ */
1021
+ include_thoughts?: boolean;
1022
+
1023
+ /**
1024
+ * The thinking budget for the model.
1025
+ */
1026
+ thinking_budget?: number;
1027
+ }
1028
+ }
1029
+
1030
+ export interface GoogleVertexModelSettings {
1031
+ /**
1032
+ * The maximum number of tokens the model can generate.
1033
+ */
1034
+ max_output_tokens?: number;
1035
+
1036
+ /**
1037
+ * Whether to enable parallel tool calling.
1038
+ */
1039
+ parallel_tool_calls?: boolean;
1040
+
1041
+ /**
1042
+ * The type of the provider.
1043
+ */
1044
+ provider_type?: 'google_vertex';
1045
+
1046
+ /**
1047
+ * The response schema for the model.
1048
+ */
1049
+ response_schema?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1050
+
1051
+ /**
1052
+ * The temperature of the model.
1053
+ */
1054
+ temperature?: number;
1055
+
1056
+ /**
1057
+ * The thinking configuration for the model.
1058
+ */
1059
+ thinking_config?: GoogleVertexModelSettings.ThinkingConfig;
1060
+ }
1061
+
1062
+ export namespace GoogleVertexModelSettings {
1063
+ /**
1064
+ * The thinking configuration for the model.
1065
+ */
1066
+ export interface ThinkingConfig {
1067
+ /**
1068
+ * Whether to include thoughts in the model's response.
1069
+ */
1070
+ include_thoughts?: boolean;
1071
+
1072
+ /**
1073
+ * The thinking budget for the model.
1074
+ */
1075
+ thinking_budget?: number;
1076
+ }
1077
+ }
1078
+
1079
+ /**
1080
+ * Groq model configuration (OpenAI-compatible).
1081
+ */
1082
+ export interface GroqModelSettings {
1083
+ /**
1084
+ * The maximum number of tokens the model can generate.
1085
+ */
1086
+ max_output_tokens?: number;
1087
+
1088
+ /**
1089
+ * Whether to enable parallel tool calling.
1090
+ */
1091
+ parallel_tool_calls?: boolean;
1092
+
1093
+ /**
1094
+ * The type of the provider.
1095
+ */
1096
+ provider_type?: 'groq';
1097
+
1098
+ /**
1099
+ * The response format for the model.
1100
+ */
1101
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1102
+
1103
+ /**
1104
+ * The temperature of the model.
1105
+ */
1106
+ temperature?: number;
1107
+ }
1108
+
1109
+ /**
1110
+ * Represents the initial tool rule configuration.
1111
+ */
1112
+ export interface InitToolRule {
1113
+ /**
1114
+ * The name of the tool. Must exist in the database for the user's organization.
1115
+ */
1116
+ tool_name: string;
1117
+
1118
+ /**
1119
+ * Optional prefilled arguments for this tool. When present, these values will
1120
+ * override any LLM-provided arguments with the same keys during invocation. Keys
1242
1121
  * must match the tool's parameter names and values must satisfy the tool's JSON
1243
1122
  * schema. Supports partial prefill; non-overlapping parameters are left to the
1244
1123
  * model.
@@ -1360,6 +1239,50 @@ export interface MessageCreate {
1360
1239
  type?: 'message' | null;
1361
1240
  }
1362
1241
 
1242
+ export interface OpenAIModelSettings {
1243
+ /**
1244
+ * The maximum number of tokens the model can generate.
1245
+ */
1246
+ max_output_tokens?: number;
1247
+
1248
+ /**
1249
+ * Whether to enable parallel tool calling.
1250
+ */
1251
+ parallel_tool_calls?: boolean;
1252
+
1253
+ /**
1254
+ * The type of the provider.
1255
+ */
1256
+ provider_type?: 'openai';
1257
+
1258
+ /**
1259
+ * The reasoning configuration for the model.
1260
+ */
1261
+ reasoning?: OpenAIModelSettings.Reasoning;
1262
+
1263
+ /**
1264
+ * The response format for the model.
1265
+ */
1266
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1267
+
1268
+ /**
1269
+ * The temperature of the model.
1270
+ */
1271
+ temperature?: number;
1272
+ }
1273
+
1274
+ export namespace OpenAIModelSettings {
1275
+ /**
1276
+ * The reasoning configuration for the model.
1277
+ */
1278
+ export interface Reasoning {
1279
+ /**
1280
+ * The reasoning effort to use when generating text reasoning models
1281
+ */
1282
+ reasoning_effort?: 'minimal' | 'low' | 'medium' | 'high';
1283
+ }
1284
+ }
1285
+
1363
1286
  /**
1364
1287
  * A ToolRule that only allows a child tool to be called if the parent has been
1365
1288
  * called.
@@ -1448,6 +1371,66 @@ export interface TextResponseFormat {
1448
1371
  type?: 'text';
1449
1372
  }
1450
1373
 
1374
+ /**
1375
+ * Together AI model configuration (OpenAI-compatible).
1376
+ */
1377
+ export interface TogetherModelSettings {
1378
+ /**
1379
+ * The maximum number of tokens the model can generate.
1380
+ */
1381
+ max_output_tokens?: number;
1382
+
1383
+ /**
1384
+ * Whether to enable parallel tool calling.
1385
+ */
1386
+ parallel_tool_calls?: boolean;
1387
+
1388
+ /**
1389
+ * The type of the provider.
1390
+ */
1391
+ provider_type?: 'together';
1392
+
1393
+ /**
1394
+ * The response format for the model.
1395
+ */
1396
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1397
+
1398
+ /**
1399
+ * The temperature of the model.
1400
+ */
1401
+ temperature?: number;
1402
+ }
1403
+
1404
+ /**
1405
+ * xAI model configuration (OpenAI-compatible).
1406
+ */
1407
+ export interface XaiModelSettings {
1408
+ /**
1409
+ * The maximum number of tokens the model can generate.
1410
+ */
1411
+ max_output_tokens?: number;
1412
+
1413
+ /**
1414
+ * Whether to enable parallel tool calling.
1415
+ */
1416
+ parallel_tool_calls?: boolean;
1417
+
1418
+ /**
1419
+ * The type of the provider.
1420
+ */
1421
+ provider_type?: 'xai';
1422
+
1423
+ /**
1424
+ * The response format for the model.
1425
+ */
1426
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1427
+
1428
+ /**
1429
+ * The temperature of the model.
1430
+ */
1431
+ temperature?: number;
1432
+ }
1433
+
1451
1434
  export type AgentDeleteResponse = unknown;
1452
1435
 
1453
1436
  export type AgentExportFileResponse = string;
@@ -1615,16 +1598,16 @@ export interface AgentCreateParams {
1615
1598
  * The model settings for the agent.
1616
1599
  */
1617
1600
  model_settings?:
1618
- | AgentCreateParams.OpenAIModelSettings
1619
- | AgentCreateParams.AnthropicModelSettings
1620
- | AgentCreateParams.GoogleAIModelSettings
1621
- | AgentCreateParams.GoogleVertexModelSettings
1622
- | AgentCreateParams.AzureModelSettings
1623
- | AgentCreateParams.XaiModelSettings
1624
- | AgentCreateParams.GroqModelSettings
1625
- | AgentCreateParams.DeepseekModelSettings
1626
- | AgentCreateParams.TogetherModelSettings
1627
- | AgentCreateParams.BedrockModelSettings
1601
+ | OpenAIModelSettings
1602
+ | AnthropicModelSettings
1603
+ | GoogleAIModelSettings
1604
+ | GoogleVertexModelSettings
1605
+ | AzureModelSettings
1606
+ | XaiModelSettings
1607
+ | GroqModelSettings
1608
+ | DeepseekModelSettings
1609
+ | TogetherModelSettings
1610
+ | BedrockModelSettings
1628
1611
  | null;
1629
1612
 
1630
1613
  /**
@@ -1736,487 +1719,78 @@ export interface AgentCreateParams {
1736
1719
  tools?: Array<string> | null;
1737
1720
  }
1738
1721
 
1739
- export namespace AgentCreateParams {
1740
- export interface OpenAIModelSettings {
1741
- /**
1742
- * The maximum number of tokens the model can generate.
1743
- */
1744
- max_output_tokens?: number;
1722
+ export interface AgentRetrieveParams {
1723
+ /**
1724
+ * Specify which relational fields to include in the response. No relationships are
1725
+ * included by default.
1726
+ */
1727
+ include?: Array<
1728
+ | 'agent.blocks'
1729
+ | 'agent.identities'
1730
+ | 'agent.managed_group'
1731
+ | 'agent.secrets'
1732
+ | 'agent.sources'
1733
+ | 'agent.tags'
1734
+ | 'agent.tools'
1735
+ >;
1745
1736
 
1746
- /**
1747
- * Whether to enable parallel tool calling.
1748
- */
1749
- parallel_tool_calls?: boolean;
1737
+ /**
1738
+ * Specify which relational fields (e.g., 'tools', 'sources', 'memory') to include
1739
+ * in the response. If not provided, all relationships are loaded by default. Using
1740
+ * this can optimize performance by reducing unnecessary joins.This is a legacy
1741
+ * parameter, and no longer supported after 1.0.0 SDK versions.
1742
+ */
1743
+ include_relationships?: Array<string> | null;
1744
+ }
1750
1745
 
1751
- /**
1752
- * The provider of the model.
1753
- */
1754
- provider?: 'openai';
1746
+ export interface AgentListParams extends ArrayPageParams {
1747
+ /**
1748
+ * @deprecated Whether to sort agents oldest to newest (True) or newest to oldest
1749
+ * (False, default)
1750
+ */
1751
+ ascending?: boolean;
1755
1752
 
1756
- /**
1757
- * The reasoning configuration for the model.
1758
- */
1759
- reasoning?: OpenAIModelSettings.Reasoning;
1753
+ /**
1754
+ * Search agents by base template ID
1755
+ */
1756
+ base_template_id?: string | null;
1760
1757
 
1761
- /**
1762
- * The response format for the model.
1763
- */
1764
- response_format?:
1765
- | AgentsAPI.TextResponseFormat
1766
- | AgentsAPI.JsonSchemaResponseFormat
1767
- | AgentsAPI.JsonObjectResponseFormat
1768
- | null;
1758
+ /**
1759
+ * Search agents by identifier keys
1760
+ */
1761
+ identifier_keys?: Array<string> | null;
1769
1762
 
1770
- /**
1771
- * The temperature of the model.
1772
- */
1773
- temperature?: number;
1774
- }
1763
+ /**
1764
+ * Search agents by identity ID
1765
+ */
1766
+ identity_id?: string | null;
1775
1767
 
1776
- export namespace OpenAIModelSettings {
1777
- /**
1778
- * The reasoning configuration for the model.
1779
- */
1780
- export interface Reasoning {
1781
- /**
1782
- * The reasoning effort to use when generating text reasoning models
1783
- */
1784
- reasoning_effort?: 'minimal' | 'low' | 'medium' | 'high';
1785
- }
1786
- }
1768
+ /**
1769
+ * Specify which relational fields to include in the response. No relationships are
1770
+ * included by default.
1771
+ */
1772
+ include?: Array<
1773
+ | 'agent.blocks'
1774
+ | 'agent.identities'
1775
+ | 'agent.managed_group'
1776
+ | 'agent.secrets'
1777
+ | 'agent.sources'
1778
+ | 'agent.tags'
1779
+ | 'agent.tools'
1780
+ >;
1787
1781
 
1788
- export interface AnthropicModelSettings {
1789
- /**
1790
- * The maximum number of tokens the model can generate.
1791
- */
1792
- max_output_tokens?: number;
1782
+ /**
1783
+ * Specify which relational fields (e.g., 'tools', 'sources', 'memory') to include
1784
+ * in the response. If not provided, all relationships are loaded by default. Using
1785
+ * this can optimize performance by reducing unnecessary joins.This is a legacy
1786
+ * parameter, and no longer supported after 1.0.0 SDK versions.
1787
+ */
1788
+ include_relationships?: Array<string> | null;
1793
1789
 
1794
- /**
1795
- * Whether to enable parallel tool calling.
1796
- */
1797
- parallel_tool_calls?: boolean;
1798
-
1799
- /**
1800
- * The provider of the model.
1801
- */
1802
- provider?: 'anthropic';
1803
-
1804
- /**
1805
- * The temperature of the model.
1806
- */
1807
- temperature?: number;
1808
-
1809
- /**
1810
- * The thinking configuration for the model.
1811
- */
1812
- thinking?: AnthropicModelSettings.Thinking;
1813
-
1814
- /**
1815
- * Soft control for how verbose model output should be, used for GPT-5 models.
1816
- */
1817
- verbosity?: 'low' | 'medium' | 'high' | null;
1818
- }
1819
-
1820
- export namespace AnthropicModelSettings {
1821
- /**
1822
- * The thinking configuration for the model.
1823
- */
1824
- export interface Thinking {
1825
- /**
1826
- * The maximum number of tokens the model can use for extended thinking.
1827
- */
1828
- budget_tokens?: number;
1829
-
1830
- /**
1831
- * The type of thinking to use.
1832
- */
1833
- type?: 'enabled' | 'disabled';
1834
- }
1835
- }
1836
-
1837
- export interface GoogleAIModelSettings {
1838
- /**
1839
- * The maximum number of tokens the model can generate.
1840
- */
1841
- max_output_tokens?: number;
1842
-
1843
- /**
1844
- * Whether to enable parallel tool calling.
1845
- */
1846
- parallel_tool_calls?: boolean;
1847
-
1848
- /**
1849
- * The provider of the model.
1850
- */
1851
- provider?: 'google_ai';
1852
-
1853
- /**
1854
- * The response schema for the model.
1855
- */
1856
- response_schema?:
1857
- | AgentsAPI.TextResponseFormat
1858
- | AgentsAPI.JsonSchemaResponseFormat
1859
- | AgentsAPI.JsonObjectResponseFormat
1860
- | null;
1861
-
1862
- /**
1863
- * The temperature of the model.
1864
- */
1865
- temperature?: number;
1866
-
1867
- /**
1868
- * The thinking configuration for the model.
1869
- */
1870
- thinking_config?: GoogleAIModelSettings.ThinkingConfig;
1871
- }
1872
-
1873
- export namespace GoogleAIModelSettings {
1874
- /**
1875
- * The thinking configuration for the model.
1876
- */
1877
- export interface ThinkingConfig {
1878
- /**
1879
- * Whether to include thoughts in the model's response.
1880
- */
1881
- include_thoughts?: boolean;
1882
-
1883
- /**
1884
- * The thinking budget for the model.
1885
- */
1886
- thinking_budget?: number;
1887
- }
1888
- }
1889
-
1890
- export interface GoogleVertexModelSettings {
1891
- /**
1892
- * The maximum number of tokens the model can generate.
1893
- */
1894
- max_output_tokens?: number;
1895
-
1896
- /**
1897
- * Whether to enable parallel tool calling.
1898
- */
1899
- parallel_tool_calls?: boolean;
1900
-
1901
- /**
1902
- * The provider of the model.
1903
- */
1904
- provider?: 'google_vertex';
1905
-
1906
- /**
1907
- * The response schema for the model.
1908
- */
1909
- response_schema?:
1910
- | AgentsAPI.TextResponseFormat
1911
- | AgentsAPI.JsonSchemaResponseFormat
1912
- | AgentsAPI.JsonObjectResponseFormat
1913
- | null;
1914
-
1915
- /**
1916
- * The temperature of the model.
1917
- */
1918
- temperature?: number;
1919
-
1920
- /**
1921
- * The thinking configuration for the model.
1922
- */
1923
- thinking_config?: GoogleVertexModelSettings.ThinkingConfig;
1924
- }
1925
-
1926
- export namespace GoogleVertexModelSettings {
1927
- /**
1928
- * The thinking configuration for the model.
1929
- */
1930
- export interface ThinkingConfig {
1931
- /**
1932
- * Whether to include thoughts in the model's response.
1933
- */
1934
- include_thoughts?: boolean;
1935
-
1936
- /**
1937
- * The thinking budget for the model.
1938
- */
1939
- thinking_budget?: number;
1940
- }
1941
- }
1942
-
1943
- /**
1944
- * Azure OpenAI model configuration (OpenAI-compatible).
1945
- */
1946
- export interface AzureModelSettings {
1947
- /**
1948
- * The maximum number of tokens the model can generate.
1949
- */
1950
- max_output_tokens?: number;
1951
-
1952
- /**
1953
- * Whether to enable parallel tool calling.
1954
- */
1955
- parallel_tool_calls?: boolean;
1956
-
1957
- /**
1958
- * The provider of the model.
1959
- */
1960
- provider?: 'azure';
1961
-
1962
- /**
1963
- * The response format for the model.
1964
- */
1965
- response_format?:
1966
- | AgentsAPI.TextResponseFormat
1967
- | AgentsAPI.JsonSchemaResponseFormat
1968
- | AgentsAPI.JsonObjectResponseFormat
1969
- | null;
1970
-
1971
- /**
1972
- * The temperature of the model.
1973
- */
1974
- temperature?: number;
1975
- }
1976
-
1977
- /**
1978
- * xAI model configuration (OpenAI-compatible).
1979
- */
1980
- export interface XaiModelSettings {
1981
- /**
1982
- * The maximum number of tokens the model can generate.
1983
- */
1984
- max_output_tokens?: number;
1985
-
1986
- /**
1987
- * Whether to enable parallel tool calling.
1988
- */
1989
- parallel_tool_calls?: boolean;
1990
-
1991
- /**
1992
- * The provider of the model.
1993
- */
1994
- provider?: 'xai';
1995
-
1996
- /**
1997
- * The response format for the model.
1998
- */
1999
- response_format?:
2000
- | AgentsAPI.TextResponseFormat
2001
- | AgentsAPI.JsonSchemaResponseFormat
2002
- | AgentsAPI.JsonObjectResponseFormat
2003
- | null;
2004
-
2005
- /**
2006
- * The temperature of the model.
2007
- */
2008
- temperature?: number;
2009
- }
2010
-
2011
- /**
2012
- * Groq model configuration (OpenAI-compatible).
2013
- */
2014
- export interface GroqModelSettings {
2015
- /**
2016
- * The maximum number of tokens the model can generate.
2017
- */
2018
- max_output_tokens?: number;
2019
-
2020
- /**
2021
- * Whether to enable parallel tool calling.
2022
- */
2023
- parallel_tool_calls?: boolean;
2024
-
2025
- /**
2026
- * The provider of the model.
2027
- */
2028
- provider?: 'groq';
2029
-
2030
- /**
2031
- * The response format for the model.
2032
- */
2033
- response_format?:
2034
- | AgentsAPI.TextResponseFormat
2035
- | AgentsAPI.JsonSchemaResponseFormat
2036
- | AgentsAPI.JsonObjectResponseFormat
2037
- | null;
2038
-
2039
- /**
2040
- * The temperature of the model.
2041
- */
2042
- temperature?: number;
2043
- }
2044
-
2045
- /**
2046
- * Deepseek model configuration (OpenAI-compatible).
2047
- */
2048
- export interface DeepseekModelSettings {
2049
- /**
2050
- * The maximum number of tokens the model can generate.
2051
- */
2052
- max_output_tokens?: number;
2053
-
2054
- /**
2055
- * Whether to enable parallel tool calling.
2056
- */
2057
- parallel_tool_calls?: boolean;
2058
-
2059
- /**
2060
- * The provider of the model.
2061
- */
2062
- provider?: 'deepseek';
2063
-
2064
- /**
2065
- * The response format for the model.
2066
- */
2067
- response_format?:
2068
- | AgentsAPI.TextResponseFormat
2069
- | AgentsAPI.JsonSchemaResponseFormat
2070
- | AgentsAPI.JsonObjectResponseFormat
2071
- | null;
2072
-
2073
- /**
2074
- * The temperature of the model.
2075
- */
2076
- temperature?: number;
2077
- }
2078
-
2079
- /**
2080
- * Together AI model configuration (OpenAI-compatible).
2081
- */
2082
- export interface TogetherModelSettings {
2083
- /**
2084
- * The maximum number of tokens the model can generate.
2085
- */
2086
- max_output_tokens?: number;
2087
-
2088
- /**
2089
- * Whether to enable parallel tool calling.
2090
- */
2091
- parallel_tool_calls?: boolean;
2092
-
2093
- /**
2094
- * The provider of the model.
2095
- */
2096
- provider?: 'together';
2097
-
2098
- /**
2099
- * The response format for the model.
2100
- */
2101
- response_format?:
2102
- | AgentsAPI.TextResponseFormat
2103
- | AgentsAPI.JsonSchemaResponseFormat
2104
- | AgentsAPI.JsonObjectResponseFormat
2105
- | null;
2106
-
2107
- /**
2108
- * The temperature of the model.
2109
- */
2110
- temperature?: number;
2111
- }
2112
-
2113
- /**
2114
- * AWS Bedrock model configuration.
2115
- */
2116
- export interface BedrockModelSettings {
2117
- /**
2118
- * The maximum number of tokens the model can generate.
2119
- */
2120
- max_output_tokens?: number;
2121
-
2122
- /**
2123
- * Whether to enable parallel tool calling.
2124
- */
2125
- parallel_tool_calls?: boolean;
2126
-
2127
- /**
2128
- * The provider of the model.
2129
- */
2130
- provider?: 'bedrock';
2131
-
2132
- /**
2133
- * The response format for the model.
2134
- */
2135
- response_format?:
2136
- | AgentsAPI.TextResponseFormat
2137
- | AgentsAPI.JsonSchemaResponseFormat
2138
- | AgentsAPI.JsonObjectResponseFormat
2139
- | null;
2140
-
2141
- /**
2142
- * The temperature of the model.
2143
- */
2144
- temperature?: number;
2145
- }
2146
- }
2147
-
2148
- export interface AgentRetrieveParams {
2149
- /**
2150
- * Specify which relational fields to include in the response. No relationships are
2151
- * included by default.
2152
- */
2153
- include?: Array<
2154
- | 'agent.blocks'
2155
- | 'agent.identities'
2156
- | 'agent.managed_group'
2157
- | 'agent.secrets'
2158
- | 'agent.sources'
2159
- | 'agent.tags'
2160
- | 'agent.tools'
2161
- >;
2162
-
2163
- /**
2164
- * Specify which relational fields (e.g., 'tools', 'sources', 'memory') to include
2165
- * in the response. If not provided, all relationships are loaded by default. Using
2166
- * this can optimize performance by reducing unnecessary joins.This is a legacy
2167
- * parameter, and no longer supported after 1.0.0 SDK versions.
2168
- */
2169
- include_relationships?: Array<string> | null;
2170
- }
2171
-
2172
- export interface AgentListParams extends ArrayPageParams {
2173
- /**
2174
- * @deprecated Whether to sort agents oldest to newest (True) or newest to oldest
2175
- * (False, default)
2176
- */
2177
- ascending?: boolean;
2178
-
2179
- /**
2180
- * Search agents by base template ID
2181
- */
2182
- base_template_id?: string | null;
2183
-
2184
- /**
2185
- * Search agents by identifier keys
2186
- */
2187
- identifier_keys?: Array<string> | null;
2188
-
2189
- /**
2190
- * Search agents by identity ID
2191
- */
2192
- identity_id?: string | null;
2193
-
2194
- /**
2195
- * Specify which relational fields to include in the response. No relationships are
2196
- * included by default.
2197
- */
2198
- include?: Array<
2199
- | 'agent.blocks'
2200
- | 'agent.identities'
2201
- | 'agent.managed_group'
2202
- | 'agent.secrets'
2203
- | 'agent.sources'
2204
- | 'agent.tags'
2205
- | 'agent.tools'
2206
- >;
2207
-
2208
- /**
2209
- * Specify which relational fields (e.g., 'tools', 'sources', 'memory') to include
2210
- * in the response. If not provided, all relationships are loaded by default. Using
2211
- * this can optimize performance by reducing unnecessary joins.This is a legacy
2212
- * parameter, and no longer supported after 1.0.0 SDK versions.
2213
- */
2214
- include_relationships?: Array<string> | null;
2215
-
2216
- /**
2217
- * Filter agents by their last stop reason.
2218
- */
2219
- last_stop_reason?: RunsAPI.StopReasonType | null;
1790
+ /**
1791
+ * Filter agents by their last stop reason.
1792
+ */
1793
+ last_stop_reason?: RunsAPI.StopReasonType | null;
2220
1794
 
2221
1795
  /**
2222
1796
  * If True, only returns agents that match ALL given tags. Otherwise, return agents
@@ -2237,731 +1811,334 @@ export interface AgentListParams extends ArrayPageParams {
2237
1811
  /**
2238
1812
  * Search agents by name
2239
1813
  */
2240
- query_text?: string | null;
2241
-
2242
- /**
2243
- * @deprecated Field to sort by. Options: 'created_at' (default),
2244
- * 'last_run_completion'
2245
- */
2246
- sort_by?: string | null;
2247
-
2248
- /**
2249
- * List of tags to filter agents by
2250
- */
2251
- tags?: Array<string> | null;
2252
-
2253
- /**
2254
- * Search agents by template ID
2255
- */
2256
- template_id?: string | null;
2257
- }
2258
-
2259
- export interface AgentExportFileParams {
2260
- /**
2261
- * @deprecated
2262
- */
2263
- max_steps?: number;
2264
-
2265
- /**
2266
- * @deprecated If True, exports using the legacy single-agent 'v1' format with
2267
- * inline tools/blocks. If False, exports using the new multi-entity 'v2' format,
2268
- * with separate agents, tools, blocks, files, etc.
2269
- */
2270
- use_legacy_format?: boolean;
2271
- }
2272
-
2273
- export interface AgentImportFileParams {
2274
- /**
2275
- * Body param:
2276
- */
2277
- file: Uploadable;
2278
-
2279
- /**
2280
- * @deprecated Body param: If set to True, appends "\_copy" to the end of the agent
2281
- * name.
2282
- */
2283
- append_copy_suffix?: boolean;
2284
-
2285
- /**
2286
- * Body param: Environment variables as a JSON string to pass to the agent for tool
2287
- * execution.
2288
- */
2289
- env_vars_json?: string | null;
2290
-
2291
- /**
2292
- * Body param: Override import with specific embedding handle.
2293
- */
2294
- override_embedding_handle?: string | null;
2295
-
2296
- /**
2297
- * Body param: If set to True, existing tools can get their source code overwritten
2298
- * by the uploaded tool definitions. Note that Letta core tools can never be
2299
- * updated externally.
2300
- */
2301
- override_existing_tools?: boolean;
2302
-
2303
- /**
2304
- * Body param: If provided, overrides the agent name with this value.
2305
- */
2306
- override_name?: string | null;
2307
-
2308
- /**
2309
- * Body param: The project ID to associate the uploaded agent with.
2310
- */
2311
- project_id?: string | null;
2312
-
2313
- /**
2314
- * Body param: If set to True, strips all messages from the agent before importing.
2315
- */
2316
- strip_messages?: boolean;
2317
-
2318
- /**
2319
- * Header param:
2320
- */
2321
- 'x-override-embedding-model'?: string;
2322
- }
2323
-
2324
- export interface AgentModifyParams {
2325
- /**
2326
- * The base template id of the agent.
2327
- */
2328
- base_template_id?: string | null;
2329
-
2330
- /**
2331
- * The ids of the blocks used by the agent.
2332
- */
2333
- block_ids?: Array<string> | null;
2334
-
2335
- /**
2336
- * The context window limit used by the agent.
2337
- */
2338
- context_window_limit?: number | null;
2339
-
2340
- /**
2341
- * The description of the agent.
2342
- */
2343
- description?: string | null;
2344
-
2345
- /**
2346
- * The embedding model handle used by the agent (format: provider/model-name).
2347
- */
2348
- embedding?: string | null;
2349
-
2350
- /**
2351
- * Configuration for embedding model connection and processing parameters.
2352
- */
2353
- embedding_config?: ModelsAPI.EmbeddingConfig | null;
2354
-
2355
- /**
2356
- * If set to True, memory management will move to a background agent thread.
2357
- */
2358
- enable_sleeptime?: boolean | null;
2359
-
2360
- /**
2361
- * If set to True, the agent will be hidden.
2362
- */
2363
- hidden?: boolean | null;
2364
-
2365
- /**
2366
- * The ids of the identities associated with this agent.
2367
- */
2368
- identity_ids?: Array<string> | null;
2369
-
2370
- /**
2371
- * The timestamp when the agent last completed a run.
2372
- */
2373
- last_run_completion?: string | null;
2374
-
2375
- /**
2376
- * The duration in milliseconds of the agent's last run.
2377
- */
2378
- last_run_duration_ms?: number | null;
2379
-
2380
- /**
2381
- * The stop reason from the agent's last run.
2382
- */
2383
- last_stop_reason?: RunsAPI.StopReasonType | null;
1814
+ query_text?: string | null;
2384
1815
 
2385
1816
  /**
2386
- * Configuration for Language Model (LLM) connection and generation parameters.
1817
+ * @deprecated Field to sort by. Options: 'created_at' (default),
1818
+ * 'last_run_completion'
2387
1819
  */
2388
- llm_config?: ModelsAPI.LlmConfig | null;
1820
+ sort_by?: string | null;
2389
1821
 
2390
1822
  /**
2391
- * Maximum number of files that can be open at once for this agent. Setting this
2392
- * too high may exceed the context window, which will break the agent.
1823
+ * List of tags to filter agents by
2393
1824
  */
2394
- max_files_open?: number | null;
1825
+ tags?: Array<string> | null;
2395
1826
 
2396
1827
  /**
2397
- * @deprecated Deprecated: Use `model` field to configure max output tokens
2398
- * instead. The maximum number of tokens to generate, including reasoning step.
1828
+ * Search agents by template ID
2399
1829
  */
2400
- max_tokens?: number | null;
1830
+ template_id?: string | null;
1831
+ }
2401
1832
 
1833
+ export interface AgentExportFileParams {
2402
1834
  /**
2403
- * If set to True, the agent will not remember previous messages (though the agent
2404
- * will still retain state via core memory blocks and archival/recall memory). Not
2405
- * recommended unless you have an advanced use case.
1835
+ * @deprecated
2406
1836
  */
2407
- message_buffer_autoclear?: boolean | null;
1837
+ max_steps?: number;
2408
1838
 
2409
1839
  /**
2410
- * The ids of the messages in the agent's in-context memory.
1840
+ * @deprecated If True, exports using the legacy single-agent 'v1' format with
1841
+ * inline tools/blocks. If False, exports using the new multi-entity 'v2' format,
1842
+ * with separate agents, tools, blocks, files, etc.
2411
1843
  */
2412
- message_ids?: Array<string> | null;
1844
+ use_legacy_format?: boolean;
1845
+ }
2413
1846
 
1847
+ export interface AgentImportFileParams {
2414
1848
  /**
2415
- * The metadata of the agent.
1849
+ * Body param:
2416
1850
  */
2417
- metadata?: { [key: string]: unknown } | null;
1851
+ file: Uploadable;
2418
1852
 
2419
1853
  /**
2420
- * The model handle used by the agent (format: provider/model-name).
1854
+ * @deprecated Body param: If set to True, appends "\_copy" to the end of the agent
1855
+ * name.
2421
1856
  */
2422
- model?: string | null;
1857
+ append_copy_suffix?: boolean;
2423
1858
 
2424
1859
  /**
2425
- * The model settings for the agent.
1860
+ * Body param: Environment variables as a JSON string to pass to the agent for tool
1861
+ * execution.
2426
1862
  */
2427
- model_settings?:
2428
- | AgentModifyParams.OpenAIModelSettings
2429
- | AgentModifyParams.AnthropicModelSettings
2430
- | AgentModifyParams.GoogleAIModelSettings
2431
- | AgentModifyParams.GoogleVertexModelSettings
2432
- | AgentModifyParams.AzureModelSettings
2433
- | AgentModifyParams.XaiModelSettings
2434
- | AgentModifyParams.GroqModelSettings
2435
- | AgentModifyParams.DeepseekModelSettings
2436
- | AgentModifyParams.TogetherModelSettings
2437
- | AgentModifyParams.BedrockModelSettings
2438
- | null;
1863
+ env_vars_json?: string | null;
2439
1864
 
2440
1865
  /**
2441
- * The name of the agent.
1866
+ * Body param: Override import with specific embedding handle.
2442
1867
  */
2443
- name?: string | null;
1868
+ override_embedding_handle?: string | null;
2444
1869
 
2445
1870
  /**
2446
- * @deprecated Deprecated: Use `model` field to configure parallel tool calls
2447
- * instead. If set to True, enables parallel tool calling.
1871
+ * Body param: If set to True, existing tools can get their source code overwritten
1872
+ * by the uploaded tool definitions. Note that Letta core tools can never be
1873
+ * updated externally.
2448
1874
  */
2449
- parallel_tool_calls?: boolean | null;
1875
+ override_existing_tools?: boolean;
2450
1876
 
2451
1877
  /**
2452
- * The per-file view window character limit for this agent. Setting this too high
2453
- * may exceed the context window, which will break the agent.
1878
+ * Body param: If provided, overrides the agent name with this value.
2454
1879
  */
2455
- per_file_view_window_char_limit?: number | null;
1880
+ override_name?: string | null;
2456
1881
 
2457
1882
  /**
2458
- * The id of the project the agent belongs to.
1883
+ * Body param: The project ID to associate the uploaded agent with.
2459
1884
  */
2460
1885
  project_id?: string | null;
2461
1886
 
2462
1887
  /**
2463
- * @deprecated Deprecated: Use `model` field to configure reasoning instead.
2464
- * Whether to enable reasoning for this agent.
1888
+ * Body param: If set to True, strips all messages from the agent before importing.
2465
1889
  */
2466
- reasoning?: boolean | null;
1890
+ strip_messages?: boolean;
2467
1891
 
2468
1892
  /**
2469
- * @deprecated Deprecated: Use `model` field to configure response format instead.
2470
- * The response format for the agent.
1893
+ * Header param:
2471
1894
  */
2472
- response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
1895
+ 'x-override-embedding-model'?: string;
1896
+ }
2473
1897
 
1898
+ export interface AgentModifyParams {
2474
1899
  /**
2475
- * The environment variables for tool execution specific to this agent.
1900
+ * The base template id of the agent.
2476
1901
  */
2477
- secrets?: { [key: string]: string } | null;
1902
+ base_template_id?: string | null;
2478
1903
 
2479
1904
  /**
2480
- * The ids of the sources used by the agent.
1905
+ * The ids of the blocks used by the agent.
2481
1906
  */
2482
- source_ids?: Array<string> | null;
1907
+ block_ids?: Array<string> | null;
2483
1908
 
2484
1909
  /**
2485
- * The system prompt used by the agent.
1910
+ * The context window limit used by the agent.
2486
1911
  */
2487
- system?: string | null;
1912
+ context_window_limit?: number | null;
2488
1913
 
2489
1914
  /**
2490
- * The tags associated with the agent.
1915
+ * The description of the agent.
2491
1916
  */
2492
- tags?: Array<string> | null;
1917
+ description?: string | null;
2493
1918
 
2494
1919
  /**
2495
- * The id of the template the agent belongs to.
1920
+ * The embedding model handle used by the agent (format: provider/model-name).
2496
1921
  */
2497
- template_id?: string | null;
1922
+ embedding?: string | null;
2498
1923
 
2499
1924
  /**
2500
- * The timezone of the agent (IANA format).
1925
+ * Configuration for embedding model connection and processing parameters.
2501
1926
  */
2502
- timezone?: string | null;
1927
+ embedding_config?: ModelsAPI.EmbeddingConfig | null;
2503
1928
 
2504
1929
  /**
2505
- * Deprecated: use `secrets` field instead
1930
+ * If set to True, memory management will move to a background agent thread.
2506
1931
  */
2507
- tool_exec_environment_variables?: { [key: string]: string } | null;
1932
+ enable_sleeptime?: boolean | null;
2508
1933
 
2509
1934
  /**
2510
- * The ids of the tools used by the agent.
1935
+ * If set to True, the agent will be hidden.
2511
1936
  */
2512
- tool_ids?: Array<string> | null;
1937
+ hidden?: boolean | null;
2513
1938
 
2514
1939
  /**
2515
- * The tool rules governing the agent.
1940
+ * The ids of the identities associated with this agent.
2516
1941
  */
2517
- tool_rules?: Array<
2518
- | ChildToolRule
2519
- | InitToolRule
2520
- | TerminalToolRule
2521
- | ConditionalToolRule
2522
- | ContinueToolRule
2523
- | RequiredBeforeExitToolRule
2524
- | MaxCountPerStepToolRule
2525
- | ParentToolRule
2526
- | RequiresApprovalToolRule
2527
- > | null;
2528
- }
2529
-
2530
- export namespace AgentModifyParams {
2531
- export interface OpenAIModelSettings {
2532
- /**
2533
- * The maximum number of tokens the model can generate.
2534
- */
2535
- max_output_tokens?: number;
2536
-
2537
- /**
2538
- * Whether to enable parallel tool calling.
2539
- */
2540
- parallel_tool_calls?: boolean;
2541
-
2542
- /**
2543
- * The provider of the model.
2544
- */
2545
- provider?: 'openai';
2546
-
2547
- /**
2548
- * The reasoning configuration for the model.
2549
- */
2550
- reasoning?: OpenAIModelSettings.Reasoning;
2551
-
2552
- /**
2553
- * The response format for the model.
2554
- */
2555
- response_format?:
2556
- | AgentsAPI.TextResponseFormat
2557
- | AgentsAPI.JsonSchemaResponseFormat
2558
- | AgentsAPI.JsonObjectResponseFormat
2559
- | null;
2560
-
2561
- /**
2562
- * The temperature of the model.
2563
- */
2564
- temperature?: number;
2565
- }
2566
-
2567
- export namespace OpenAIModelSettings {
2568
- /**
2569
- * The reasoning configuration for the model.
2570
- */
2571
- export interface Reasoning {
2572
- /**
2573
- * The reasoning effort to use when generating text reasoning models
2574
- */
2575
- reasoning_effort?: 'minimal' | 'low' | 'medium' | 'high';
2576
- }
2577
- }
2578
-
2579
- export interface AnthropicModelSettings {
2580
- /**
2581
- * The maximum number of tokens the model can generate.
2582
- */
2583
- max_output_tokens?: number;
2584
-
2585
- /**
2586
- * Whether to enable parallel tool calling.
2587
- */
2588
- parallel_tool_calls?: boolean;
2589
-
2590
- /**
2591
- * The provider of the model.
2592
- */
2593
- provider?: 'anthropic';
2594
-
2595
- /**
2596
- * The temperature of the model.
2597
- */
2598
- temperature?: number;
2599
-
2600
- /**
2601
- * The thinking configuration for the model.
2602
- */
2603
- thinking?: AnthropicModelSettings.Thinking;
2604
-
2605
- /**
2606
- * Soft control for how verbose model output should be, used for GPT-5 models.
2607
- */
2608
- verbosity?: 'low' | 'medium' | 'high' | null;
2609
- }
2610
-
2611
- export namespace AnthropicModelSettings {
2612
- /**
2613
- * The thinking configuration for the model.
2614
- */
2615
- export interface Thinking {
2616
- /**
2617
- * The maximum number of tokens the model can use for extended thinking.
2618
- */
2619
- budget_tokens?: number;
2620
-
2621
- /**
2622
- * The type of thinking to use.
2623
- */
2624
- type?: 'enabled' | 'disabled';
2625
- }
2626
- }
2627
-
2628
- export interface GoogleAIModelSettings {
2629
- /**
2630
- * The maximum number of tokens the model can generate.
2631
- */
2632
- max_output_tokens?: number;
2633
-
2634
- /**
2635
- * Whether to enable parallel tool calling.
2636
- */
2637
- parallel_tool_calls?: boolean;
2638
-
2639
- /**
2640
- * The provider of the model.
2641
- */
2642
- provider?: 'google_ai';
2643
-
2644
- /**
2645
- * The response schema for the model.
2646
- */
2647
- response_schema?:
2648
- | AgentsAPI.TextResponseFormat
2649
- | AgentsAPI.JsonSchemaResponseFormat
2650
- | AgentsAPI.JsonObjectResponseFormat
2651
- | null;
2652
-
2653
- /**
2654
- * The temperature of the model.
2655
- */
2656
- temperature?: number;
2657
-
2658
- /**
2659
- * The thinking configuration for the model.
2660
- */
2661
- thinking_config?: GoogleAIModelSettings.ThinkingConfig;
2662
- }
2663
-
2664
- export namespace GoogleAIModelSettings {
2665
- /**
2666
- * The thinking configuration for the model.
2667
- */
2668
- export interface ThinkingConfig {
2669
- /**
2670
- * Whether to include thoughts in the model's response.
2671
- */
2672
- include_thoughts?: boolean;
2673
-
2674
- /**
2675
- * The thinking budget for the model.
2676
- */
2677
- thinking_budget?: number;
2678
- }
2679
- }
2680
-
2681
- export interface GoogleVertexModelSettings {
2682
- /**
2683
- * The maximum number of tokens the model can generate.
2684
- */
2685
- max_output_tokens?: number;
2686
-
2687
- /**
2688
- * Whether to enable parallel tool calling.
2689
- */
2690
- parallel_tool_calls?: boolean;
2691
-
2692
- /**
2693
- * The provider of the model.
2694
- */
2695
- provider?: 'google_vertex';
2696
-
2697
- /**
2698
- * The response schema for the model.
2699
- */
2700
- response_schema?:
2701
- | AgentsAPI.TextResponseFormat
2702
- | AgentsAPI.JsonSchemaResponseFormat
2703
- | AgentsAPI.JsonObjectResponseFormat
2704
- | null;
2705
-
2706
- /**
2707
- * The temperature of the model.
2708
- */
2709
- temperature?: number;
2710
-
2711
- /**
2712
- * The thinking configuration for the model.
2713
- */
2714
- thinking_config?: GoogleVertexModelSettings.ThinkingConfig;
2715
- }
2716
-
2717
- export namespace GoogleVertexModelSettings {
2718
- /**
2719
- * The thinking configuration for the model.
2720
- */
2721
- export interface ThinkingConfig {
2722
- /**
2723
- * Whether to include thoughts in the model's response.
2724
- */
2725
- include_thoughts?: boolean;
2726
-
2727
- /**
2728
- * The thinking budget for the model.
2729
- */
2730
- thinking_budget?: number;
2731
- }
2732
- }
1942
+ identity_ids?: Array<string> | null;
2733
1943
 
2734
1944
  /**
2735
- * Azure OpenAI model configuration (OpenAI-compatible).
1945
+ * The timestamp when the agent last completed a run.
2736
1946
  */
2737
- export interface AzureModelSettings {
2738
- /**
2739
- * The maximum number of tokens the model can generate.
2740
- */
2741
- max_output_tokens?: number;
2742
-
2743
- /**
2744
- * Whether to enable parallel tool calling.
2745
- */
2746
- parallel_tool_calls?: boolean;
2747
-
2748
- /**
2749
- * The provider of the model.
2750
- */
2751
- provider?: 'azure';
2752
-
2753
- /**
2754
- * The response format for the model.
2755
- */
2756
- response_format?:
2757
- | AgentsAPI.TextResponseFormat
2758
- | AgentsAPI.JsonSchemaResponseFormat
2759
- | AgentsAPI.JsonObjectResponseFormat
2760
- | null;
1947
+ last_run_completion?: string | null;
2761
1948
 
2762
- /**
2763
- * The temperature of the model.
2764
- */
2765
- temperature?: number;
2766
- }
1949
+ /**
1950
+ * The duration in milliseconds of the agent's last run.
1951
+ */
1952
+ last_run_duration_ms?: number | null;
2767
1953
 
2768
1954
  /**
2769
- * xAI model configuration (OpenAI-compatible).
1955
+ * The stop reason from the agent's last run.
2770
1956
  */
2771
- export interface XaiModelSettings {
2772
- /**
2773
- * The maximum number of tokens the model can generate.
2774
- */
2775
- max_output_tokens?: number;
2776
-
2777
- /**
2778
- * Whether to enable parallel tool calling.
2779
- */
2780
- parallel_tool_calls?: boolean;
1957
+ last_stop_reason?: RunsAPI.StopReasonType | null;
2781
1958
 
2782
- /**
2783
- * The provider of the model.
2784
- */
2785
- provider?: 'xai';
1959
+ /**
1960
+ * Configuration for Language Model (LLM) connection and generation parameters.
1961
+ */
1962
+ llm_config?: ModelsAPI.LlmConfig | null;
2786
1963
 
2787
- /**
2788
- * The response format for the model.
2789
- */
2790
- response_format?:
2791
- | AgentsAPI.TextResponseFormat
2792
- | AgentsAPI.JsonSchemaResponseFormat
2793
- | AgentsAPI.JsonObjectResponseFormat
2794
- | null;
1964
+ /**
1965
+ * Maximum number of files that can be open at once for this agent. Setting this
1966
+ * too high may exceed the context window, which will break the agent.
1967
+ */
1968
+ max_files_open?: number | null;
2795
1969
 
2796
- /**
2797
- * The temperature of the model.
2798
- */
2799
- temperature?: number;
2800
- }
1970
+ /**
1971
+ * @deprecated Deprecated: Use `model` field to configure max output tokens
1972
+ * instead. The maximum number of tokens to generate, including reasoning step.
1973
+ */
1974
+ max_tokens?: number | null;
2801
1975
 
2802
1976
  /**
2803
- * Groq model configuration (OpenAI-compatible).
1977
+ * If set to True, the agent will not remember previous messages (though the agent
1978
+ * will still retain state via core memory blocks and archival/recall memory). Not
1979
+ * recommended unless you have an advanced use case.
2804
1980
  */
2805
- export interface GroqModelSettings {
2806
- /**
2807
- * The maximum number of tokens the model can generate.
2808
- */
2809
- max_output_tokens?: number;
1981
+ message_buffer_autoclear?: boolean | null;
2810
1982
 
2811
- /**
2812
- * Whether to enable parallel tool calling.
2813
- */
2814
- parallel_tool_calls?: boolean;
1983
+ /**
1984
+ * The ids of the messages in the agent's in-context memory.
1985
+ */
1986
+ message_ids?: Array<string> | null;
2815
1987
 
2816
- /**
2817
- * The provider of the model.
2818
- */
2819
- provider?: 'groq';
1988
+ /**
1989
+ * The metadata of the agent.
1990
+ */
1991
+ metadata?: { [key: string]: unknown } | null;
2820
1992
 
2821
- /**
2822
- * The response format for the model.
2823
- */
2824
- response_format?:
2825
- | AgentsAPI.TextResponseFormat
2826
- | AgentsAPI.JsonSchemaResponseFormat
2827
- | AgentsAPI.JsonObjectResponseFormat
2828
- | null;
1993
+ /**
1994
+ * The model handle used by the agent (format: provider/model-name).
1995
+ */
1996
+ model?: string | null;
2829
1997
 
2830
- /**
2831
- * The temperature of the model.
2832
- */
2833
- temperature?: number;
2834
- }
1998
+ /**
1999
+ * The model settings for the agent.
2000
+ */
2001
+ model_settings?:
2002
+ | OpenAIModelSettings
2003
+ | AnthropicModelSettings
2004
+ | GoogleAIModelSettings
2005
+ | GoogleVertexModelSettings
2006
+ | AzureModelSettings
2007
+ | XaiModelSettings
2008
+ | GroqModelSettings
2009
+ | DeepseekModelSettings
2010
+ | TogetherModelSettings
2011
+ | BedrockModelSettings
2012
+ | null;
2835
2013
 
2836
2014
  /**
2837
- * Deepseek model configuration (OpenAI-compatible).
2015
+ * The name of the agent.
2838
2016
  */
2839
- export interface DeepseekModelSettings {
2840
- /**
2841
- * The maximum number of tokens the model can generate.
2842
- */
2843
- max_output_tokens?: number;
2017
+ name?: string | null;
2844
2018
 
2845
- /**
2846
- * Whether to enable parallel tool calling.
2847
- */
2848
- parallel_tool_calls?: boolean;
2019
+ /**
2020
+ * @deprecated Deprecated: Use `model` field to configure parallel tool calls
2021
+ * instead. If set to True, enables parallel tool calling.
2022
+ */
2023
+ parallel_tool_calls?: boolean | null;
2849
2024
 
2850
- /**
2851
- * The provider of the model.
2852
- */
2853
- provider?: 'deepseek';
2025
+ /**
2026
+ * The per-file view window character limit for this agent. Setting this too high
2027
+ * may exceed the context window, which will break the agent.
2028
+ */
2029
+ per_file_view_window_char_limit?: number | null;
2854
2030
 
2855
- /**
2856
- * The response format for the model.
2857
- */
2858
- response_format?:
2859
- | AgentsAPI.TextResponseFormat
2860
- | AgentsAPI.JsonSchemaResponseFormat
2861
- | AgentsAPI.JsonObjectResponseFormat
2862
- | null;
2031
+ /**
2032
+ * The id of the project the agent belongs to.
2033
+ */
2034
+ project_id?: string | null;
2863
2035
 
2864
- /**
2865
- * The temperature of the model.
2866
- */
2867
- temperature?: number;
2868
- }
2036
+ /**
2037
+ * @deprecated Deprecated: Use `model` field to configure reasoning instead.
2038
+ * Whether to enable reasoning for this agent.
2039
+ */
2040
+ reasoning?: boolean | null;
2869
2041
 
2870
2042
  /**
2871
- * Together AI model configuration (OpenAI-compatible).
2043
+ * @deprecated Deprecated: Use `model` field to configure response format instead.
2044
+ * The response format for the agent.
2872
2045
  */
2873
- export interface TogetherModelSettings {
2874
- /**
2875
- * The maximum number of tokens the model can generate.
2876
- */
2877
- max_output_tokens?: number;
2046
+ response_format?: TextResponseFormat | JsonSchemaResponseFormat | JsonObjectResponseFormat | null;
2878
2047
 
2879
- /**
2880
- * Whether to enable parallel tool calling.
2881
- */
2882
- parallel_tool_calls?: boolean;
2048
+ /**
2049
+ * The environment variables for tool execution specific to this agent.
2050
+ */
2051
+ secrets?: { [key: string]: string } | null;
2883
2052
 
2884
- /**
2885
- * The provider of the model.
2886
- */
2887
- provider?: 'together';
2053
+ /**
2054
+ * The ids of the sources used by the agent.
2055
+ */
2056
+ source_ids?: Array<string> | null;
2888
2057
 
2889
- /**
2890
- * The response format for the model.
2891
- */
2892
- response_format?:
2893
- | AgentsAPI.TextResponseFormat
2894
- | AgentsAPI.JsonSchemaResponseFormat
2895
- | AgentsAPI.JsonObjectResponseFormat
2896
- | null;
2058
+ /**
2059
+ * The system prompt used by the agent.
2060
+ */
2061
+ system?: string | null;
2897
2062
 
2898
- /**
2899
- * The temperature of the model.
2900
- */
2901
- temperature?: number;
2902
- }
2063
+ /**
2064
+ * The tags associated with the agent.
2065
+ */
2066
+ tags?: Array<string> | null;
2903
2067
 
2904
2068
  /**
2905
- * AWS Bedrock model configuration.
2069
+ * The id of the template the agent belongs to.
2906
2070
  */
2907
- export interface BedrockModelSettings {
2908
- /**
2909
- * The maximum number of tokens the model can generate.
2910
- */
2911
- max_output_tokens?: number;
2071
+ template_id?: string | null;
2912
2072
 
2913
- /**
2914
- * Whether to enable parallel tool calling.
2915
- */
2916
- parallel_tool_calls?: boolean;
2073
+ /**
2074
+ * The timezone of the agent (IANA format).
2075
+ */
2076
+ timezone?: string | null;
2917
2077
 
2918
- /**
2919
- * The provider of the model.
2920
- */
2921
- provider?: 'bedrock';
2078
+ /**
2079
+ * Deprecated: use `secrets` field instead
2080
+ */
2081
+ tool_exec_environment_variables?: { [key: string]: string } | null;
2922
2082
 
2923
- /**
2924
- * The response format for the model.
2925
- */
2926
- response_format?:
2927
- | AgentsAPI.TextResponseFormat
2928
- | AgentsAPI.JsonSchemaResponseFormat
2929
- | AgentsAPI.JsonObjectResponseFormat
2930
- | null;
2083
+ /**
2084
+ * The ids of the tools used by the agent.
2085
+ */
2086
+ tool_ids?: Array<string> | null;
2931
2087
 
2932
- /**
2933
- * The temperature of the model.
2934
- */
2935
- temperature?: number;
2936
- }
2088
+ /**
2089
+ * The tool rules governing the agent.
2090
+ */
2091
+ tool_rules?: Array<
2092
+ | ChildToolRule
2093
+ | InitToolRule
2094
+ | TerminalToolRule
2095
+ | ConditionalToolRule
2096
+ | ContinueToolRule
2097
+ | RequiredBeforeExitToolRule
2098
+ | MaxCountPerStepToolRule
2099
+ | ParentToolRule
2100
+ | RequiresApprovalToolRule
2101
+ > | null;
2937
2102
  }
2938
2103
 
2104
+ Agents.Messages = Messages;
2105
+ Agents.Blocks = Blocks;
2939
2106
  Agents.Tools = Tools;
2940
2107
  Agents.Folders = Folders;
2941
2108
  Agents.Files = Files;
2942
- Agents.Blocks = Blocks;
2943
2109
  Agents.Groups = Groups;
2944
- Agents.Messages = Messages;
2110
+ Agents.Archives = Archives;
2111
+ Agents.Identities = Identities;
2945
2112
 
2946
2113
  export declare namespace Agents {
2947
2114
  export {
2948
2115
  type AgentEnvironmentVariable as AgentEnvironmentVariable,
2949
2116
  type AgentState as AgentState,
2950
2117
  type AgentType as AgentType,
2118
+ type AnthropicModelSettings as AnthropicModelSettings,
2119
+ type AzureModelSettings as AzureModelSettings,
2120
+ type BedrockModelSettings as BedrockModelSettings,
2951
2121
  type ChildToolRule as ChildToolRule,
2952
2122
  type ConditionalToolRule as ConditionalToolRule,
2953
2123
  type ContinueToolRule as ContinueToolRule,
2124
+ type DeepseekModelSettings as DeepseekModelSettings,
2125
+ type GoogleAIModelSettings as GoogleAIModelSettings,
2126
+ type GoogleVertexModelSettings as GoogleVertexModelSettings,
2127
+ type GroqModelSettings as GroqModelSettings,
2954
2128
  type InitToolRule as InitToolRule,
2955
2129
  type JsonObjectResponseFormat as JsonObjectResponseFormat,
2956
2130
  type JsonSchemaResponseFormat as JsonSchemaResponseFormat,
2957
2131
  type LettaMessageContentUnion as LettaMessageContentUnion,
2958
2132
  type MaxCountPerStepToolRule as MaxCountPerStepToolRule,
2959
2133
  type MessageCreate as MessageCreate,
2134
+ type OpenAIModelSettings as OpenAIModelSettings,
2960
2135
  type ParentToolRule as ParentToolRule,
2961
2136
  type RequiredBeforeExitToolRule as RequiredBeforeExitToolRule,
2962
2137
  type RequiresApprovalToolRule as RequiresApprovalToolRule,
2963
2138
  type TerminalToolRule as TerminalToolRule,
2964
2139
  type TextResponseFormat as TextResponseFormat,
2140
+ type TogetherModelSettings as TogetherModelSettings,
2141
+ type XaiModelSettings as XaiModelSettings,
2965
2142
  type AgentDeleteResponse as AgentDeleteResponse,
2966
2143
  type AgentExportFileResponse as AgentExportFileResponse,
2967
2144
  type AgentImportFileResponse as AgentImportFileResponse,
@@ -2974,61 +2151,20 @@ export declare namespace Agents {
2974
2151
  type AgentModifyParams as AgentModifyParams,
2975
2152
  };
2976
2153
 
2977
- export {
2978
- Tools as Tools,
2979
- type ToolListParams as ToolListParams,
2980
- type ToolAttachParams as ToolAttachParams,
2981
- type ToolDetachParams as ToolDetachParams,
2982
- type ToolUpdateApprovalParams as ToolUpdateApprovalParams,
2983
- };
2984
-
2985
- export {
2986
- Folders as Folders,
2987
- type FolderListResponse as FolderListResponse,
2988
- type FolderListResponsesArrayPage as FolderListResponsesArrayPage,
2989
- type FolderListParams as FolderListParams,
2990
- type FolderAttachParams as FolderAttachParams,
2991
- type FolderDetachParams as FolderDetachParams,
2992
- };
2993
-
2994
- export {
2995
- Files as Files,
2996
- type FileListResponse as FileListResponse,
2997
- type FileCloseResponse as FileCloseResponse,
2998
- type FileCloseAllResponse as FileCloseAllResponse,
2999
- type FileOpenResponse as FileOpenResponse,
3000
- type FileListResponsesNextFilesPage as FileListResponsesNextFilesPage,
3001
- type FileListParams as FileListParams,
3002
- type FileCloseParams as FileCloseParams,
3003
- type FileOpenParams as FileOpenParams,
3004
- };
3005
-
3006
- export {
3007
- Blocks as Blocks,
3008
- type Block as Block,
3009
- type BlockModify as BlockModify,
3010
- type BlockRetrieveParams as BlockRetrieveParams,
3011
- type BlockListParams as BlockListParams,
3012
- type BlockAttachParams as BlockAttachParams,
3013
- type BlockDetachParams as BlockDetachParams,
3014
- type BlockModifyParams as BlockModifyParams,
3015
- };
3016
-
3017
- export { Groups as Groups, type GroupListParams as GroupListParams };
3018
-
3019
2154
  export {
3020
2155
  Messages as Messages,
3021
2156
  type ApprovalCreate as ApprovalCreate,
3022
2157
  type ApprovalRequestMessage as ApprovalRequestMessage,
3023
2158
  type ApprovalResponseMessage as ApprovalResponseMessage,
2159
+ type ApprovalReturn as ApprovalReturn,
3024
2160
  type AssistantMessage as AssistantMessage,
3025
2161
  type EventMessage as EventMessage,
3026
2162
  type HiddenReasoningMessage as HiddenReasoningMessage,
3027
2163
  type ImageContent as ImageContent,
2164
+ type InternalMessage as InternalMessage,
3028
2165
  type JobStatus as JobStatus,
3029
2166
  type JobType as JobType,
3030
2167
  type LettaAssistantMessageContentUnion as LettaAssistantMessageContentUnion,
3031
- type LettaMessageUnion as LettaMessageUnion,
3032
2168
  type LettaRequest as LettaRequest,
3033
2169
  type LettaResponse as LettaResponse,
3034
2170
  type LettaStreamingRequest as LettaStreamingRequest,
@@ -3058,7 +2194,7 @@ export declare namespace Agents {
3058
2194
  type UserMessage as UserMessage,
3059
2195
  type MessageCancelResponse as MessageCancelResponse,
3060
2196
  type MessageModifyResponse as MessageModifyResponse,
3061
- type LettaMessageUnionsArrayPage as LettaMessageUnionsArrayPage,
2197
+ type MessagesArrayPage as MessagesArrayPage,
3062
2198
  type MessageListParams as MessageListParams,
3063
2199
  type MessageCancelParams as MessageCancelParams,
3064
2200
  type MessageModifyParams as MessageModifyParams,
@@ -3069,4 +2205,62 @@ export declare namespace Agents {
3069
2205
  type MessageSendAsyncParams as MessageSendAsyncParams,
3070
2206
  type MessageStreamParams as MessageStreamParams,
3071
2207
  };
2208
+
2209
+ export {
2210
+ Blocks as Blocks,
2211
+ type Block as Block,
2212
+ type BlockModify as BlockModify,
2213
+ type BlockRetrieveParams as BlockRetrieveParams,
2214
+ type BlockListParams as BlockListParams,
2215
+ type BlockAttachParams as BlockAttachParams,
2216
+ type BlockDetachParams as BlockDetachParams,
2217
+ type BlockModifyParams as BlockModifyParams,
2218
+ };
2219
+
2220
+ export {
2221
+ Tools as Tools,
2222
+ type ToolListParams as ToolListParams,
2223
+ type ToolAttachParams as ToolAttachParams,
2224
+ type ToolDetachParams as ToolDetachParams,
2225
+ type ToolUpdateApprovalParams as ToolUpdateApprovalParams,
2226
+ };
2227
+
2228
+ export {
2229
+ Folders as Folders,
2230
+ type FolderListResponse as FolderListResponse,
2231
+ type FolderListResponsesArrayPage as FolderListResponsesArrayPage,
2232
+ type FolderListParams as FolderListParams,
2233
+ type FolderAttachParams as FolderAttachParams,
2234
+ type FolderDetachParams as FolderDetachParams,
2235
+ };
2236
+
2237
+ export {
2238
+ Files as Files,
2239
+ type FileListResponse as FileListResponse,
2240
+ type FileCloseResponse as FileCloseResponse,
2241
+ type FileCloseAllResponse as FileCloseAllResponse,
2242
+ type FileOpenResponse as FileOpenResponse,
2243
+ type FileListResponsesNextFilesPage as FileListResponsesNextFilesPage,
2244
+ type FileListParams as FileListParams,
2245
+ type FileCloseParams as FileCloseParams,
2246
+ type FileOpenParams as FileOpenParams,
2247
+ };
2248
+
2249
+ export { Groups as Groups, type GroupListParams as GroupListParams };
2250
+
2251
+ export {
2252
+ Archives as Archives,
2253
+ type ArchiveAttachResponse as ArchiveAttachResponse,
2254
+ type ArchiveDetachResponse as ArchiveDetachResponse,
2255
+ type ArchiveAttachParams as ArchiveAttachParams,
2256
+ type ArchiveDetachParams as ArchiveDetachParams,
2257
+ };
2258
+
2259
+ export {
2260
+ Identities as Identities,
2261
+ type IdentityAttachResponse as IdentityAttachResponse,
2262
+ type IdentityDetachResponse as IdentityDetachResponse,
2263
+ type IdentityAttachParams as IdentityAttachParams,
2264
+ type IdentityDetachParams as IdentityDetachParams,
2265
+ };
3072
2266
  }