@letta-ai/letta-client 1.0.0-alpha.3 → 1.0.0-alpha.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/resources/agents/client/Client.d.ts +8 -8
- package/api/resources/agents/client/Client.js +17 -17
- package/api/resources/agents/client/requests/CreateAgentRequest.d.ts +2 -0
- package/api/resources/agents/client/requests/UpdateAgent.d.ts +2 -0
- package/api/resources/agents/resources/blocks/client/Client.d.ts +12 -12
- package/api/resources/agents/resources/blocks/client/Client.js +17 -17
- package/api/resources/agents/resources/context/client/Client.d.ts +2 -2
- package/api/resources/agents/resources/context/client/Client.js +3 -3
- package/api/resources/agents/resources/coreMemory/client/Client.d.ts +2 -2
- package/api/resources/agents/resources/coreMemory/client/Client.js +3 -3
- package/api/resources/agents/resources/files/client/Client.d.ts +10 -10
- package/api/resources/agents/resources/files/client/Client.js +14 -14
- package/api/resources/agents/resources/folders/client/Client.d.ts +8 -8
- package/api/resources/agents/resources/folders/client/Client.js +11 -11
- package/api/resources/agents/resources/groups/client/Client.d.ts +2 -2
- package/api/resources/agents/resources/groups/client/Client.js +3 -3
- package/api/resources/agents/resources/memoryVariables/client/Client.js +1 -1
- package/api/resources/agents/resources/messages/client/Client.d.ts +17 -17
- package/api/resources/agents/resources/messages/client/Client.js +27 -27
- package/api/resources/agents/resources/passages/client/Client.d.ts +8 -8
- package/api/resources/agents/resources/passages/client/Client.js +13 -13
- package/api/resources/agents/resources/sources/client/Client.d.ts +8 -8
- package/api/resources/agents/resources/sources/client/Client.js +11 -11
- package/api/resources/agents/resources/tools/client/Client.d.ts +10 -10
- package/api/resources/agents/resources/tools/client/Client.js +14 -14
- package/api/resources/archives/client/Client.d.ts +2 -2
- package/api/resources/archives/client/Client.js +5 -5
- package/api/resources/batches/client/Client.js +4 -4
- package/api/resources/batches/resources/messages/client/Client.js +1 -1
- package/api/resources/blocks/client/Client.d.ts +6 -6
- package/api/resources/blocks/client/Client.js +12 -12
- package/api/resources/blocks/resources/agents/client/Client.d.ts +2 -2
- package/api/resources/blocks/resources/agents/client/Client.js +3 -3
- package/api/resources/chat/client/Client.js +1 -1
- package/api/resources/clientSideAccessTokens/client/Client.js +3 -3
- package/api/resources/folders/client/Client.js +8 -8
- package/api/resources/folders/resources/agents/client/Client.js +1 -1
- package/api/resources/folders/resources/files/client/Client.js +3 -3
- package/api/resources/folders/resources/passages/client/Client.js +1 -1
- package/api/resources/groups/client/Client.d.ts +6 -6
- package/api/resources/groups/client/Client.js +12 -12
- package/api/resources/groups/resources/messages/client/Client.d.ts +9 -9
- package/api/resources/groups/resources/messages/client/Client.js +14 -14
- package/api/resources/health/client/Client.js +1 -1
- package/api/resources/identities/client/Client.d.ts +6 -6
- package/api/resources/identities/client/Client.js +13 -13
- package/api/resources/identities/resources/agents/client/Client.d.ts +2 -2
- package/api/resources/identities/resources/agents/client/Client.js +3 -3
- package/api/resources/identities/resources/blocks/client/Client.d.ts +2 -2
- package/api/resources/identities/resources/blocks/client/Client.js +3 -3
- package/api/resources/identities/resources/properties/client/Client.d.ts +2 -2
- package/api/resources/identities/resources/properties/client/Client.js +3 -3
- package/api/resources/jobs/client/Client.d.ts +6 -6
- package/api/resources/jobs/client/Client.js +11 -11
- package/api/resources/models/client/Client.js +2 -2
- package/api/resources/models/resources/embeddings/client/Client.js +1 -1
- package/api/resources/projects/client/Client.js +1 -1
- package/api/resources/providers/client/Client.d.ts +8 -8
- package/api/resources/providers/client/Client.js +15 -15
- package/api/resources/runs/client/Client.js +6 -6
- package/api/resources/runs/resources/messages/client/Client.js +1 -1
- package/api/resources/runs/resources/steps/client/Client.js +1 -1
- package/api/resources/runs/resources/usage/client/Client.js +1 -1
- package/api/resources/sources/client/Client.d.ts +11 -11
- package/api/resources/sources/client/Client.js +21 -21
- package/api/resources/sources/resources/files/client/Client.d.ts +6 -6
- package/api/resources/sources/resources/files/client/Client.js +9 -9
- package/api/resources/sources/resources/passages/client/Client.d.ts +2 -2
- package/api/resources/sources/resources/passages/client/Client.js +3 -3
- package/api/resources/steps/client/Client.d.ts +2 -2
- package/api/resources/steps/client/Client.js +4 -4
- package/api/resources/steps/resources/feedback/client/Client.d.ts +2 -2
- package/api/resources/steps/resources/feedback/client/Client.js +3 -3
- package/api/resources/steps/resources/messages/client/Client.d.ts +2 -2
- package/api/resources/steps/resources/messages/client/Client.js +3 -3
- package/api/resources/steps/resources/metrics/client/Client.d.ts +2 -2
- package/api/resources/steps/resources/metrics/client/Client.js +3 -3
- package/api/resources/steps/resources/trace/client/Client.d.ts +2 -2
- package/api/resources/steps/resources/trace/client/Client.js +3 -3
- package/api/resources/tags/client/Client.js +1 -1
- package/api/resources/telemetry/client/Client.js +1 -1
- package/api/resources/templates/client/Client.js +13 -13
- package/api/resources/templates/resources/agents/client/Client.js +1 -1
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.d.ts +1 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.d.ts +5 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.js +5 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.d.ts +4 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.js +5 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.d.ts +1 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.d.ts +5 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.js +5 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.d.ts +4 -0
- package/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.js +5 -0
- package/api/resources/templates/types/index.d.ts +4 -0
- package/api/resources/templates/types/index.js +4 -0
- package/api/resources/tools/client/Client.d.ts +6 -6
- package/api/resources/tools/client/Client.js +23 -23
- package/api/resources/tools/client/requests/ToolUpdate.d.ts +2 -0
- package/api/resources/voice/client/Client.js +1 -1
- package/api/types/ApprovalRequestMessage.d.ts +4 -0
- package/api/types/ApprovalRequestMessageAllowedToolCalls.d.ts +8 -0
- package/api/types/ApprovalRequestMessageAllowedToolCalls.js +5 -0
- package/api/types/ApprovalRequestMessageRequestedToolCalls.d.ts +8 -0
- package/api/types/ApprovalRequestMessageRequestedToolCalls.js +5 -0
- package/api/types/InternalTemplateAgentCreate.d.ts +2 -0
- package/api/types/LettaSchemasAgentFileAgentSchema.d.ts +2 -0
- package/api/types/LettaSchemasAgentFileToolSchema.d.ts +2 -0
- package/api/types/LlmConfig.d.ts +2 -0
- package/api/types/RunMetrics.d.ts +2 -0
- package/api/types/Tool.d.ts +2 -0
- package/api/types/ToolCreate.d.ts +2 -0
- package/api/types/index.d.ts +2 -0
- package/api/types/index.js +2 -0
- package/dist/api/resources/agents/client/Client.d.ts +8 -8
- package/dist/api/resources/agents/client/Client.js +17 -17
- package/dist/api/resources/agents/client/requests/CreateAgentRequest.d.ts +2 -0
- package/dist/api/resources/agents/client/requests/UpdateAgent.d.ts +2 -0
- package/dist/api/resources/agents/resources/blocks/client/Client.d.ts +12 -12
- package/dist/api/resources/agents/resources/blocks/client/Client.js +17 -17
- package/dist/api/resources/agents/resources/context/client/Client.d.ts +2 -2
- package/dist/api/resources/agents/resources/context/client/Client.js +3 -3
- package/dist/api/resources/agents/resources/coreMemory/client/Client.d.ts +2 -2
- package/dist/api/resources/agents/resources/coreMemory/client/Client.js +3 -3
- package/dist/api/resources/agents/resources/files/client/Client.d.ts +10 -10
- package/dist/api/resources/agents/resources/files/client/Client.js +14 -14
- package/dist/api/resources/agents/resources/folders/client/Client.d.ts +8 -8
- package/dist/api/resources/agents/resources/folders/client/Client.js +11 -11
- package/dist/api/resources/agents/resources/groups/client/Client.d.ts +2 -2
- package/dist/api/resources/agents/resources/groups/client/Client.js +3 -3
- package/dist/api/resources/agents/resources/memoryVariables/client/Client.js +1 -1
- package/dist/api/resources/agents/resources/messages/client/Client.d.ts +17 -17
- package/dist/api/resources/agents/resources/messages/client/Client.js +27 -27
- package/dist/api/resources/agents/resources/passages/client/Client.d.ts +8 -8
- package/dist/api/resources/agents/resources/passages/client/Client.js +13 -13
- package/dist/api/resources/agents/resources/sources/client/Client.d.ts +8 -8
- package/dist/api/resources/agents/resources/sources/client/Client.js +11 -11
- package/dist/api/resources/agents/resources/tools/client/Client.d.ts +10 -10
- package/dist/api/resources/agents/resources/tools/client/Client.js +14 -14
- package/dist/api/resources/archives/client/Client.d.ts +2 -2
- package/dist/api/resources/archives/client/Client.js +5 -5
- package/dist/api/resources/batches/client/Client.js +4 -4
- package/dist/api/resources/batches/resources/messages/client/Client.js +1 -1
- package/dist/api/resources/blocks/client/Client.d.ts +6 -6
- package/dist/api/resources/blocks/client/Client.js +12 -12
- package/dist/api/resources/blocks/resources/agents/client/Client.d.ts +2 -2
- package/dist/api/resources/blocks/resources/agents/client/Client.js +3 -3
- package/dist/api/resources/chat/client/Client.js +1 -1
- package/dist/api/resources/clientSideAccessTokens/client/Client.js +3 -3
- package/dist/api/resources/folders/client/Client.js +8 -8
- package/dist/api/resources/folders/resources/agents/client/Client.js +1 -1
- package/dist/api/resources/folders/resources/files/client/Client.js +3 -3
- package/dist/api/resources/folders/resources/passages/client/Client.js +1 -1
- package/dist/api/resources/groups/client/Client.d.ts +6 -6
- package/dist/api/resources/groups/client/Client.js +12 -12
- package/dist/api/resources/groups/resources/messages/client/Client.d.ts +9 -9
- package/dist/api/resources/groups/resources/messages/client/Client.js +14 -14
- package/dist/api/resources/health/client/Client.js +1 -1
- package/dist/api/resources/identities/client/Client.d.ts +6 -6
- package/dist/api/resources/identities/client/Client.js +13 -13
- package/dist/api/resources/identities/resources/agents/client/Client.d.ts +2 -2
- package/dist/api/resources/identities/resources/agents/client/Client.js +3 -3
- package/dist/api/resources/identities/resources/blocks/client/Client.d.ts +2 -2
- package/dist/api/resources/identities/resources/blocks/client/Client.js +3 -3
- package/dist/api/resources/identities/resources/properties/client/Client.d.ts +2 -2
- package/dist/api/resources/identities/resources/properties/client/Client.js +3 -3
- package/dist/api/resources/jobs/client/Client.d.ts +6 -6
- package/dist/api/resources/jobs/client/Client.js +11 -11
- package/dist/api/resources/models/client/Client.js +2 -2
- package/dist/api/resources/models/resources/embeddings/client/Client.js +1 -1
- package/dist/api/resources/projects/client/Client.js +1 -1
- package/dist/api/resources/providers/client/Client.d.ts +8 -8
- package/dist/api/resources/providers/client/Client.js +15 -15
- package/dist/api/resources/runs/client/Client.js +6 -6
- package/dist/api/resources/runs/resources/messages/client/Client.js +1 -1
- package/dist/api/resources/runs/resources/steps/client/Client.js +1 -1
- package/dist/api/resources/runs/resources/usage/client/Client.js +1 -1
- package/dist/api/resources/sources/client/Client.d.ts +11 -11
- package/dist/api/resources/sources/client/Client.js +21 -21
- package/dist/api/resources/sources/resources/files/client/Client.d.ts +6 -6
- package/dist/api/resources/sources/resources/files/client/Client.js +9 -9
- package/dist/api/resources/sources/resources/passages/client/Client.d.ts +2 -2
- package/dist/api/resources/sources/resources/passages/client/Client.js +3 -3
- package/dist/api/resources/steps/client/Client.d.ts +2 -2
- package/dist/api/resources/steps/client/Client.js +4 -4
- package/dist/api/resources/steps/resources/feedback/client/Client.d.ts +2 -2
- package/dist/api/resources/steps/resources/feedback/client/Client.js +3 -3
- package/dist/api/resources/steps/resources/messages/client/Client.d.ts +2 -2
- package/dist/api/resources/steps/resources/messages/client/Client.js +3 -3
- package/dist/api/resources/steps/resources/metrics/client/Client.d.ts +2 -2
- package/dist/api/resources/steps/resources/metrics/client/Client.js +3 -3
- package/dist/api/resources/steps/resources/trace/client/Client.d.ts +2 -2
- package/dist/api/resources/steps/resources/trace/client/Client.js +3 -3
- package/dist/api/resources/tags/client/Client.js +1 -1
- package/dist/api/resources/telemetry/client/Client.js +1 -1
- package/dist/api/resources/templates/client/Client.js +13 -13
- package/dist/api/resources/templates/resources/agents/client/Client.js +1 -1
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.d.ts +1 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.d.ts +5 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.js +5 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.d.ts +4 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.js +5 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.d.ts +1 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.d.ts +5 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.js +5 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.d.ts +4 -0
- package/dist/api/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.js +5 -0
- package/dist/api/resources/templates/types/index.d.ts +4 -0
- package/dist/api/resources/templates/types/index.js +4 -0
- package/dist/api/resources/tools/client/Client.d.ts +6 -6
- package/dist/api/resources/tools/client/Client.js +23 -23
- package/dist/api/resources/tools/client/requests/ToolUpdate.d.ts +2 -0
- package/dist/api/resources/voice/client/Client.js +1 -1
- package/dist/api/types/ApprovalRequestMessage.d.ts +4 -0
- package/dist/api/types/ApprovalRequestMessageAllowedToolCalls.d.ts +8 -0
- package/dist/api/types/ApprovalRequestMessageAllowedToolCalls.js +5 -0
- package/dist/api/types/ApprovalRequestMessageRequestedToolCalls.d.ts +8 -0
- package/dist/api/types/ApprovalRequestMessageRequestedToolCalls.js +5 -0
- package/dist/api/types/InternalTemplateAgentCreate.d.ts +2 -0
- package/dist/api/types/LettaSchemasAgentFileAgentSchema.d.ts +2 -0
- package/dist/api/types/LettaSchemasAgentFileToolSchema.d.ts +2 -0
- package/dist/api/types/LlmConfig.d.ts +2 -0
- package/dist/api/types/RunMetrics.d.ts +2 -0
- package/dist/api/types/Tool.d.ts +2 -0
- package/dist/api/types/ToolCreate.d.ts +2 -0
- package/dist/api/types/index.d.ts +2 -0
- package/dist/api/types/index.js +2 -0
- package/dist/serialization/resources/agents/client/requests/CreateAgentRequest.d.ts +1 -0
- package/dist/serialization/resources/agents/client/requests/CreateAgentRequest.js +1 -0
- package/dist/serialization/resources/agents/client/requests/UpdateAgent.d.ts +1 -0
- package/dist/serialization/resources/agents/client/requests/UpdateAgent.js +1 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.d.ts +2 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.js +2 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.d.ts +11 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.js +47 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.d.ts +10 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.js +41 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.d.ts +2 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.js +2 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.d.ts +11 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.js +46 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.d.ts +10 -0
- package/dist/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.js +41 -0
- package/dist/serialization/resources/templates/types/index.d.ts +4 -0
- package/dist/serialization/resources/templates/types/index.js +4 -0
- package/dist/serialization/resources/tools/client/requests/ToolUpdate.d.ts +1 -0
- package/dist/serialization/resources/tools/client/requests/ToolUpdate.js +1 -0
- package/dist/serialization/types/ApprovalRequestMessage.d.ts +4 -0
- package/dist/serialization/types/ApprovalRequestMessage.js +4 -0
- package/dist/serialization/types/ApprovalRequestMessageAllowedToolCalls.d.ts +12 -0
- package/dist/serialization/types/ApprovalRequestMessageAllowedToolCalls.js +43 -0
- package/dist/serialization/types/ApprovalRequestMessageRequestedToolCalls.d.ts +12 -0
- package/dist/serialization/types/ApprovalRequestMessageRequestedToolCalls.js +43 -0
- package/dist/serialization/types/InternalTemplateAgentCreate.d.ts +1 -0
- package/dist/serialization/types/InternalTemplateAgentCreate.js +1 -0
- package/dist/serialization/types/LettaSchemasAgentFileAgentSchema.d.ts +1 -0
- package/dist/serialization/types/LettaSchemasAgentFileAgentSchema.js +1 -0
- package/dist/serialization/types/LettaSchemasAgentFileToolSchema.d.ts +1 -0
- package/dist/serialization/types/LettaSchemasAgentFileToolSchema.js +1 -0
- package/dist/serialization/types/LlmConfig.d.ts +1 -0
- package/dist/serialization/types/LlmConfig.js +1 -0
- package/dist/serialization/types/RunMetrics.d.ts +1 -0
- package/dist/serialization/types/RunMetrics.js +1 -0
- package/dist/serialization/types/Tool.d.ts +1 -0
- package/dist/serialization/types/Tool.js +1 -0
- package/dist/serialization/types/ToolCreate.d.ts +1 -0
- package/dist/serialization/types/ToolCreate.js +1 -0
- package/dist/serialization/types/index.d.ts +2 -0
- package/dist/serialization/types/index.js +2 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/reference.md +235 -186
- package/serialization/resources/agents/client/requests/CreateAgentRequest.d.ts +1 -0
- package/serialization/resources/agents/client/requests/CreateAgentRequest.js +1 -0
- package/serialization/resources/agents/client/requests/UpdateAgent.d.ts +1 -0
- package/serialization/resources/agents/client/requests/UpdateAgent.js +1 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.d.ts +2 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfig.js +2 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.d.ts +11 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCalls.js +47 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.d.ts +10 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemLlmConfigParallelToolCallsItem.js +41 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.d.ts +2 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItem.js +2 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.d.ts +11 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecution.js +46 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.d.ts +10 -0
- package/serialization/resources/templates/types/TemplatesCreateAgentsFromTemplateResponseAgentsItemToolsItemEnableParallelExecutionItem.js +41 -0
- package/serialization/resources/templates/types/index.d.ts +4 -0
- package/serialization/resources/templates/types/index.js +4 -0
- package/serialization/resources/tools/client/requests/ToolUpdate.d.ts +1 -0
- package/serialization/resources/tools/client/requests/ToolUpdate.js +1 -0
- package/serialization/types/ApprovalRequestMessage.d.ts +4 -0
- package/serialization/types/ApprovalRequestMessage.js +4 -0
- package/serialization/types/ApprovalRequestMessageAllowedToolCalls.d.ts +12 -0
- package/serialization/types/ApprovalRequestMessageAllowedToolCalls.js +43 -0
- package/serialization/types/ApprovalRequestMessageRequestedToolCalls.d.ts +12 -0
- package/serialization/types/ApprovalRequestMessageRequestedToolCalls.js +43 -0
- package/serialization/types/InternalTemplateAgentCreate.d.ts +1 -0
- package/serialization/types/InternalTemplateAgentCreate.js +1 -0
- package/serialization/types/LettaSchemasAgentFileAgentSchema.d.ts +1 -0
- package/serialization/types/LettaSchemasAgentFileAgentSchema.js +1 -0
- package/serialization/types/LettaSchemasAgentFileToolSchema.d.ts +1 -0
- package/serialization/types/LettaSchemasAgentFileToolSchema.js +1 -0
- package/serialization/types/LlmConfig.d.ts +1 -0
- package/serialization/types/LlmConfig.js +1 -0
- package/serialization/types/RunMetrics.d.ts +1 -0
- package/serialization/types/RunMetrics.js +1 -0
- package/serialization/types/Tool.d.ts +1 -0
- package/serialization/types/Tool.js +1 -0
- package/serialization/types/ToolCreate.d.ts +1 -0
- package/serialization/types/ToolCreate.js +1 -0
- package/serialization/types/index.d.ts +2 -0
- package/serialization/types/index.js +2 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
package/reference.md
CHANGED
|
@@ -165,7 +165,7 @@ Update an existing archive's name and/or description.
|
|
|
165
165
|
<dd>
|
|
166
166
|
|
|
167
167
|
```typescript
|
|
168
|
-
await client.archives.modifyArchive("
|
|
168
|
+
await client.archives.modifyArchive("archive-123e4567-e89b-42d3-8456-426614174000");
|
|
169
169
|
```
|
|
170
170
|
|
|
171
171
|
</dd>
|
|
@@ -181,7 +181,7 @@ await client.archives.modifyArchive("archive_id");
|
|
|
181
181
|
<dl>
|
|
182
182
|
<dd>
|
|
183
183
|
|
|
184
|
-
**archiveId:** `string`
|
|
184
|
+
**archiveId:** `string` — The ID of the archive in the format 'archive-<uuid4>'
|
|
185
185
|
|
|
186
186
|
</dd>
|
|
187
187
|
</dl>
|
|
@@ -238,7 +238,7 @@ Get a tool by ID
|
|
|
238
238
|
<dd>
|
|
239
239
|
|
|
240
240
|
```typescript
|
|
241
|
-
await client.tools.retrieve("
|
|
241
|
+
await client.tools.retrieve("tool-123e4567-e89b-42d3-8456-426614174000");
|
|
242
242
|
```
|
|
243
243
|
|
|
244
244
|
</dd>
|
|
@@ -254,7 +254,7 @@ await client.tools.retrieve("tool_id");
|
|
|
254
254
|
<dl>
|
|
255
255
|
<dd>
|
|
256
256
|
|
|
257
|
-
**toolId:** `string`
|
|
257
|
+
**toolId:** `string` — The ID of the tool in the format 'tool-<uuid4>'
|
|
258
258
|
|
|
259
259
|
</dd>
|
|
260
260
|
</dl>
|
|
@@ -301,7 +301,7 @@ Delete a tool by name
|
|
|
301
301
|
<dd>
|
|
302
302
|
|
|
303
303
|
```typescript
|
|
304
|
-
await client.tools.delete("
|
|
304
|
+
await client.tools.delete("tool-123e4567-e89b-42d3-8456-426614174000");
|
|
305
305
|
```
|
|
306
306
|
|
|
307
307
|
</dd>
|
|
@@ -317,7 +317,7 @@ await client.tools.delete("tool_id");
|
|
|
317
317
|
<dl>
|
|
318
318
|
<dd>
|
|
319
319
|
|
|
320
|
-
**toolId:** `string`
|
|
320
|
+
**toolId:** `string` — The ID of the tool in the format 'tool-<uuid4>'
|
|
321
321
|
|
|
322
322
|
</dd>
|
|
323
323
|
</dl>
|
|
@@ -364,7 +364,7 @@ Update an existing tool
|
|
|
364
364
|
<dd>
|
|
365
365
|
|
|
366
366
|
```typescript
|
|
367
|
-
await client.tools.modify("
|
|
367
|
+
await client.tools.modify("tool-123e4567-e89b-42d3-8456-426614174000");
|
|
368
368
|
```
|
|
369
369
|
|
|
370
370
|
</dd>
|
|
@@ -380,7 +380,7 @@ await client.tools.modify("tool_id");
|
|
|
380
380
|
<dl>
|
|
381
381
|
<dd>
|
|
382
382
|
|
|
383
|
-
**toolId:** `string`
|
|
383
|
+
**toolId:** `string` — The ID of the tool in the format 'tool-<uuid4>'
|
|
384
384
|
|
|
385
385
|
</dd>
|
|
386
386
|
</dl>
|
|
@@ -1414,7 +1414,7 @@ Get all sources
|
|
|
1414
1414
|
<dd>
|
|
1415
1415
|
|
|
1416
1416
|
```typescript
|
|
1417
|
-
await client.sources.retrieve("
|
|
1417
|
+
await client.sources.retrieve("source-123e4567-e89b-42d3-8456-426614174000");
|
|
1418
1418
|
```
|
|
1419
1419
|
|
|
1420
1420
|
</dd>
|
|
@@ -1430,7 +1430,7 @@ await client.sources.retrieve("source_id");
|
|
|
1430
1430
|
<dl>
|
|
1431
1431
|
<dd>
|
|
1432
1432
|
|
|
1433
|
-
**sourceId:** `string`
|
|
1433
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
1434
1434
|
|
|
1435
1435
|
</dd>
|
|
1436
1436
|
</dl>
|
|
@@ -1477,7 +1477,7 @@ Delete a data source.
|
|
|
1477
1477
|
<dd>
|
|
1478
1478
|
|
|
1479
1479
|
```typescript
|
|
1480
|
-
await client.sources.delete("
|
|
1480
|
+
await client.sources.delete("source-123e4567-e89b-42d3-8456-426614174000");
|
|
1481
1481
|
```
|
|
1482
1482
|
|
|
1483
1483
|
</dd>
|
|
@@ -1493,7 +1493,7 @@ await client.sources.delete("source_id");
|
|
|
1493
1493
|
<dl>
|
|
1494
1494
|
<dd>
|
|
1495
1495
|
|
|
1496
|
-
**sourceId:** `string`
|
|
1496
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
1497
1497
|
|
|
1498
1498
|
</dd>
|
|
1499
1499
|
</dl>
|
|
@@ -1540,7 +1540,7 @@ Update the name or documentation of an existing data source.
|
|
|
1540
1540
|
<dd>
|
|
1541
1541
|
|
|
1542
1542
|
```typescript
|
|
1543
|
-
await client.sources.modify("
|
|
1543
|
+
await client.sources.modify("source-123e4567-e89b-42d3-8456-426614174000", {});
|
|
1544
1544
|
```
|
|
1545
1545
|
|
|
1546
1546
|
</dd>
|
|
@@ -1556,7 +1556,7 @@ await client.sources.modify("source_id", {});
|
|
|
1556
1556
|
<dl>
|
|
1557
1557
|
<dd>
|
|
1558
1558
|
|
|
1559
|
-
**sourceId:** `string`
|
|
1559
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
1560
1560
|
|
|
1561
1561
|
</dd>
|
|
1562
1562
|
</dl>
|
|
@@ -1865,7 +1865,7 @@ Get all agent IDs that have the specified source attached.
|
|
|
1865
1865
|
<dd>
|
|
1866
1866
|
|
|
1867
1867
|
```typescript
|
|
1868
|
-
await client.sources.getAgentsForSource("
|
|
1868
|
+
await client.sources.getAgentsForSource("source-123e4567-e89b-42d3-8456-426614174000");
|
|
1869
1869
|
```
|
|
1870
1870
|
|
|
1871
1871
|
</dd>
|
|
@@ -1881,7 +1881,7 @@ await client.sources.getAgentsForSource("source_id");
|
|
|
1881
1881
|
<dl>
|
|
1882
1882
|
<dd>
|
|
1883
1883
|
|
|
1884
|
-
**sourceId:** `string`
|
|
1884
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
1885
1885
|
|
|
1886
1886
|
</dd>
|
|
1887
1887
|
</dl>
|
|
@@ -1928,9 +1928,13 @@ Retrieve metadata for a specific file by its ID.
|
|
|
1928
1928
|
<dd>
|
|
1929
1929
|
|
|
1930
1930
|
```typescript
|
|
1931
|
-
await client.sources.getFileMetadata(
|
|
1932
|
-
|
|
1933
|
-
|
|
1931
|
+
await client.sources.getFileMetadata(
|
|
1932
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
1933
|
+
"file-123e4567-e89b-42d3-8456-426614174000",
|
|
1934
|
+
{
|
|
1935
|
+
includeContent: true,
|
|
1936
|
+
},
|
|
1937
|
+
);
|
|
1934
1938
|
```
|
|
1935
1939
|
|
|
1936
1940
|
</dd>
|
|
@@ -1946,7 +1950,7 @@ await client.sources.getFileMetadata("source_id", "file_id", {
|
|
|
1946
1950
|
<dl>
|
|
1947
1951
|
<dd>
|
|
1948
1952
|
|
|
1949
|
-
**sourceId:** `string`
|
|
1953
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
1950
1954
|
|
|
1951
1955
|
</dd>
|
|
1952
1956
|
</dl>
|
|
@@ -1954,7 +1958,7 @@ await client.sources.getFileMetadata("source_id", "file_id", {
|
|
|
1954
1958
|
<dl>
|
|
1955
1959
|
<dd>
|
|
1956
1960
|
|
|
1957
|
-
**fileId:** `string`
|
|
1961
|
+
**fileId:** `string` — The ID of the file in the format 'file-<uuid4>'
|
|
1958
1962
|
|
|
1959
1963
|
</dd>
|
|
1960
1964
|
</dl>
|
|
@@ -2736,7 +2740,7 @@ Supports two export formats:
|
|
|
2736
2740
|
<dd>
|
|
2737
2741
|
|
|
2738
2742
|
```typescript
|
|
2739
|
-
await client.agents.exportFile("
|
|
2743
|
+
await client.agents.exportFile("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
2740
2744
|
maxSteps: 1,
|
|
2741
2745
|
useLegacyFormat: true,
|
|
2742
2746
|
});
|
|
@@ -2755,7 +2759,7 @@ await client.agents.exportFile("agent_id", {
|
|
|
2755
2759
|
<dl>
|
|
2756
2760
|
<dd>
|
|
2757
2761
|
|
|
2758
|
-
**agentId:** `string`
|
|
2762
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
2759
2763
|
|
|
2760
2764
|
</dd>
|
|
2761
2765
|
</dl>
|
|
@@ -2884,7 +2888,7 @@ Get the state of the agent.
|
|
|
2884
2888
|
<dd>
|
|
2885
2889
|
|
|
2886
2890
|
```typescript
|
|
2887
|
-
await client.agents.retrieve("
|
|
2891
|
+
await client.agents.retrieve("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
2888
2892
|
```
|
|
2889
2893
|
|
|
2890
2894
|
</dd>
|
|
@@ -2900,7 +2904,7 @@ await client.agents.retrieve("agent_id");
|
|
|
2900
2904
|
<dl>
|
|
2901
2905
|
<dd>
|
|
2902
2906
|
|
|
2903
|
-
**agentId:** `string`
|
|
2907
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
2904
2908
|
|
|
2905
2909
|
</dd>
|
|
2906
2910
|
</dl>
|
|
@@ -2955,7 +2959,7 @@ Delete an agent.
|
|
|
2955
2959
|
<dd>
|
|
2956
2960
|
|
|
2957
2961
|
```typescript
|
|
2958
|
-
await client.agents.delete("
|
|
2962
|
+
await client.agents.delete("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
2959
2963
|
```
|
|
2960
2964
|
|
|
2961
2965
|
</dd>
|
|
@@ -2971,7 +2975,7 @@ await client.agents.delete("agent_id");
|
|
|
2971
2975
|
<dl>
|
|
2972
2976
|
<dd>
|
|
2973
2977
|
|
|
2974
|
-
**agentId:** `string`
|
|
2978
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
2975
2979
|
|
|
2976
2980
|
</dd>
|
|
2977
2981
|
</dl>
|
|
@@ -3018,7 +3022,7 @@ Update an existing agent.
|
|
|
3018
3022
|
<dd>
|
|
3019
3023
|
|
|
3020
3024
|
```typescript
|
|
3021
|
-
await client.agents.modify("
|
|
3025
|
+
await client.agents.modify("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
3022
3026
|
```
|
|
3023
3027
|
|
|
3024
3028
|
</dd>
|
|
@@ -3034,7 +3038,7 @@ await client.agents.modify("agent_id");
|
|
|
3034
3038
|
<dl>
|
|
3035
3039
|
<dd>
|
|
3036
3040
|
|
|
3037
|
-
**agentId:** `string`
|
|
3041
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
3038
3042
|
|
|
3039
3043
|
</dd>
|
|
3040
3044
|
</dl>
|
|
@@ -3428,7 +3432,7 @@ Retrieve the group by id.
|
|
|
3428
3432
|
<dd>
|
|
3429
3433
|
|
|
3430
3434
|
```typescript
|
|
3431
|
-
await client.groups.retrieve("
|
|
3435
|
+
await client.groups.retrieve("group-123e4567-e89b-42d3-8456-426614174000");
|
|
3432
3436
|
```
|
|
3433
3437
|
|
|
3434
3438
|
</dd>
|
|
@@ -3444,7 +3448,7 @@ await client.groups.retrieve("group_id");
|
|
|
3444
3448
|
<dl>
|
|
3445
3449
|
<dd>
|
|
3446
3450
|
|
|
3447
|
-
**groupId:** `string`
|
|
3451
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
3448
3452
|
|
|
3449
3453
|
</dd>
|
|
3450
3454
|
</dl>
|
|
@@ -3491,7 +3495,7 @@ Delete a multi-agent group.
|
|
|
3491
3495
|
<dd>
|
|
3492
3496
|
|
|
3493
3497
|
```typescript
|
|
3494
|
-
await client.groups.delete("
|
|
3498
|
+
await client.groups.delete("group-123e4567-e89b-42d3-8456-426614174000");
|
|
3495
3499
|
```
|
|
3496
3500
|
|
|
3497
3501
|
</dd>
|
|
@@ -3507,7 +3511,7 @@ await client.groups.delete("group_id");
|
|
|
3507
3511
|
<dl>
|
|
3508
3512
|
<dd>
|
|
3509
3513
|
|
|
3510
|
-
**groupId:** `string`
|
|
3514
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
3511
3515
|
|
|
3512
3516
|
</dd>
|
|
3513
3517
|
</dl>
|
|
@@ -3554,7 +3558,7 @@ Create a new multi-agent group with the specified configuration.
|
|
|
3554
3558
|
<dd>
|
|
3555
3559
|
|
|
3556
3560
|
```typescript
|
|
3557
|
-
await client.groups.modify("
|
|
3561
|
+
await client.groups.modify("group-123e4567-e89b-42d3-8456-426614174000");
|
|
3558
3562
|
```
|
|
3559
3563
|
|
|
3560
3564
|
</dd>
|
|
@@ -3570,7 +3574,7 @@ await client.groups.modify("group_id");
|
|
|
3570
3574
|
<dl>
|
|
3571
3575
|
<dd>
|
|
3572
3576
|
|
|
3573
|
-
**groupId:** `string`
|
|
3577
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
3574
3578
|
|
|
3575
3579
|
</dd>
|
|
3576
3580
|
</dl>
|
|
@@ -3844,7 +3848,7 @@ await client.identities.count();
|
|
|
3844
3848
|
<dd>
|
|
3845
3849
|
|
|
3846
3850
|
```typescript
|
|
3847
|
-
await client.identities.retrieve("
|
|
3851
|
+
await client.identities.retrieve("identity-123e4567-e89b-42d3-8456-426614174000");
|
|
3848
3852
|
```
|
|
3849
3853
|
|
|
3850
3854
|
</dd>
|
|
@@ -3860,7 +3864,7 @@ await client.identities.retrieve("identity_id");
|
|
|
3860
3864
|
<dl>
|
|
3861
3865
|
<dd>
|
|
3862
3866
|
|
|
3863
|
-
**identityId:** `string`
|
|
3867
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
3864
3868
|
|
|
3865
3869
|
</dd>
|
|
3866
3870
|
</dl>
|
|
@@ -3907,7 +3911,7 @@ Delete an identity by its identifier key
|
|
|
3907
3911
|
<dd>
|
|
3908
3912
|
|
|
3909
3913
|
```typescript
|
|
3910
|
-
await client.identities.delete("
|
|
3914
|
+
await client.identities.delete("identity-123e4567-e89b-42d3-8456-426614174000");
|
|
3911
3915
|
```
|
|
3912
3916
|
|
|
3913
3917
|
</dd>
|
|
@@ -3923,7 +3927,7 @@ await client.identities.delete("identity_id");
|
|
|
3923
3927
|
<dl>
|
|
3924
3928
|
<dd>
|
|
3925
3929
|
|
|
3926
|
-
**identityId:** `string`
|
|
3930
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
3927
3931
|
|
|
3928
3932
|
</dd>
|
|
3929
3933
|
</dl>
|
|
@@ -3955,7 +3959,7 @@ await client.identities.delete("identity_id");
|
|
|
3955
3959
|
<dd>
|
|
3956
3960
|
|
|
3957
3961
|
```typescript
|
|
3958
|
-
await client.identities.modify("
|
|
3962
|
+
await client.identities.modify("identity-123e4567-e89b-42d3-8456-426614174000");
|
|
3959
3963
|
```
|
|
3960
3964
|
|
|
3961
3965
|
</dd>
|
|
@@ -3971,7 +3975,7 @@ await client.identities.modify("identity_id");
|
|
|
3971
3975
|
<dl>
|
|
3972
3976
|
<dd>
|
|
3973
3977
|
|
|
3974
|
-
**identityId:** `string`
|
|
3978
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
3975
3979
|
|
|
3976
3980
|
</dd>
|
|
3977
3981
|
</dl>
|
|
@@ -4291,7 +4295,7 @@ await client.blocks.count();
|
|
|
4291
4295
|
<dd>
|
|
4292
4296
|
|
|
4293
4297
|
```typescript
|
|
4294
|
-
await client.blocks.retrieve("
|
|
4298
|
+
await client.blocks.retrieve("block-123e4567-e89b-42d3-8456-426614174000");
|
|
4295
4299
|
```
|
|
4296
4300
|
|
|
4297
4301
|
</dd>
|
|
@@ -4307,7 +4311,7 @@ await client.blocks.retrieve("block_id");
|
|
|
4307
4311
|
<dl>
|
|
4308
4312
|
<dd>
|
|
4309
4313
|
|
|
4310
|
-
**blockId:** `string`
|
|
4314
|
+
**blockId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
4311
4315
|
|
|
4312
4316
|
</dd>
|
|
4313
4317
|
</dl>
|
|
@@ -4339,7 +4343,7 @@ await client.blocks.retrieve("block_id");
|
|
|
4339
4343
|
<dd>
|
|
4340
4344
|
|
|
4341
4345
|
```typescript
|
|
4342
|
-
await client.blocks.delete("
|
|
4346
|
+
await client.blocks.delete("block-123e4567-e89b-42d3-8456-426614174000");
|
|
4343
4347
|
```
|
|
4344
4348
|
|
|
4345
4349
|
</dd>
|
|
@@ -4355,7 +4359,7 @@ await client.blocks.delete("block_id");
|
|
|
4355
4359
|
<dl>
|
|
4356
4360
|
<dd>
|
|
4357
4361
|
|
|
4358
|
-
**blockId:** `string`
|
|
4362
|
+
**blockId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
4359
4363
|
|
|
4360
4364
|
</dd>
|
|
4361
4365
|
</dl>
|
|
@@ -4387,7 +4391,7 @@ await client.blocks.delete("block_id");
|
|
|
4387
4391
|
<dd>
|
|
4388
4392
|
|
|
4389
4393
|
```typescript
|
|
4390
|
-
await client.blocks.modify("
|
|
4394
|
+
await client.blocks.modify("block-123e4567-e89b-42d3-8456-426614174000", {});
|
|
4391
4395
|
```
|
|
4392
4396
|
|
|
4393
4397
|
</dd>
|
|
@@ -4403,7 +4407,7 @@ await client.blocks.modify("block_id", {});
|
|
|
4403
4407
|
<dl>
|
|
4404
4408
|
<dd>
|
|
4405
4409
|
|
|
4406
|
-
**blockId:** `string`
|
|
4410
|
+
**blockId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
4407
4411
|
|
|
4408
4412
|
</dd>
|
|
4409
4413
|
</dl>
|
|
@@ -4601,7 +4605,7 @@ Get the status of a job.
|
|
|
4601
4605
|
<dd>
|
|
4602
4606
|
|
|
4603
4607
|
```typescript
|
|
4604
|
-
await client.jobs.retrieve("
|
|
4608
|
+
await client.jobs.retrieve("job-123e4567-e89b-42d3-8456-426614174000");
|
|
4605
4609
|
```
|
|
4606
4610
|
|
|
4607
4611
|
</dd>
|
|
@@ -4617,7 +4621,7 @@ await client.jobs.retrieve("job_id");
|
|
|
4617
4621
|
<dl>
|
|
4618
4622
|
<dd>
|
|
4619
4623
|
|
|
4620
|
-
**jobId:** `string`
|
|
4624
|
+
**jobId:** `string` — The ID of the job in the format 'job-<uuid4>'
|
|
4621
4625
|
|
|
4622
4626
|
</dd>
|
|
4623
4627
|
</dl>
|
|
@@ -4664,7 +4668,7 @@ Delete a job by its job_id.
|
|
|
4664
4668
|
<dd>
|
|
4665
4669
|
|
|
4666
4670
|
```typescript
|
|
4667
|
-
await client.jobs.delete("
|
|
4671
|
+
await client.jobs.delete("job-123e4567-e89b-42d3-8456-426614174000");
|
|
4668
4672
|
```
|
|
4669
4673
|
|
|
4670
4674
|
</dd>
|
|
@@ -4680,7 +4684,7 @@ await client.jobs.delete("job_id");
|
|
|
4680
4684
|
<dl>
|
|
4681
4685
|
<dd>
|
|
4682
4686
|
|
|
4683
|
-
**jobId:** `string`
|
|
4687
|
+
**jobId:** `string` — The ID of the job in the format 'job-<uuid4>'
|
|
4684
4688
|
|
|
4685
4689
|
</dd>
|
|
4686
4690
|
</dl>
|
|
@@ -4730,7 +4734,7 @@ agent execution to terminate as soon as possible.
|
|
|
4730
4734
|
<dd>
|
|
4731
4735
|
|
|
4732
4736
|
```typescript
|
|
4733
|
-
await client.jobs.cancelJob("
|
|
4737
|
+
await client.jobs.cancelJob("job-123e4567-e89b-42d3-8456-426614174000");
|
|
4734
4738
|
```
|
|
4735
4739
|
|
|
4736
4740
|
</dd>
|
|
@@ -4746,7 +4750,7 @@ await client.jobs.cancelJob("job_id");
|
|
|
4746
4750
|
<dl>
|
|
4747
4751
|
<dd>
|
|
4748
4752
|
|
|
4749
|
-
**jobId:** `string`
|
|
4753
|
+
**jobId:** `string` — The ID of the job in the format 'job-<uuid4>'
|
|
4750
4754
|
|
|
4751
4755
|
</dd>
|
|
4752
4756
|
</dl>
|
|
@@ -4975,7 +4979,7 @@ Get a provider by ID.
|
|
|
4975
4979
|
<dd>
|
|
4976
4980
|
|
|
4977
4981
|
```typescript
|
|
4978
|
-
await client.providers.retrieveProvider("
|
|
4982
|
+
await client.providers.retrieveProvider("provider-123e4567-e89b-42d3-8456-426614174000");
|
|
4979
4983
|
```
|
|
4980
4984
|
|
|
4981
4985
|
</dd>
|
|
@@ -4991,7 +4995,7 @@ await client.providers.retrieveProvider("provider_id");
|
|
|
4991
4995
|
<dl>
|
|
4992
4996
|
<dd>
|
|
4993
4997
|
|
|
4994
|
-
**providerId:** `string`
|
|
4998
|
+
**providerId:** `string` — The ID of the provider in the format 'provider-<uuid4>'
|
|
4995
4999
|
|
|
4996
5000
|
</dd>
|
|
4997
5001
|
</dl>
|
|
@@ -5038,7 +5042,7 @@ Delete an existing custom provider.
|
|
|
5038
5042
|
<dd>
|
|
5039
5043
|
|
|
5040
5044
|
```typescript
|
|
5041
|
-
await client.providers.delete("
|
|
5045
|
+
await client.providers.delete("provider-123e4567-e89b-42d3-8456-426614174000");
|
|
5042
5046
|
```
|
|
5043
5047
|
|
|
5044
5048
|
</dd>
|
|
@@ -5054,7 +5058,7 @@ await client.providers.delete("provider_id");
|
|
|
5054
5058
|
<dl>
|
|
5055
5059
|
<dd>
|
|
5056
5060
|
|
|
5057
|
-
**providerId:** `string`
|
|
5061
|
+
**providerId:** `string` — The ID of the provider in the format 'provider-<uuid4>'
|
|
5058
5062
|
|
|
5059
5063
|
</dd>
|
|
5060
5064
|
</dl>
|
|
@@ -5101,7 +5105,7 @@ Update an existing custom provider.
|
|
|
5101
5105
|
<dd>
|
|
5102
5106
|
|
|
5103
5107
|
```typescript
|
|
5104
|
-
await client.providers.modify("
|
|
5108
|
+
await client.providers.modify("provider-123e4567-e89b-42d3-8456-426614174000", {
|
|
5105
5109
|
apiKey: "api_key",
|
|
5106
5110
|
});
|
|
5107
5111
|
```
|
|
@@ -5119,7 +5123,7 @@ await client.providers.modify("provider_id", {
|
|
|
5119
5123
|
<dl>
|
|
5120
5124
|
<dd>
|
|
5121
5125
|
|
|
5122
|
-
**providerId:** `string`
|
|
5126
|
+
**providerId:** `string` — The ID of the provider in the format 'provider-<uuid4>'
|
|
5123
5127
|
|
|
5124
5128
|
</dd>
|
|
5125
5129
|
</dl>
|
|
@@ -5240,7 +5244,7 @@ Verify the API key and additional parameters for an existing provider.
|
|
|
5240
5244
|
<dd>
|
|
5241
5245
|
|
|
5242
5246
|
```typescript
|
|
5243
|
-
await client.providers.checkExistingProvider("
|
|
5247
|
+
await client.providers.checkExistingProvider("provider-123e4567-e89b-42d3-8456-426614174000");
|
|
5244
5248
|
```
|
|
5245
5249
|
|
|
5246
5250
|
</dd>
|
|
@@ -5256,7 +5260,7 @@ await client.providers.checkExistingProvider("provider_id");
|
|
|
5256
5260
|
<dl>
|
|
5257
5261
|
<dd>
|
|
5258
5262
|
|
|
5259
|
-
**providerId:** `string`
|
|
5263
|
+
**providerId:** `string` — The ID of the provider in the format 'provider-<uuid4>'
|
|
5260
5264
|
|
|
5261
5265
|
</dd>
|
|
5262
5266
|
</dl>
|
|
@@ -5771,7 +5775,7 @@ Get a step by ID.
|
|
|
5771
5775
|
<dd>
|
|
5772
5776
|
|
|
5773
5777
|
```typescript
|
|
5774
|
-
await client.steps.retrieve("
|
|
5778
|
+
await client.steps.retrieve("step-123e4567-e89b-42d3-8456-426614174000");
|
|
5775
5779
|
```
|
|
5776
5780
|
|
|
5777
5781
|
</dd>
|
|
@@ -5787,7 +5791,7 @@ await client.steps.retrieve("step_id");
|
|
|
5787
5791
|
<dl>
|
|
5788
5792
|
<dd>
|
|
5789
5793
|
|
|
5790
|
-
**stepId:** `string`
|
|
5794
|
+
**stepId:** `string` — The ID of the step in the format 'step-<uuid4>'
|
|
5791
5795
|
|
|
5792
5796
|
</dd>
|
|
5793
5797
|
</dl>
|
|
@@ -7651,7 +7655,7 @@ Retrieve the context window of a specific agent.
|
|
|
7651
7655
|
<dd>
|
|
7652
7656
|
|
|
7653
7657
|
```typescript
|
|
7654
|
-
await client.agents.context.retrieve("
|
|
7658
|
+
await client.agents.context.retrieve("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
7655
7659
|
```
|
|
7656
7660
|
|
|
7657
7661
|
</dd>
|
|
@@ -7667,7 +7671,7 @@ await client.agents.context.retrieve("agent_id");
|
|
|
7667
7671
|
<dl>
|
|
7668
7672
|
<dd>
|
|
7669
7673
|
|
|
7670
|
-
**agentId:** `string`
|
|
7674
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
7671
7675
|
|
|
7672
7676
|
</dd>
|
|
7673
7677
|
</dl>
|
|
@@ -7716,7 +7720,7 @@ Get tools from an existing agent
|
|
|
7716
7720
|
<dd>
|
|
7717
7721
|
|
|
7718
7722
|
```typescript
|
|
7719
|
-
await client.agents.tools.list("
|
|
7723
|
+
await client.agents.tools.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
7720
7724
|
before: "before",
|
|
7721
7725
|
after: "after",
|
|
7722
7726
|
limit: 1,
|
|
@@ -7738,7 +7742,7 @@ await client.agents.tools.list("agent_id", {
|
|
|
7738
7742
|
<dl>
|
|
7739
7743
|
<dd>
|
|
7740
7744
|
|
|
7741
|
-
**agentId:** `string`
|
|
7745
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
7742
7746
|
|
|
7743
7747
|
</dd>
|
|
7744
7748
|
</dl>
|
|
@@ -7793,7 +7797,10 @@ Attach a tool to an agent.
|
|
|
7793
7797
|
<dd>
|
|
7794
7798
|
|
|
7795
7799
|
```typescript
|
|
7796
|
-
await client.agents.tools.attach(
|
|
7800
|
+
await client.agents.tools.attach(
|
|
7801
|
+
"tool-123e4567-e89b-42d3-8456-426614174000",
|
|
7802
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
7803
|
+
);
|
|
7797
7804
|
```
|
|
7798
7805
|
|
|
7799
7806
|
</dd>
|
|
@@ -7809,7 +7816,7 @@ await client.agents.tools.attach("agent_id", "tool_id");
|
|
|
7809
7816
|
<dl>
|
|
7810
7817
|
<dd>
|
|
7811
7818
|
|
|
7812
|
-
**agentId:** `string`
|
|
7819
|
+
**agentId:** `string` — The ID of the tool in the format 'tool-<uuid4>'
|
|
7813
7820
|
|
|
7814
7821
|
</dd>
|
|
7815
7822
|
</dl>
|
|
@@ -7817,7 +7824,7 @@ await client.agents.tools.attach("agent_id", "tool_id");
|
|
|
7817
7824
|
<dl>
|
|
7818
7825
|
<dd>
|
|
7819
7826
|
|
|
7820
|
-
**toolId:** `string`
|
|
7827
|
+
**toolId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
7821
7828
|
|
|
7822
7829
|
</dd>
|
|
7823
7830
|
</dl>
|
|
@@ -7864,7 +7871,10 @@ Detach a tool from an agent.
|
|
|
7864
7871
|
<dd>
|
|
7865
7872
|
|
|
7866
7873
|
```typescript
|
|
7867
|
-
await client.agents.tools.detach(
|
|
7874
|
+
await client.agents.tools.detach(
|
|
7875
|
+
"tool-123e4567-e89b-42d3-8456-426614174000",
|
|
7876
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
7877
|
+
);
|
|
7868
7878
|
```
|
|
7869
7879
|
|
|
7870
7880
|
</dd>
|
|
@@ -7880,7 +7890,7 @@ await client.agents.tools.detach("agent_id", "tool_id");
|
|
|
7880
7890
|
<dl>
|
|
7881
7891
|
<dd>
|
|
7882
7892
|
|
|
7883
|
-
**agentId:** `string`
|
|
7893
|
+
**agentId:** `string` — The ID of the tool in the format 'tool-<uuid4>'
|
|
7884
7894
|
|
|
7885
7895
|
</dd>
|
|
7886
7896
|
</dl>
|
|
@@ -7888,7 +7898,7 @@ await client.agents.tools.detach("agent_id", "tool_id");
|
|
|
7888
7898
|
<dl>
|
|
7889
7899
|
<dd>
|
|
7890
7900
|
|
|
7891
|
-
**toolId:** `string`
|
|
7901
|
+
**toolId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
7892
7902
|
|
|
7893
7903
|
</dd>
|
|
7894
7904
|
</dl>
|
|
@@ -7935,7 +7945,7 @@ Attach a tool to an agent.
|
|
|
7935
7945
|
<dd>
|
|
7936
7946
|
|
|
7937
7947
|
```typescript
|
|
7938
|
-
await client.agents.tools.modifyApproval("
|
|
7948
|
+
await client.agents.tools.modifyApproval("agent-123e4567-e89b-42d3-8456-426614174000", "tool_name", {
|
|
7939
7949
|
requiresApproval: true,
|
|
7940
7950
|
});
|
|
7941
7951
|
```
|
|
@@ -7953,7 +7963,7 @@ await client.agents.tools.modifyApproval("agent_id", "tool_name", {
|
|
|
7953
7963
|
<dl>
|
|
7954
7964
|
<dd>
|
|
7955
7965
|
|
|
7956
|
-
**agentId:** `string`
|
|
7966
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
7957
7967
|
|
|
7958
7968
|
</dd>
|
|
7959
7969
|
</dl>
|
|
@@ -8018,7 +8028,10 @@ Attach a source to an agent.
|
|
|
8018
8028
|
<dd>
|
|
8019
8029
|
|
|
8020
8030
|
```typescript
|
|
8021
|
-
await client.agents.sources.attach(
|
|
8031
|
+
await client.agents.sources.attach(
|
|
8032
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
8033
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8034
|
+
);
|
|
8022
8035
|
```
|
|
8023
8036
|
|
|
8024
8037
|
</dd>
|
|
@@ -8034,7 +8047,7 @@ await client.agents.sources.attach("agent_id", "source_id");
|
|
|
8034
8047
|
<dl>
|
|
8035
8048
|
<dd>
|
|
8036
8049
|
|
|
8037
|
-
**agentId:** `string`
|
|
8050
|
+
**agentId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
8038
8051
|
|
|
8039
8052
|
</dd>
|
|
8040
8053
|
</dl>
|
|
@@ -8042,7 +8055,7 @@ await client.agents.sources.attach("agent_id", "source_id");
|
|
|
8042
8055
|
<dl>
|
|
8043
8056
|
<dd>
|
|
8044
8057
|
|
|
8045
|
-
**sourceId:** `string`
|
|
8058
|
+
**sourceId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8046
8059
|
|
|
8047
8060
|
</dd>
|
|
8048
8061
|
</dl>
|
|
@@ -8089,7 +8102,10 @@ Detach a source from an agent.
|
|
|
8089
8102
|
<dd>
|
|
8090
8103
|
|
|
8091
8104
|
```typescript
|
|
8092
|
-
await client.agents.sources.detach(
|
|
8105
|
+
await client.agents.sources.detach(
|
|
8106
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
8107
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8108
|
+
);
|
|
8093
8109
|
```
|
|
8094
8110
|
|
|
8095
8111
|
</dd>
|
|
@@ -8105,7 +8121,7 @@ await client.agents.sources.detach("agent_id", "source_id");
|
|
|
8105
8121
|
<dl>
|
|
8106
8122
|
<dd>
|
|
8107
8123
|
|
|
8108
|
-
**agentId:** `string`
|
|
8124
|
+
**agentId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
8109
8125
|
|
|
8110
8126
|
</dd>
|
|
8111
8127
|
</dl>
|
|
@@ -8113,7 +8129,7 @@ await client.agents.sources.detach("agent_id", "source_id");
|
|
|
8113
8129
|
<dl>
|
|
8114
8130
|
<dd>
|
|
8115
8131
|
|
|
8116
|
-
**sourceId:** `string`
|
|
8132
|
+
**sourceId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8117
8133
|
|
|
8118
8134
|
</dd>
|
|
8119
8135
|
</dl>
|
|
@@ -8160,7 +8176,7 @@ Get the sources associated with an agent.
|
|
|
8160
8176
|
<dd>
|
|
8161
8177
|
|
|
8162
8178
|
```typescript
|
|
8163
|
-
await client.agents.sources.list("
|
|
8179
|
+
await client.agents.sources.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
8164
8180
|
before: "before",
|
|
8165
8181
|
after: "after",
|
|
8166
8182
|
limit: 1,
|
|
@@ -8182,7 +8198,7 @@ await client.agents.sources.list("agent_id", {
|
|
|
8182
8198
|
<dl>
|
|
8183
8199
|
<dd>
|
|
8184
8200
|
|
|
8185
|
-
**agentId:** `string`
|
|
8201
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8186
8202
|
|
|
8187
8203
|
</dd>
|
|
8188
8204
|
</dl>
|
|
@@ -8239,7 +8255,10 @@ Attach a folder to an agent.
|
|
|
8239
8255
|
<dd>
|
|
8240
8256
|
|
|
8241
8257
|
```typescript
|
|
8242
|
-
await client.agents.folders.attach(
|
|
8258
|
+
await client.agents.folders.attach(
|
|
8259
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
8260
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8261
|
+
);
|
|
8243
8262
|
```
|
|
8244
8263
|
|
|
8245
8264
|
</dd>
|
|
@@ -8255,7 +8274,7 @@ await client.agents.folders.attach("agent_id", "folder_id");
|
|
|
8255
8274
|
<dl>
|
|
8256
8275
|
<dd>
|
|
8257
8276
|
|
|
8258
|
-
**agentId:** `string`
|
|
8277
|
+
**agentId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
8259
8278
|
|
|
8260
8279
|
</dd>
|
|
8261
8280
|
</dl>
|
|
@@ -8263,7 +8282,7 @@ await client.agents.folders.attach("agent_id", "folder_id");
|
|
|
8263
8282
|
<dl>
|
|
8264
8283
|
<dd>
|
|
8265
8284
|
|
|
8266
|
-
**folderId:** `string`
|
|
8285
|
+
**folderId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8267
8286
|
|
|
8268
8287
|
</dd>
|
|
8269
8288
|
</dl>
|
|
@@ -8310,7 +8329,10 @@ Detach a folder from an agent.
|
|
|
8310
8329
|
<dd>
|
|
8311
8330
|
|
|
8312
8331
|
```typescript
|
|
8313
|
-
await client.agents.folders.detach(
|
|
8332
|
+
await client.agents.folders.detach(
|
|
8333
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
8334
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8335
|
+
);
|
|
8314
8336
|
```
|
|
8315
8337
|
|
|
8316
8338
|
</dd>
|
|
@@ -8326,7 +8348,7 @@ await client.agents.folders.detach("agent_id", "folder_id");
|
|
|
8326
8348
|
<dl>
|
|
8327
8349
|
<dd>
|
|
8328
8350
|
|
|
8329
|
-
**agentId:** `string`
|
|
8351
|
+
**agentId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
8330
8352
|
|
|
8331
8353
|
</dd>
|
|
8332
8354
|
</dl>
|
|
@@ -8334,7 +8356,7 @@ await client.agents.folders.detach("agent_id", "folder_id");
|
|
|
8334
8356
|
<dl>
|
|
8335
8357
|
<dd>
|
|
8336
8358
|
|
|
8337
|
-
**folderId:** `string`
|
|
8359
|
+
**folderId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8338
8360
|
|
|
8339
8361
|
</dd>
|
|
8340
8362
|
</dl>
|
|
@@ -8381,7 +8403,7 @@ Get the folders associated with an agent.
|
|
|
8381
8403
|
<dd>
|
|
8382
8404
|
|
|
8383
8405
|
```typescript
|
|
8384
|
-
await client.agents.folders.list("
|
|
8406
|
+
await client.agents.folders.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
8385
8407
|
before: "before",
|
|
8386
8408
|
after: "after",
|
|
8387
8409
|
limit: 1,
|
|
@@ -8403,7 +8425,7 @@ await client.agents.folders.list("agent_id", {
|
|
|
8403
8425
|
<dl>
|
|
8404
8426
|
<dd>
|
|
8405
8427
|
|
|
8406
|
-
**agentId:** `string`
|
|
8428
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8407
8429
|
|
|
8408
8430
|
</dd>
|
|
8409
8431
|
</dl>
|
|
@@ -8463,7 +8485,7 @@ Typically used to reset the working memory view for the agent.
|
|
|
8463
8485
|
<dd>
|
|
8464
8486
|
|
|
8465
8487
|
```typescript
|
|
8466
|
-
await client.agents.files.closeAll("
|
|
8488
|
+
await client.agents.files.closeAll("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
8467
8489
|
```
|
|
8468
8490
|
|
|
8469
8491
|
</dd>
|
|
@@ -8479,7 +8501,7 @@ await client.agents.files.closeAll("agent_id");
|
|
|
8479
8501
|
<dl>
|
|
8480
8502
|
<dd>
|
|
8481
8503
|
|
|
8482
|
-
**agentId:** `string`
|
|
8504
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8483
8505
|
|
|
8484
8506
|
</dd>
|
|
8485
8507
|
</dl>
|
|
@@ -8530,7 +8552,10 @@ Returns a list of file names that were closed due to LRU eviction.
|
|
|
8530
8552
|
<dd>
|
|
8531
8553
|
|
|
8532
8554
|
```typescript
|
|
8533
|
-
await client.agents.files.open(
|
|
8555
|
+
await client.agents.files.open(
|
|
8556
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8557
|
+
"file-123e4567-e89b-42d3-8456-426614174000",
|
|
8558
|
+
);
|
|
8534
8559
|
```
|
|
8535
8560
|
|
|
8536
8561
|
</dd>
|
|
@@ -8546,7 +8571,7 @@ await client.agents.files.open("agent_id", "file_id");
|
|
|
8546
8571
|
<dl>
|
|
8547
8572
|
<dd>
|
|
8548
8573
|
|
|
8549
|
-
**agentId:** `string`
|
|
8574
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8550
8575
|
|
|
8551
8576
|
</dd>
|
|
8552
8577
|
</dl>
|
|
@@ -8554,7 +8579,7 @@ await client.agents.files.open("agent_id", "file_id");
|
|
|
8554
8579
|
<dl>
|
|
8555
8580
|
<dd>
|
|
8556
8581
|
|
|
8557
|
-
**fileId:** `string`
|
|
8582
|
+
**fileId:** `string` — The ID of the file in the format 'file-<uuid4>'
|
|
8558
8583
|
|
|
8559
8584
|
</dd>
|
|
8560
8585
|
</dl>
|
|
@@ -8604,7 +8629,10 @@ The file will be removed from the agent's working memory view.
|
|
|
8604
8629
|
<dd>
|
|
8605
8630
|
|
|
8606
8631
|
```typescript
|
|
8607
|
-
await client.agents.files.close(
|
|
8632
|
+
await client.agents.files.close(
|
|
8633
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
8634
|
+
"file-123e4567-e89b-42d3-8456-426614174000",
|
|
8635
|
+
);
|
|
8608
8636
|
```
|
|
8609
8637
|
|
|
8610
8638
|
</dd>
|
|
@@ -8620,7 +8648,7 @@ await client.agents.files.close("agent_id", "file_id");
|
|
|
8620
8648
|
<dl>
|
|
8621
8649
|
<dd>
|
|
8622
8650
|
|
|
8623
|
-
**agentId:** `string`
|
|
8651
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8624
8652
|
|
|
8625
8653
|
</dd>
|
|
8626
8654
|
</dl>
|
|
@@ -8628,7 +8656,7 @@ await client.agents.files.close("agent_id", "file_id");
|
|
|
8628
8656
|
<dl>
|
|
8629
8657
|
<dd>
|
|
8630
8658
|
|
|
8631
|
-
**fileId:** `string`
|
|
8659
|
+
**fileId:** `string` — The ID of the file in the format 'file-<uuid4>'
|
|
8632
8660
|
|
|
8633
8661
|
</dd>
|
|
8634
8662
|
</dl>
|
|
@@ -8675,7 +8703,7 @@ Get the files attached to an agent with their open/closed status (paginated).
|
|
|
8675
8703
|
<dd>
|
|
8676
8704
|
|
|
8677
8705
|
```typescript
|
|
8678
|
-
await client.agents.files.list("
|
|
8706
|
+
await client.agents.files.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
8679
8707
|
before: "before",
|
|
8680
8708
|
after: "after",
|
|
8681
8709
|
limit: 1,
|
|
@@ -8699,7 +8727,7 @@ await client.agents.files.list("agent_id", {
|
|
|
8699
8727
|
<dl>
|
|
8700
8728
|
<dd>
|
|
8701
8729
|
|
|
8702
|
-
**agentId:** `string`
|
|
8730
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8703
8731
|
|
|
8704
8732
|
</dd>
|
|
8705
8733
|
</dl>
|
|
@@ -8757,7 +8785,7 @@ This endpoint fetches the current memory state of the agent identified by the us
|
|
|
8757
8785
|
<dd>
|
|
8758
8786
|
|
|
8759
8787
|
```typescript
|
|
8760
|
-
await client.agents.coreMemory.retrieve("
|
|
8788
|
+
await client.agents.coreMemory.retrieve("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
8761
8789
|
```
|
|
8762
8790
|
|
|
8763
8791
|
</dd>
|
|
@@ -8773,7 +8801,7 @@ await client.agents.coreMemory.retrieve("agent_id");
|
|
|
8773
8801
|
<dl>
|
|
8774
8802
|
<dd>
|
|
8775
8803
|
|
|
8776
|
-
**agentId:** `string`
|
|
8804
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8777
8805
|
|
|
8778
8806
|
</dd>
|
|
8779
8807
|
</dl>
|
|
@@ -8822,7 +8850,7 @@ Retrieve a core memory block from an agent.
|
|
|
8822
8850
|
<dd>
|
|
8823
8851
|
|
|
8824
8852
|
```typescript
|
|
8825
|
-
await client.agents.blocks.retrieve("agent_id", "
|
|
8853
|
+
await client.agents.blocks.retrieve("agent_id", "agent-123e4567-e89b-42d3-8456-426614174000");
|
|
8826
8854
|
```
|
|
8827
8855
|
|
|
8828
8856
|
</dd>
|
|
@@ -8846,7 +8874,7 @@ await client.agents.blocks.retrieve("agent_id", "block_label");
|
|
|
8846
8874
|
<dl>
|
|
8847
8875
|
<dd>
|
|
8848
8876
|
|
|
8849
|
-
**blockLabel:** `string`
|
|
8877
|
+
**blockLabel:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8850
8878
|
|
|
8851
8879
|
</dd>
|
|
8852
8880
|
</dl>
|
|
@@ -8893,7 +8921,7 @@ Updates a core memory block of an agent.
|
|
|
8893
8921
|
<dd>
|
|
8894
8922
|
|
|
8895
8923
|
```typescript
|
|
8896
|
-
await client.agents.blocks.modify("agent_id", "
|
|
8924
|
+
await client.agents.blocks.modify("agent_id", "agent-123e4567-e89b-42d3-8456-426614174000", {});
|
|
8897
8925
|
```
|
|
8898
8926
|
|
|
8899
8927
|
</dd>
|
|
@@ -8917,7 +8945,7 @@ await client.agents.blocks.modify("agent_id", "block_label", {});
|
|
|
8917
8945
|
<dl>
|
|
8918
8946
|
<dd>
|
|
8919
8947
|
|
|
8920
|
-
**blockLabel:** `string`
|
|
8948
|
+
**blockLabel:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8921
8949
|
|
|
8922
8950
|
</dd>
|
|
8923
8951
|
</dl>
|
|
@@ -8972,7 +9000,7 @@ Retrieve the core memory blocks of a specific agent.
|
|
|
8972
9000
|
<dd>
|
|
8973
9001
|
|
|
8974
9002
|
```typescript
|
|
8975
|
-
await client.agents.blocks.list("
|
|
9003
|
+
await client.agents.blocks.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
8976
9004
|
before: "before",
|
|
8977
9005
|
after: "after",
|
|
8978
9006
|
limit: 1,
|
|
@@ -8994,7 +9022,7 @@ await client.agents.blocks.list("agent_id", {
|
|
|
8994
9022
|
<dl>
|
|
8995
9023
|
<dd>
|
|
8996
9024
|
|
|
8997
|
-
**agentId:** `string`
|
|
9025
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
8998
9026
|
|
|
8999
9027
|
</dd>
|
|
9000
9028
|
</dl>
|
|
@@ -9049,7 +9077,10 @@ Attach a core memory block to an agent.
|
|
|
9049
9077
|
<dd>
|
|
9050
9078
|
|
|
9051
9079
|
```typescript
|
|
9052
|
-
await client.agents.blocks.attach(
|
|
9080
|
+
await client.agents.blocks.attach(
|
|
9081
|
+
"block-123e4567-e89b-42d3-8456-426614174000",
|
|
9082
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
9083
|
+
);
|
|
9053
9084
|
```
|
|
9054
9085
|
|
|
9055
9086
|
</dd>
|
|
@@ -9065,7 +9096,7 @@ await client.agents.blocks.attach("agent_id", "block_id");
|
|
|
9065
9096
|
<dl>
|
|
9066
9097
|
<dd>
|
|
9067
9098
|
|
|
9068
|
-
**agentId:** `string`
|
|
9099
|
+
**agentId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
9069
9100
|
|
|
9070
9101
|
</dd>
|
|
9071
9102
|
</dl>
|
|
@@ -9073,7 +9104,7 @@ await client.agents.blocks.attach("agent_id", "block_id");
|
|
|
9073
9104
|
<dl>
|
|
9074
9105
|
<dd>
|
|
9075
9106
|
|
|
9076
|
-
**blockId:** `string`
|
|
9107
|
+
**blockId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9077
9108
|
|
|
9078
9109
|
</dd>
|
|
9079
9110
|
</dl>
|
|
@@ -9120,7 +9151,10 @@ Detach a core memory block from an agent.
|
|
|
9120
9151
|
<dd>
|
|
9121
9152
|
|
|
9122
9153
|
```typescript
|
|
9123
|
-
await client.agents.blocks.detach(
|
|
9154
|
+
await client.agents.blocks.detach(
|
|
9155
|
+
"block-123e4567-e89b-42d3-8456-426614174000",
|
|
9156
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
9157
|
+
);
|
|
9124
9158
|
```
|
|
9125
9159
|
|
|
9126
9160
|
</dd>
|
|
@@ -9136,7 +9170,7 @@ await client.agents.blocks.detach("agent_id", "block_id");
|
|
|
9136
9170
|
<dl>
|
|
9137
9171
|
<dd>
|
|
9138
9172
|
|
|
9139
|
-
**agentId:** `string`
|
|
9173
|
+
**agentId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
9140
9174
|
|
|
9141
9175
|
</dd>
|
|
9142
9176
|
</dl>
|
|
@@ -9144,7 +9178,7 @@ await client.agents.blocks.detach("agent_id", "block_id");
|
|
|
9144
9178
|
<dl>
|
|
9145
9179
|
<dd>
|
|
9146
9180
|
|
|
9147
|
-
**blockId:** `string`
|
|
9181
|
+
**blockId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9148
9182
|
|
|
9149
9183
|
</dd>
|
|
9150
9184
|
</dl>
|
|
@@ -9193,7 +9227,7 @@ Retrieve the memories in an agent's archival memory store (paginated query).
|
|
|
9193
9227
|
<dd>
|
|
9194
9228
|
|
|
9195
9229
|
```typescript
|
|
9196
|
-
await client.agents.passages.list("
|
|
9230
|
+
await client.agents.passages.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9197
9231
|
after: "after",
|
|
9198
9232
|
before: "before",
|
|
9199
9233
|
limit: 1,
|
|
@@ -9215,7 +9249,7 @@ await client.agents.passages.list("agent_id", {
|
|
|
9215
9249
|
<dl>
|
|
9216
9250
|
<dd>
|
|
9217
9251
|
|
|
9218
|
-
**agentId:** `string`
|
|
9252
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9219
9253
|
|
|
9220
9254
|
</dd>
|
|
9221
9255
|
</dl>
|
|
@@ -9270,7 +9304,7 @@ Insert a memory into an agent's archival memory store.
|
|
|
9270
9304
|
<dd>
|
|
9271
9305
|
|
|
9272
9306
|
```typescript
|
|
9273
|
-
await client.agents.passages.create("
|
|
9307
|
+
await client.agents.passages.create("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9274
9308
|
text: "text",
|
|
9275
9309
|
});
|
|
9276
9310
|
```
|
|
@@ -9288,7 +9322,7 @@ await client.agents.passages.create("agent_id", {
|
|
|
9288
9322
|
<dl>
|
|
9289
9323
|
<dd>
|
|
9290
9324
|
|
|
9291
|
-
**agentId:** `string`
|
|
9325
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9292
9326
|
|
|
9293
9327
|
</dd>
|
|
9294
9328
|
</dl>
|
|
@@ -9347,7 +9381,7 @@ as the agent's archival_memory_search tool but is accessible for external API us
|
|
|
9347
9381
|
<dd>
|
|
9348
9382
|
|
|
9349
9383
|
```typescript
|
|
9350
|
-
await client.agents.passages.search("
|
|
9384
|
+
await client.agents.passages.search("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9351
9385
|
query: "query",
|
|
9352
9386
|
tagMatchMode: "any",
|
|
9353
9387
|
topK: 1,
|
|
@@ -9369,7 +9403,7 @@ await client.agents.passages.search("agent_id", {
|
|
|
9369
9403
|
<dl>
|
|
9370
9404
|
<dd>
|
|
9371
9405
|
|
|
9372
|
-
**agentId:** `string`
|
|
9406
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9373
9407
|
|
|
9374
9408
|
</dd>
|
|
9375
9409
|
</dl>
|
|
@@ -9424,7 +9458,7 @@ Delete a memory from an agent's archival memory store.
|
|
|
9424
9458
|
<dd>
|
|
9425
9459
|
|
|
9426
9460
|
```typescript
|
|
9427
|
-
await client.agents.passages.delete("agent_id", "
|
|
9461
|
+
await client.agents.passages.delete("agent_id", "agent-123e4567-e89b-42d3-8456-426614174000");
|
|
9428
9462
|
```
|
|
9429
9463
|
|
|
9430
9464
|
</dd>
|
|
@@ -9448,7 +9482,7 @@ await client.agents.passages.delete("agent_id", "memory_id");
|
|
|
9448
9482
|
<dl>
|
|
9449
9483
|
<dd>
|
|
9450
9484
|
|
|
9451
|
-
**memoryId:** `string`
|
|
9485
|
+
**memoryId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9452
9486
|
|
|
9453
9487
|
</dd>
|
|
9454
9488
|
</dl>
|
|
@@ -9553,7 +9587,7 @@ Retrieve message history for an agent.
|
|
|
9553
9587
|
<dd>
|
|
9554
9588
|
|
|
9555
9589
|
```typescript
|
|
9556
|
-
await client.agents.messages.list("
|
|
9590
|
+
await client.agents.messages.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9557
9591
|
before: "before",
|
|
9558
9592
|
after: "after",
|
|
9559
9593
|
limit: 1,
|
|
@@ -9580,7 +9614,7 @@ await client.agents.messages.list("agent_id", {
|
|
|
9580
9614
|
<dl>
|
|
9581
9615
|
<dd>
|
|
9582
9616
|
|
|
9583
|
-
**agentId:** `string`
|
|
9617
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9584
9618
|
|
|
9585
9619
|
</dd>
|
|
9586
9620
|
</dl>
|
|
@@ -9636,7 +9670,7 @@ This endpoint accepts a message from a user and processes it through the agent.
|
|
|
9636
9670
|
<dd>
|
|
9637
9671
|
|
|
9638
9672
|
```typescript
|
|
9639
|
-
await client.agents.messages.create("
|
|
9673
|
+
await client.agents.messages.create("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9640
9674
|
messages: [
|
|
9641
9675
|
{
|
|
9642
9676
|
role: "user",
|
|
@@ -9664,7 +9698,7 @@ await client.agents.messages.create("agent_id", {
|
|
|
9664
9698
|
<dl>
|
|
9665
9699
|
<dd>
|
|
9666
9700
|
|
|
9667
|
-
**agentId:** `string`
|
|
9701
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9668
9702
|
|
|
9669
9703
|
</dd>
|
|
9670
9704
|
</dl>
|
|
@@ -9719,9 +9753,13 @@ Update the details of a message associated with an agent.
|
|
|
9719
9753
|
<dd>
|
|
9720
9754
|
|
|
9721
9755
|
```typescript
|
|
9722
|
-
await client.agents.messages.modify(
|
|
9723
|
-
|
|
9724
|
-
|
|
9756
|
+
await client.agents.messages.modify(
|
|
9757
|
+
"agent-123e4567-e89b-42d3-8456-426614174000",
|
|
9758
|
+
"message-123e4567-e89b-42d3-8456-426614174000",
|
|
9759
|
+
{
|
|
9760
|
+
content: "content",
|
|
9761
|
+
},
|
|
9762
|
+
);
|
|
9725
9763
|
```
|
|
9726
9764
|
|
|
9727
9765
|
</dd>
|
|
@@ -9737,7 +9775,7 @@ await client.agents.messages.modify("agent_id", "message_id", {
|
|
|
9737
9775
|
<dl>
|
|
9738
9776
|
<dd>
|
|
9739
9777
|
|
|
9740
|
-
**agentId:** `string`
|
|
9778
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9741
9779
|
|
|
9742
9780
|
</dd>
|
|
9743
9781
|
</dl>
|
|
@@ -9745,7 +9783,7 @@ await client.agents.messages.modify("agent_id", "message_id", {
|
|
|
9745
9783
|
<dl>
|
|
9746
9784
|
<dd>
|
|
9747
9785
|
|
|
9748
|
-
**messageId:** `string`
|
|
9786
|
+
**messageId:** `string` — The ID of the message in the format 'message-<uuid4>'
|
|
9749
9787
|
|
|
9750
9788
|
</dd>
|
|
9751
9789
|
</dl>
|
|
@@ -9802,7 +9840,7 @@ It will stream the steps of the response always, and stream the tokens if 'strea
|
|
|
9802
9840
|
<dd>
|
|
9803
9841
|
|
|
9804
9842
|
```typescript
|
|
9805
|
-
const response = await client.agents.messages.createStream("
|
|
9843
|
+
const response = await client.agents.messages.createStream("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
9806
9844
|
messages: [
|
|
9807
9845
|
{
|
|
9808
9846
|
role: "user",
|
|
@@ -9833,7 +9871,7 @@ for await (const item of response) {
|
|
|
9833
9871
|
<dl>
|
|
9834
9872
|
<dd>
|
|
9835
9873
|
|
|
9836
|
-
**agentId:** `string`
|
|
9874
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9837
9875
|
|
|
9838
9876
|
</dd>
|
|
9839
9877
|
</dl>
|
|
@@ -9890,7 +9928,7 @@ Note to cancel active runs associated with an agent, redis is required.
|
|
|
9890
9928
|
<dd>
|
|
9891
9929
|
|
|
9892
9930
|
```typescript
|
|
9893
|
-
await client.agents.messages.cancel("
|
|
9931
|
+
await client.agents.messages.cancel("agent-123e4567-e89b-42d3-8456-426614174000");
|
|
9894
9932
|
```
|
|
9895
9933
|
|
|
9896
9934
|
</dd>
|
|
@@ -9906,7 +9944,7 @@ await client.agents.messages.cancel("agent_id");
|
|
|
9906
9944
|
<dl>
|
|
9907
9945
|
<dd>
|
|
9908
9946
|
|
|
9909
|
-
**agentId:** `string`
|
|
9947
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
9910
9948
|
|
|
9911
9949
|
</dd>
|
|
9912
9950
|
</dl>
|
|
@@ -10029,7 +10067,7 @@ This is "asynchronous" in the sense that it's a background run and explicitly mu
|
|
|
10029
10067
|
<dd>
|
|
10030
10068
|
|
|
10031
10069
|
```typescript
|
|
10032
|
-
await client.agents.messages.createAsync("
|
|
10070
|
+
await client.agents.messages.createAsync("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
10033
10071
|
messages: [
|
|
10034
10072
|
{
|
|
10035
10073
|
role: "user",
|
|
@@ -10057,7 +10095,7 @@ await client.agents.messages.createAsync("agent_id", {
|
|
|
10057
10095
|
<dl>
|
|
10058
10096
|
<dd>
|
|
10059
10097
|
|
|
10060
|
-
**agentId:** `string`
|
|
10098
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
10061
10099
|
|
|
10062
10100
|
</dd>
|
|
10063
10101
|
</dl>
|
|
@@ -10112,7 +10150,7 @@ Resets the messages for an agent
|
|
|
10112
10150
|
<dd>
|
|
10113
10151
|
|
|
10114
10152
|
```typescript
|
|
10115
|
-
await client.agents.messages.reset("
|
|
10153
|
+
await client.agents.messages.reset("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
10116
10154
|
addDefaultInitialMessages: true,
|
|
10117
10155
|
});
|
|
10118
10156
|
```
|
|
@@ -10130,7 +10168,7 @@ await client.agents.messages.reset("agent_id", {
|
|
|
10130
10168
|
<dl>
|
|
10131
10169
|
<dd>
|
|
10132
10170
|
|
|
10133
|
-
**agentId:** `string`
|
|
10171
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
10134
10172
|
|
|
10135
10173
|
</dd>
|
|
10136
10174
|
</dl>
|
|
@@ -10189,7 +10227,7 @@ be sent to the LLM provider. Useful for debugging and inspection.
|
|
|
10189
10227
|
<dd>
|
|
10190
10228
|
|
|
10191
10229
|
```typescript
|
|
10192
|
-
await client.agents.messages.preview("
|
|
10230
|
+
await client.agents.messages.preview("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
10193
10231
|
messages: [
|
|
10194
10232
|
{
|
|
10195
10233
|
role: "user",
|
|
@@ -10217,7 +10255,7 @@ await client.agents.messages.preview("agent_id", {
|
|
|
10217
10255
|
<dl>
|
|
10218
10256
|
<dd>
|
|
10219
10257
|
|
|
10220
|
-
**agentId:** `string`
|
|
10258
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
10221
10259
|
|
|
10222
10260
|
</dd>
|
|
10223
10261
|
</dl>
|
|
@@ -10275,7 +10313,7 @@ truncating and compressing it down to the specified `max_message_length`.
|
|
|
10275
10313
|
<dd>
|
|
10276
10314
|
|
|
10277
10315
|
```typescript
|
|
10278
|
-
await client.agents.messages.summarize("
|
|
10316
|
+
await client.agents.messages.summarize("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
10279
10317
|
maxMessageLength: 1,
|
|
10280
10318
|
});
|
|
10281
10319
|
```
|
|
@@ -10293,7 +10331,7 @@ await client.agents.messages.summarize("agent_id", {
|
|
|
10293
10331
|
<dl>
|
|
10294
10332
|
<dd>
|
|
10295
10333
|
|
|
10296
|
-
**agentId:** `string`
|
|
10334
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
10297
10335
|
|
|
10298
10336
|
</dd>
|
|
10299
10337
|
</dl>
|
|
@@ -10350,7 +10388,7 @@ Lists the groups for an agent
|
|
|
10350
10388
|
<dd>
|
|
10351
10389
|
|
|
10352
10390
|
```typescript
|
|
10353
|
-
await client.agents.groups.list("
|
|
10391
|
+
await client.agents.groups.list("agent-123e4567-e89b-42d3-8456-426614174000", {
|
|
10354
10392
|
managerType: "manager_type",
|
|
10355
10393
|
before: "before",
|
|
10356
10394
|
after: "after",
|
|
@@ -10373,7 +10411,7 @@ await client.agents.groups.list("agent_id", {
|
|
|
10373
10411
|
<dl>
|
|
10374
10412
|
<dd>
|
|
10375
10413
|
|
|
10376
|
-
**agentId:** `string`
|
|
10414
|
+
**agentId:** `string` — The ID of the agent in the format 'agent-<uuid4>'
|
|
10377
10415
|
|
|
10378
10416
|
</dd>
|
|
10379
10417
|
</dl>
|
|
@@ -10578,7 +10616,7 @@ Raises a 404 if the block does not exist.
|
|
|
10578
10616
|
<dd>
|
|
10579
10617
|
|
|
10580
10618
|
```typescript
|
|
10581
|
-
await client.blocks.agents.list("
|
|
10619
|
+
await client.blocks.agents.list("block-123e4567-e89b-42d3-8456-426614174000", {
|
|
10582
10620
|
before: "before",
|
|
10583
10621
|
after: "after",
|
|
10584
10622
|
limit: 1,
|
|
@@ -10600,7 +10638,7 @@ await client.blocks.agents.list("block_id", {
|
|
|
10600
10638
|
<dl>
|
|
10601
10639
|
<dd>
|
|
10602
10640
|
|
|
10603
|
-
**blockId:** `string`
|
|
10641
|
+
**blockId:** `string` — The ID of the block in the format 'block-<uuid4>'
|
|
10604
10642
|
|
|
10605
10643
|
</dd>
|
|
10606
10644
|
</dl>
|
|
@@ -11048,7 +11086,7 @@ Retrieve message history for an agent.
|
|
|
11048
11086
|
<dd>
|
|
11049
11087
|
|
|
11050
11088
|
```typescript
|
|
11051
|
-
await client.groups.messages.list("
|
|
11089
|
+
await client.groups.messages.list("group-123e4567-e89b-42d3-8456-426614174000", {
|
|
11052
11090
|
before: "before",
|
|
11053
11091
|
after: "after",
|
|
11054
11092
|
limit: 1,
|
|
@@ -11073,7 +11111,7 @@ await client.groups.messages.list("group_id", {
|
|
|
11073
11111
|
<dl>
|
|
11074
11112
|
<dd>
|
|
11075
11113
|
|
|
11076
|
-
**groupId:** `string`
|
|
11114
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
11077
11115
|
|
|
11078
11116
|
</dd>
|
|
11079
11117
|
</dl>
|
|
@@ -11129,7 +11167,7 @@ This endpoint accepts a message from a user and processes it through through age
|
|
|
11129
11167
|
<dd>
|
|
11130
11168
|
|
|
11131
11169
|
```typescript
|
|
11132
|
-
await client.groups.messages.create("
|
|
11170
|
+
await client.groups.messages.create("group-123e4567-e89b-42d3-8456-426614174000", {
|
|
11133
11171
|
messages: [
|
|
11134
11172
|
{
|
|
11135
11173
|
role: "user",
|
|
@@ -11157,7 +11195,7 @@ await client.groups.messages.create("group_id", {
|
|
|
11157
11195
|
<dl>
|
|
11158
11196
|
<dd>
|
|
11159
11197
|
|
|
11160
|
-
**groupId:** `string`
|
|
11198
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
11161
11199
|
|
|
11162
11200
|
</dd>
|
|
11163
11201
|
</dl>
|
|
@@ -11214,7 +11252,7 @@ It will stream the steps of the response always, and stream the tokens if 'strea
|
|
|
11214
11252
|
<dd>
|
|
11215
11253
|
|
|
11216
11254
|
```typescript
|
|
11217
|
-
const response = await client.groups.messages.createStream("
|
|
11255
|
+
const response = await client.groups.messages.createStream("group-123e4567-e89b-42d3-8456-426614174000", {
|
|
11218
11256
|
messages: [
|
|
11219
11257
|
{
|
|
11220
11258
|
role: "user",
|
|
@@ -11245,7 +11283,7 @@ for await (const item of response) {
|
|
|
11245
11283
|
<dl>
|
|
11246
11284
|
<dd>
|
|
11247
11285
|
|
|
11248
|
-
**groupId:** `string`
|
|
11286
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
11249
11287
|
|
|
11250
11288
|
</dd>
|
|
11251
11289
|
</dl>
|
|
@@ -11300,9 +11338,13 @@ Update the details of a message associated with an agent.
|
|
|
11300
11338
|
<dd>
|
|
11301
11339
|
|
|
11302
11340
|
```typescript
|
|
11303
|
-
await client.groups.messages.modify(
|
|
11304
|
-
|
|
11305
|
-
|
|
11341
|
+
await client.groups.messages.modify(
|
|
11342
|
+
"group-123e4567-e89b-42d3-8456-426614174000",
|
|
11343
|
+
"message-123e4567-e89b-42d3-8456-426614174000",
|
|
11344
|
+
{
|
|
11345
|
+
content: "content",
|
|
11346
|
+
},
|
|
11347
|
+
);
|
|
11306
11348
|
```
|
|
11307
11349
|
|
|
11308
11350
|
</dd>
|
|
@@ -11318,7 +11360,7 @@ await client.groups.messages.modify("group_id", "message_id", {
|
|
|
11318
11360
|
<dl>
|
|
11319
11361
|
<dd>
|
|
11320
11362
|
|
|
11321
|
-
**groupId:** `string`
|
|
11363
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
11322
11364
|
|
|
11323
11365
|
</dd>
|
|
11324
11366
|
</dl>
|
|
@@ -11326,7 +11368,7 @@ await client.groups.messages.modify("group_id", "message_id", {
|
|
|
11326
11368
|
<dl>
|
|
11327
11369
|
<dd>
|
|
11328
11370
|
|
|
11329
|
-
**messageId:** `string`
|
|
11371
|
+
**messageId:** `string` — The ID of the message in the format 'message-<uuid4>'
|
|
11330
11372
|
|
|
11331
11373
|
</dd>
|
|
11332
11374
|
</dl>
|
|
@@ -11381,7 +11423,7 @@ Delete the group messages for all agents that are part of the multi-agent group.
|
|
|
11381
11423
|
<dd>
|
|
11382
11424
|
|
|
11383
11425
|
```typescript
|
|
11384
|
-
await client.groups.messages.reset("
|
|
11426
|
+
await client.groups.messages.reset("group-123e4567-e89b-42d3-8456-426614174000");
|
|
11385
11427
|
```
|
|
11386
11428
|
|
|
11387
11429
|
</dd>
|
|
@@ -11397,7 +11439,7 @@ await client.groups.messages.reset("group_id");
|
|
|
11397
11439
|
<dl>
|
|
11398
11440
|
<dd>
|
|
11399
11441
|
|
|
11400
|
-
**groupId:** `string`
|
|
11442
|
+
**groupId:** `string` — The ID of the group in the format 'group-<uuid4>'
|
|
11401
11443
|
|
|
11402
11444
|
</dd>
|
|
11403
11445
|
</dl>
|
|
@@ -11431,7 +11473,7 @@ await client.groups.messages.reset("group_id");
|
|
|
11431
11473
|
<dd>
|
|
11432
11474
|
|
|
11433
11475
|
```typescript
|
|
11434
|
-
await client.identities.properties.upsert("
|
|
11476
|
+
await client.identities.properties.upsert("identity-123e4567-e89b-42d3-8456-426614174000", [
|
|
11435
11477
|
{
|
|
11436
11478
|
key: "key",
|
|
11437
11479
|
value: "value",
|
|
@@ -11453,7 +11495,7 @@ await client.identities.properties.upsert("identity_id", [
|
|
|
11453
11495
|
<dl>
|
|
11454
11496
|
<dd>
|
|
11455
11497
|
|
|
11456
|
-
**identityId:** `string`
|
|
11498
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
11457
11499
|
|
|
11458
11500
|
</dd>
|
|
11459
11501
|
</dl>
|
|
@@ -11510,7 +11552,7 @@ Get all agents associated with the specified identity.
|
|
|
11510
11552
|
<dd>
|
|
11511
11553
|
|
|
11512
11554
|
```typescript
|
|
11513
|
-
await client.identities.agents.list("
|
|
11555
|
+
await client.identities.agents.list("identity-123e4567-e89b-42d3-8456-426614174000", {
|
|
11514
11556
|
before: "before",
|
|
11515
11557
|
after: "after",
|
|
11516
11558
|
limit: 1,
|
|
@@ -11532,7 +11574,7 @@ await client.identities.agents.list("identity_id", {
|
|
|
11532
11574
|
<dl>
|
|
11533
11575
|
<dd>
|
|
11534
11576
|
|
|
11535
|
-
**identityId:** `string`
|
|
11577
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
11536
11578
|
|
|
11537
11579
|
</dd>
|
|
11538
11580
|
</dl>
|
|
@@ -11589,7 +11631,7 @@ Get all blocks associated with the specified identity.
|
|
|
11589
11631
|
<dd>
|
|
11590
11632
|
|
|
11591
11633
|
```typescript
|
|
11592
|
-
await client.identities.blocks.list("
|
|
11634
|
+
await client.identities.blocks.list("identity-123e4567-e89b-42d3-8456-426614174000", {
|
|
11593
11635
|
before: "before",
|
|
11594
11636
|
after: "after",
|
|
11595
11637
|
limit: 1,
|
|
@@ -11611,7 +11653,7 @@ await client.identities.blocks.list("identity_id", {
|
|
|
11611
11653
|
<dl>
|
|
11612
11654
|
<dd>
|
|
11613
11655
|
|
|
11614
|
-
**identityId:** `string`
|
|
11656
|
+
**identityId:** `string` — The ID of the identity in the format 'identity-<uuid4>'
|
|
11615
11657
|
|
|
11616
11658
|
</dd>
|
|
11617
11659
|
</dl>
|
|
@@ -11948,10 +11990,14 @@ Upload a file to a data source.
|
|
|
11948
11990
|
<dd>
|
|
11949
11991
|
|
|
11950
11992
|
```typescript
|
|
11951
|
-
await client.sources.files.upload(
|
|
11952
|
-
|
|
11953
|
-
|
|
11954
|
-
|
|
11993
|
+
await client.sources.files.upload(
|
|
11994
|
+
fs.createReadStream("/path/to/your/file"),
|
|
11995
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
11996
|
+
{
|
|
11997
|
+
duplicateHandling: "skip",
|
|
11998
|
+
name: "name",
|
|
11999
|
+
},
|
|
12000
|
+
);
|
|
11955
12001
|
```
|
|
11956
12002
|
|
|
11957
12003
|
</dd>
|
|
@@ -12030,7 +12076,7 @@ List paginated files associated with a data source.
|
|
|
12030
12076
|
<dd>
|
|
12031
12077
|
|
|
12032
12078
|
```typescript
|
|
12033
|
-
await client.sources.files.list("
|
|
12079
|
+
await client.sources.files.list("source-123e4567-e89b-42d3-8456-426614174000", {
|
|
12034
12080
|
limit: 1,
|
|
12035
12081
|
after: "after",
|
|
12036
12082
|
includeContent: true,
|
|
@@ -12051,7 +12097,7 @@ await client.sources.files.list("source_id", {
|
|
|
12051
12097
|
<dl>
|
|
12052
12098
|
<dd>
|
|
12053
12099
|
|
|
12054
|
-
**sourceId:** `string`
|
|
12100
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
12055
12101
|
|
|
12056
12102
|
</dd>
|
|
12057
12103
|
</dl>
|
|
@@ -12106,7 +12152,10 @@ Delete a data source.
|
|
|
12106
12152
|
<dd>
|
|
12107
12153
|
|
|
12108
12154
|
```typescript
|
|
12109
|
-
await client.sources.files.delete(
|
|
12155
|
+
await client.sources.files.delete(
|
|
12156
|
+
"source-123e4567-e89b-42d3-8456-426614174000",
|
|
12157
|
+
"file-123e4567-e89b-42d3-8456-426614174000",
|
|
12158
|
+
);
|
|
12110
12159
|
```
|
|
12111
12160
|
|
|
12112
12161
|
</dd>
|
|
@@ -12122,7 +12171,7 @@ await client.sources.files.delete("source_id", "file_id");
|
|
|
12122
12171
|
<dl>
|
|
12123
12172
|
<dd>
|
|
12124
12173
|
|
|
12125
|
-
**sourceId:** `string`
|
|
12174
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
12126
12175
|
|
|
12127
12176
|
</dd>
|
|
12128
12177
|
</dl>
|
|
@@ -12130,7 +12179,7 @@ await client.sources.files.delete("source_id", "file_id");
|
|
|
12130
12179
|
<dl>
|
|
12131
12180
|
<dd>
|
|
12132
12181
|
|
|
12133
|
-
**fileId:** `string`
|
|
12182
|
+
**fileId:** `string` — The ID of the file in the format 'file-<uuid4>'
|
|
12134
12183
|
|
|
12135
12184
|
</dd>
|
|
12136
12185
|
</dl>
|
|
@@ -12179,7 +12228,7 @@ List all passages associated with a data source.
|
|
|
12179
12228
|
<dd>
|
|
12180
12229
|
|
|
12181
12230
|
```typescript
|
|
12182
|
-
await client.sources.passages.list("
|
|
12231
|
+
await client.sources.passages.list("source-123e4567-e89b-42d3-8456-426614174000", {
|
|
12183
12232
|
after: "after",
|
|
12184
12233
|
before: "before",
|
|
12185
12234
|
limit: 1,
|
|
@@ -12199,7 +12248,7 @@ await client.sources.passages.list("source_id", {
|
|
|
12199
12248
|
<dl>
|
|
12200
12249
|
<dd>
|
|
12201
12250
|
|
|
12202
|
-
**sourceId:** `string`
|
|
12251
|
+
**sourceId:** `string` — The ID of the source in the format 'source-<uuid4>'
|
|
12203
12252
|
|
|
12204
12253
|
</dd>
|
|
12205
12254
|
</dl>
|
|
@@ -12256,7 +12305,7 @@ Get step metrics by step ID.
|
|
|
12256
12305
|
<dd>
|
|
12257
12306
|
|
|
12258
12307
|
```typescript
|
|
12259
|
-
await client.steps.metrics.retrieve("
|
|
12308
|
+
await client.steps.metrics.retrieve("step-123e4567-e89b-42d3-8456-426614174000");
|
|
12260
12309
|
```
|
|
12261
12310
|
|
|
12262
12311
|
</dd>
|
|
@@ -12272,7 +12321,7 @@ await client.steps.metrics.retrieve("step_id");
|
|
|
12272
12321
|
<dl>
|
|
12273
12322
|
<dd>
|
|
12274
12323
|
|
|
12275
|
-
**stepId:** `string`
|
|
12324
|
+
**stepId:** `string` — The ID of the step in the format 'step-<uuid4>'
|
|
12276
12325
|
|
|
12277
12326
|
</dd>
|
|
12278
12327
|
</dl>
|
|
@@ -12306,7 +12355,7 @@ await client.steps.metrics.retrieve("step_id");
|
|
|
12306
12355
|
<dd>
|
|
12307
12356
|
|
|
12308
12357
|
```typescript
|
|
12309
|
-
await client.steps.trace.retrieve("
|
|
12358
|
+
await client.steps.trace.retrieve("step-123e4567-e89b-42d3-8456-426614174000");
|
|
12310
12359
|
```
|
|
12311
12360
|
|
|
12312
12361
|
</dd>
|
|
@@ -12322,7 +12371,7 @@ await client.steps.trace.retrieve("step_id");
|
|
|
12322
12371
|
<dl>
|
|
12323
12372
|
<dd>
|
|
12324
12373
|
|
|
12325
|
-
**stepId:** `string`
|
|
12374
|
+
**stepId:** `string` — The ID of the step in the format 'step-<uuid4>'
|
|
12326
12375
|
|
|
12327
12376
|
</dd>
|
|
12328
12377
|
</dl>
|
|
@@ -12371,7 +12420,7 @@ Modify feedback for a given step.
|
|
|
12371
12420
|
<dd>
|
|
12372
12421
|
|
|
12373
12422
|
```typescript
|
|
12374
|
-
await client.steps.feedback.create("
|
|
12423
|
+
await client.steps.feedback.create("step-123e4567-e89b-42d3-8456-426614174000");
|
|
12375
12424
|
```
|
|
12376
12425
|
|
|
12377
12426
|
</dd>
|
|
@@ -12387,7 +12436,7 @@ await client.steps.feedback.create("step_id");
|
|
|
12387
12436
|
<dl>
|
|
12388
12437
|
<dd>
|
|
12389
12438
|
|
|
12390
|
-
**stepId:** `string`
|
|
12439
|
+
**stepId:** `string` — The ID of the step in the format 'step-<uuid4>'
|
|
12391
12440
|
|
|
12392
12441
|
</dd>
|
|
12393
12442
|
</dl>
|
|
@@ -12444,7 +12493,7 @@ List messages for a given step.
|
|
|
12444
12493
|
<dd>
|
|
12445
12494
|
|
|
12446
12495
|
```typescript
|
|
12447
|
-
await client.steps.messages.list("
|
|
12496
|
+
await client.steps.messages.list("step-123e4567-e89b-42d3-8456-426614174000", {
|
|
12448
12497
|
before: "before",
|
|
12449
12498
|
after: "after",
|
|
12450
12499
|
limit: 1,
|
|
@@ -12466,7 +12515,7 @@ await client.steps.messages.list("step_id", {
|
|
|
12466
12515
|
<dl>
|
|
12467
12516
|
<dd>
|
|
12468
12517
|
|
|
12469
|
-
**stepId:** `string`
|
|
12518
|
+
**stepId:** `string` — The ID of the step in the format 'step-<uuid4>'
|
|
12470
12519
|
|
|
12471
12520
|
</dd>
|
|
12472
12521
|
</dl>
|