@band-ai/rest-client 0.0.117 → 0.0.118
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/README.md +12 -12
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +39 -12
- package/dist/cjs/Client.js +70 -25
- package/dist/cjs/api/errors/ServiceUnavailableError.d.ts +6 -0
- package/dist/cjs/api/errors/ServiceUnavailableError.js +54 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +1 -2
- package/dist/cjs/api/errors/index.d.ts +1 -0
- package/dist/cjs/api/errors/index.js +1 -0
- package/dist/cjs/api/resources/agentApiActivity/client/Client.d.ts +45 -0
- package/dist/cjs/api/resources/agentApiActivity/client/Client.js +137 -0
- package/dist/cjs/api/resources/agentApiActivity/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiActivity/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiActivity/client/requests/ReportAgentChatActivityRequest.d.ts +10 -0
- package/dist/cjs/api/resources/agentApiActivity/client/requests/ReportAgentChatActivityRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiActivity/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiActivity/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiActivity/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiActivity/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiActivity/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiActivity/index.js +18 -0
- package/dist/cjs/api/resources/agentApiActivity/types/ReportAgentChatActivityResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiActivity/types/ReportAgentChatActivityResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiActivity/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiActivity/types/index.js +17 -0
- package/dist/cjs/api/resources/agentApiChats/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/agentApiChats/client/Client.js +51 -51
- package/dist/cjs/api/resources/agentApiContacts/client/Client.d.ts +33 -33
- package/dist/cjs/api/resources/agentApiContacts/client/Client.js +88 -88
- package/dist/cjs/api/resources/agentApiMemories/client/Client.d.ts +50 -50
- package/dist/cjs/api/resources/agentApiMemories/client/Client.js +100 -100
- package/dist/cjs/api/resources/agentApiMessages/client/Client.d.ts +49 -49
- package/dist/cjs/api/resources/agentApiMessages/client/Client.js +79 -76
- package/dist/cjs/api/resources/humanApiAgents/client/Client.d.ts +107 -0
- package/dist/cjs/api/resources/humanApiAgents/client/Client.js +299 -0
- package/dist/cjs/api/resources/humanApiAgents/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiAgents/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/DeleteMyAgentRequest.d.ts +10 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/DeleteMyAgentRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/ListMyAgentsRequest.d.ts +35 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/ListMyAgentsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/RegisterMyAgentRequest.d.ts +13 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/RegisterMyAgentRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/humanApiAgents/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiAgents/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiAgents/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiAgents/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiAgents/index.js +18 -0
- package/dist/cjs/api/resources/humanApiAgents/types/DeleteMyAgentResponse.d.ts +15 -0
- package/dist/cjs/api/resources/humanApiAgents/types/DeleteMyAgentResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsRequestOrder.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsRequestOrder.js +8 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsRequestSort.d.ts +6 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsRequestSort.js +9 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsResponse.d.ts +36 -0
- package/dist/cjs/api/resources/humanApiAgents/types/ListMyAgentsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/types/RegisterMyAgentResponse.d.ts +27 -0
- package/dist/cjs/api/resources/humanApiAgents/types/RegisterMyAgentResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiAgents/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiAgents/types/index.js +21 -0
- package/dist/cjs/api/resources/humanApiChats/client/Client.d.ts +81 -0
- package/dist/cjs/api/resources/humanApiChats/client/Client.js +262 -0
- package/dist/cjs/api/resources/humanApiChats/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiChats/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/CreateMyChatRoomRequest.d.ts +17 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/CreateMyChatRoomRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/ListMyChatsRequest.d.ts +32 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/ListMyChatsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiChats/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiChats/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiChats/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiChats/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiChats/index.js +18 -0
- package/dist/cjs/api/resources/humanApiChats/types/CreateMyChatRoomResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiChats/types/CreateMyChatRoomResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiChats/types/GetMyChatRoomResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiChats/types/GetMyChatRoomResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestOrder.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestOrder.js +8 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestSortBy.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestSortBy.js +8 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestStatus.d.ts +6 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestStatus.js +9 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestType.d.ts +6 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsRequestType.js +9 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsResponse.d.ts +23 -0
- package/dist/cjs/api/resources/humanApiChats/types/ListMyChatsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiChats/types/index.d.ts +7 -0
- package/dist/cjs/api/resources/humanApiChats/types/index.js +23 -0
- package/dist/cjs/api/resources/humanApiContacts/client/Client.d.ts +201 -0
- package/dist/cjs/api/resources/humanApiContacts/client/Client.js +648 -0
- package/dist/cjs/api/resources/humanApiContacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiContacts/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/CreateContactRequestRequest.d.ts +19 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/CreateContactRequestRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListMyContactsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListMyContactsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListReceivedContactRequestsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListReceivedContactRequestsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListSentContactRequestsRequest.d.ts +17 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ListSentContactRequestsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/RemoveMyContactRequest.d.ts +10 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/RemoveMyContactRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ResolveHandleRequest.d.ts +10 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/ResolveHandleRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/index.d.ts +6 -0
- package/dist/cjs/api/resources/humanApiContacts/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiContacts/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiContacts/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiContacts/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiContacts/index.js +18 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ApproveContactRequestResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ApproveContactRequestResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/CancelContactRequestResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiContacts/types/CancelContactRequestResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/CreateContactRequestResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiContacts/types/CreateContactRequestResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListMyContactsResponse.d.ts +21 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListMyContactsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListReceivedContactRequestsResponse.d.ts +21 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListReceivedContactRequestsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListSentContactRequestsRequestStatus.d.ts +9 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListSentContactRequestsRequestStatus.js +12 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListSentContactRequestsResponse.d.ts +21 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ListSentContactRequestsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/RejectContactRequestResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiContacts/types/RejectContactRequestResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/RemoveMyContactResponse.d.ts +8 -0
- package/dist/cjs/api/resources/humanApiContacts/types/RemoveMyContactResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ResolveHandleResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiContacts/types/ResolveHandleResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiContacts/types/index.d.ts +10 -0
- package/dist/cjs/api/resources/humanApiContacts/types/index.js +26 -0
- package/dist/cjs/api/resources/humanApiMemories/client/Client.d.ts +131 -0
- package/dist/cjs/api/resources/humanApiMemories/client/Client.js +426 -0
- package/dist/cjs/api/resources/humanApiMemories/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiMemories/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiMemories/client/requests/ListUserMemoriesRequest.d.ts +31 -0
- package/dist/cjs/api/resources/humanApiMemories/client/requests/ListUserMemoriesRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiMemories/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiMemories/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiMemories/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiMemories/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiMemories/index.js +18 -0
- package/dist/cjs/api/resources/humanApiMemories/types/ArchiveUserMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiMemories/types/ArchiveUserMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/types/GetUserMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiMemories/types/GetUserMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/types/ListUserMemoriesResponse.d.ts +13 -0
- package/dist/cjs/api/resources/humanApiMemories/types/ListUserMemoriesResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/types/RestoreUserMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiMemories/types/RestoreUserMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/types/SupersedeUserMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiMemories/types/SupersedeUserMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMemories/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiMemories/types/index.js +21 -0
- package/dist/cjs/api/resources/humanApiMessages/client/Client.d.ts +97 -0
- package/dist/cjs/api/resources/humanApiMessages/client/Client.js +237 -0
- package/dist/cjs/api/resources/humanApiMessages/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiMessages/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/ListMyChatMessagesRequest.d.ts +26 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/ListMyChatMessagesRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/SendMyChatMessageRequest.d.ts +15 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/SendMyChatMessageRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiMessages/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiMessages/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiMessages/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiMessages/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiMessages/index.js +18 -0
- package/dist/cjs/api/resources/humanApiMessages/types/ListMyChatMessagesRequestMessageType.d.ts +10 -0
- package/dist/cjs/api/resources/humanApiMessages/types/ListMyChatMessagesRequestMessageType.js +13 -0
- package/dist/cjs/api/resources/humanApiMessages/types/ListMyChatMessagesResponse.d.ts +23 -0
- package/dist/cjs/api/resources/humanApiMessages/types/ListMyChatMessagesResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMessages/types/SendMyChatMessageResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiMessages/types/SendMyChatMessageResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiMessages/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/humanApiMessages/types/index.js +19 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/Client.d.ts +84 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/Client.js +264 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/AddMyChatParticipantRequest.d.ts +12 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/AddMyChatParticipantRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/ListMyChatParticipantsRequest.d.ts +23 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/ListMyChatParticipantsRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiParticipants/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiParticipants/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiParticipants/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiParticipants/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiParticipants/index.js +18 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/AddMyChatParticipantResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/AddMyChatParticipantResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/ListMyChatParticipantsRequestParticipantType.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/ListMyChatParticipantsRequestParticipantType.js +8 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/ListMyChatParticipantsResponse.d.ts +23 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/ListMyChatParticipantsResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/RemoveMyChatParticipantResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/RemoveMyChatParticipantResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/index.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiParticipants/types/index.js +20 -0
- package/dist/cjs/api/resources/humanApiPeers/client/Client.d.ts +46 -0
- package/dist/cjs/api/resources/humanApiPeers/client/Client.js +140 -0
- package/dist/cjs/api/resources/humanApiPeers/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiPeers/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiPeers/client/requests/ListMyPeersRequest.d.ts +20 -0
- package/dist/cjs/api/resources/humanApiPeers/client/requests/ListMyPeersRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiPeers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiPeers/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiPeers/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiPeers/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiPeers/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiPeers/index.js +18 -0
- package/dist/cjs/api/resources/humanApiPeers/types/ListMyPeersRequestType.d.ts +5 -0
- package/dist/cjs/api/resources/humanApiPeers/types/ListMyPeersRequestType.js +8 -0
- package/dist/cjs/api/resources/humanApiPeers/types/ListMyPeersResponse.d.ts +13 -0
- package/dist/cjs/api/resources/humanApiPeers/types/ListMyPeersResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiPeers/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiPeers/types/index.js +18 -0
- package/dist/cjs/api/resources/humanApiProfile/client/Client.d.ts +46 -0
- package/dist/cjs/api/resources/humanApiProfile/client/Client.js +171 -0
- package/dist/cjs/api/resources/humanApiProfile/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiProfile/client/index.js +17 -0
- package/dist/cjs/api/resources/humanApiProfile/client/requests/UpdateMyProfileRequest.d.ts +21 -0
- package/dist/cjs/api/resources/humanApiProfile/client/requests/UpdateMyProfileRequest.js +3 -0
- package/dist/cjs/api/resources/humanApiProfile/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/humanApiProfile/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/humanApiProfile/exports.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiProfile/exports.js +21 -0
- package/dist/cjs/api/resources/humanApiProfile/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiProfile/index.js +18 -0
- package/dist/cjs/api/resources/humanApiProfile/types/GetMyProfileResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiProfile/types/GetMyProfileResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiProfile/types/UpdateMyProfileResponse.d.ts +4 -0
- package/dist/cjs/api/resources/humanApiProfile/types/UpdateMyProfileResponse.js +3 -0
- package/dist/cjs/api/resources/humanApiProfile/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/humanApiProfile/types/index.js +18 -0
- package/dist/cjs/api/resources/index.d.ts +27 -0
- package/dist/cjs/api/resources/index.js +28 -1
- package/dist/cjs/api/types/AgentActivityResponse.d.ts +7 -0
- package/dist/cjs/api/types/AgentActivityResponse.js +3 -0
- package/dist/cjs/api/types/AgentRegisterRequest.d.ts +9 -0
- package/dist/cjs/api/types/AgentRegisterRequest.js +3 -0
- package/dist/cjs/api/types/ChatParticipantDetails.d.ts +29 -0
- package/dist/cjs/api/types/ChatParticipantDetails.js +12 -0
- package/dist/cjs/api/types/Contact.d.ts +41 -0
- package/dist/cjs/api/types/Contact.js +12 -0
- package/dist/cjs/api/types/ContactRequest.d.ts +68 -0
- package/dist/cjs/api/types/ContactRequest.js +25 -0
- package/dist/cjs/api/types/ContactRequestActionResponse.d.ts +18 -0
- package/dist/cjs/api/types/ContactRequestActionResponse.js +13 -0
- package/dist/cjs/api/types/MeChatRoom.d.ts +35 -0
- package/dist/cjs/api/types/MeChatRoom.js +19 -0
- package/dist/cjs/api/types/MyAgent.d.ts +29 -0
- package/dist/cjs/api/types/MyAgent.js +3 -0
- package/dist/cjs/api/types/ResolvedEntity.d.ts +21 -0
- package/dist/cjs/api/types/ResolvedEntity.js +12 -0
- package/dist/cjs/api/types/UserDetails.d.ts +25 -0
- package/dist/cjs/api/types/UserDetails.js +12 -0
- package/dist/cjs/api/types/UserMemory.d.ts +73 -0
- package/dist/cjs/api/types/UserMemory.js +40 -0
- package/dist/cjs/api/types/index.d.ts +11 -0
- package/dist/cjs/api/types/index.js +11 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +39 -12
- package/dist/esm/Client.mjs +59 -14
- package/dist/esm/api/errors/ServiceUnavailableError.d.mts +6 -0
- package/dist/esm/api/errors/ServiceUnavailableError.mjs +17 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +1 -2
- package/dist/esm/api/errors/index.d.mts +1 -0
- package/dist/esm/api/errors/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiActivity/client/Client.d.mts +45 -0
- package/dist/esm/api/resources/agentApiActivity/client/Client.mjs +100 -0
- package/dist/esm/api/resources/agentApiActivity/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiActivity/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiActivity/client/requests/ReportAgentChatActivityRequest.d.mts +10 -0
- package/dist/esm/api/resources/agentApiActivity/client/requests/ReportAgentChatActivityRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiActivity/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiActivity/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiActivity/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiActivity/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiActivity/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiActivity/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiActivity/types/ReportAgentChatActivityResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiActivity/types/ReportAgentChatActivityResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiActivity/types/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiActivity/types/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiChats/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/agentApiChats/client/Client.mjs +51 -51
- package/dist/esm/api/resources/agentApiContacts/client/Client.d.mts +33 -33
- package/dist/esm/api/resources/agentApiContacts/client/Client.mjs +88 -88
- package/dist/esm/api/resources/agentApiMemories/client/Client.d.mts +50 -50
- package/dist/esm/api/resources/agentApiMemories/client/Client.mjs +100 -100
- package/dist/esm/api/resources/agentApiMessages/client/Client.d.mts +49 -49
- package/dist/esm/api/resources/agentApiMessages/client/Client.mjs +79 -76
- package/dist/esm/api/resources/humanApiAgents/client/Client.d.mts +107 -0
- package/dist/esm/api/resources/humanApiAgents/client/Client.mjs +262 -0
- package/dist/esm/api/resources/humanApiAgents/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiAgents/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/DeleteMyAgentRequest.d.mts +10 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/DeleteMyAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/ListMyAgentsRequest.d.mts +35 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/ListMyAgentsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/RegisterMyAgentRequest.d.mts +13 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/RegisterMyAgentRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/humanApiAgents/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiAgents/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiAgents/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiAgents/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiAgents/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/types/DeleteMyAgentResponse.d.mts +15 -0
- package/dist/esm/api/resources/humanApiAgents/types/DeleteMyAgentResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsRequestOrder.d.mts +5 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsRequestOrder.mjs +5 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsRequestSort.d.mts +6 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsRequestSort.mjs +6 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsResponse.d.mts +36 -0
- package/dist/esm/api/resources/humanApiAgents/types/ListMyAgentsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/types/RegisterMyAgentResponse.d.mts +27 -0
- package/dist/esm/api/resources/humanApiAgents/types/RegisterMyAgentResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiAgents/types/index.d.mts +5 -0
- package/dist/esm/api/resources/humanApiAgents/types/index.mjs +5 -0
- package/dist/esm/api/resources/humanApiChats/client/Client.d.mts +81 -0
- package/dist/esm/api/resources/humanApiChats/client/Client.mjs +225 -0
- package/dist/esm/api/resources/humanApiChats/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiChats/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/CreateMyChatRoomRequest.d.mts +17 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/CreateMyChatRoomRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/ListMyChatsRequest.d.mts +32 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/ListMyChatsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiChats/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiChats/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiChats/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiChats/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiChats/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/types/CreateMyChatRoomResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiChats/types/CreateMyChatRoomResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/types/GetMyChatRoomResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiChats/types/GetMyChatRoomResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestOrder.d.mts +5 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestOrder.mjs +5 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestSortBy.d.mts +5 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestSortBy.mjs +5 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestStatus.d.mts +6 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestStatus.mjs +6 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestType.d.mts +6 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsRequestType.mjs +6 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsResponse.d.mts +23 -0
- package/dist/esm/api/resources/humanApiChats/types/ListMyChatsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiChats/types/index.d.mts +7 -0
- package/dist/esm/api/resources/humanApiChats/types/index.mjs +7 -0
- package/dist/esm/api/resources/humanApiContacts/client/Client.d.mts +201 -0
- package/dist/esm/api/resources/humanApiContacts/client/Client.mjs +611 -0
- package/dist/esm/api/resources/humanApiContacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiContacts/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/CreateContactRequestRequest.d.mts +19 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/CreateContactRequestRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListMyContactsRequest.d.mts +13 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListMyContactsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListReceivedContactRequestsRequest.d.mts +13 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListReceivedContactRequestsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListSentContactRequestsRequest.d.mts +17 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ListSentContactRequestsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/RemoveMyContactRequest.d.mts +10 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/RemoveMyContactRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ResolveHandleRequest.d.mts +10 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/ResolveHandleRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/index.d.mts +6 -0
- package/dist/esm/api/resources/humanApiContacts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiContacts/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiContacts/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiContacts/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiContacts/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/ApproveContactRequestResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiContacts/types/ApproveContactRequestResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/CancelContactRequestResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiContacts/types/CancelContactRequestResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/CreateContactRequestResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiContacts/types/CreateContactRequestResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListMyContactsResponse.d.mts +21 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListMyContactsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListReceivedContactRequestsResponse.d.mts +21 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListReceivedContactRequestsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListSentContactRequestsRequestStatus.d.mts +9 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListSentContactRequestsRequestStatus.mjs +9 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListSentContactRequestsResponse.d.mts +21 -0
- package/dist/esm/api/resources/humanApiContacts/types/ListSentContactRequestsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/RejectContactRequestResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiContacts/types/RejectContactRequestResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/RemoveMyContactResponse.d.mts +8 -0
- package/dist/esm/api/resources/humanApiContacts/types/RemoveMyContactResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/ResolveHandleResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiContacts/types/ResolveHandleResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiContacts/types/index.d.mts +10 -0
- package/dist/esm/api/resources/humanApiContacts/types/index.mjs +10 -0
- package/dist/esm/api/resources/humanApiMemories/client/Client.d.mts +131 -0
- package/dist/esm/api/resources/humanApiMemories/client/Client.mjs +389 -0
- package/dist/esm/api/resources/humanApiMemories/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiMemories/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiMemories/client/requests/ListUserMemoriesRequest.d.mts +31 -0
- package/dist/esm/api/resources/humanApiMemories/client/requests/ListUserMemoriesRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiMemories/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiMemories/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiMemories/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiMemories/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiMemories/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/ArchiveUserMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiMemories/types/ArchiveUserMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/GetUserMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiMemories/types/GetUserMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/ListUserMemoriesResponse.d.mts +13 -0
- package/dist/esm/api/resources/humanApiMemories/types/ListUserMemoriesResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/RestoreUserMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiMemories/types/RestoreUserMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/SupersedeUserMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiMemories/types/SupersedeUserMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMemories/types/index.d.mts +5 -0
- package/dist/esm/api/resources/humanApiMemories/types/index.mjs +5 -0
- package/dist/esm/api/resources/humanApiMessages/client/Client.d.mts +97 -0
- package/dist/esm/api/resources/humanApiMessages/client/Client.mjs +200 -0
- package/dist/esm/api/resources/humanApiMessages/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiMessages/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/ListMyChatMessagesRequest.d.mts +26 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/ListMyChatMessagesRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/SendMyChatMessageRequest.d.mts +15 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/SendMyChatMessageRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiMessages/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiMessages/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiMessages/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiMessages/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiMessages/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiMessages/types/ListMyChatMessagesRequestMessageType.d.mts +10 -0
- package/dist/esm/api/resources/humanApiMessages/types/ListMyChatMessagesRequestMessageType.mjs +10 -0
- package/dist/esm/api/resources/humanApiMessages/types/ListMyChatMessagesResponse.d.mts +23 -0
- package/dist/esm/api/resources/humanApiMessages/types/ListMyChatMessagesResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMessages/types/SendMyChatMessageResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiMessages/types/SendMyChatMessageResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiMessages/types/index.d.mts +3 -0
- package/dist/esm/api/resources/humanApiMessages/types/index.mjs +3 -0
- package/dist/esm/api/resources/humanApiParticipants/client/Client.d.mts +84 -0
- package/dist/esm/api/resources/humanApiParticipants/client/Client.mjs +227 -0
- package/dist/esm/api/resources/humanApiParticipants/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiParticipants/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/AddMyChatParticipantRequest.d.mts +12 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/AddMyChatParticipantRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/ListMyChatParticipantsRequest.d.mts +23 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/ListMyChatParticipantsRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiParticipants/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiParticipants/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiParticipants/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiParticipants/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiParticipants/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/types/AddMyChatParticipantResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiParticipants/types/AddMyChatParticipantResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/types/ListMyChatParticipantsRequestParticipantType.d.mts +5 -0
- package/dist/esm/api/resources/humanApiParticipants/types/ListMyChatParticipantsRequestParticipantType.mjs +5 -0
- package/dist/esm/api/resources/humanApiParticipants/types/ListMyChatParticipantsResponse.d.mts +23 -0
- package/dist/esm/api/resources/humanApiParticipants/types/ListMyChatParticipantsResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/types/RemoveMyChatParticipantResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiParticipants/types/RemoveMyChatParticipantResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiParticipants/types/index.d.mts +4 -0
- package/dist/esm/api/resources/humanApiParticipants/types/index.mjs +4 -0
- package/dist/esm/api/resources/humanApiPeers/client/Client.d.mts +46 -0
- package/dist/esm/api/resources/humanApiPeers/client/Client.mjs +103 -0
- package/dist/esm/api/resources/humanApiPeers/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiPeers/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiPeers/client/requests/ListMyPeersRequest.d.mts +20 -0
- package/dist/esm/api/resources/humanApiPeers/client/requests/ListMyPeersRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiPeers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiPeers/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiPeers/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiPeers/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiPeers/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiPeers/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiPeers/types/ListMyPeersRequestType.d.mts +5 -0
- package/dist/esm/api/resources/humanApiPeers/types/ListMyPeersRequestType.mjs +5 -0
- package/dist/esm/api/resources/humanApiPeers/types/ListMyPeersResponse.d.mts +13 -0
- package/dist/esm/api/resources/humanApiPeers/types/ListMyPeersResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiPeers/types/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiPeers/types/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiProfile/client/Client.d.mts +46 -0
- package/dist/esm/api/resources/humanApiProfile/client/Client.mjs +134 -0
- package/dist/esm/api/resources/humanApiProfile/client/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiProfile/client/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiProfile/client/requests/UpdateMyProfileRequest.d.mts +21 -0
- package/dist/esm/api/resources/humanApiProfile/client/requests/UpdateMyProfileRequest.mjs +2 -0
- package/dist/esm/api/resources/humanApiProfile/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/humanApiProfile/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/humanApiProfile/exports.d.mts +2 -0
- package/dist/esm/api/resources/humanApiProfile/exports.mjs +3 -0
- package/dist/esm/api/resources/humanApiProfile/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiProfile/index.mjs +2 -0
- package/dist/esm/api/resources/humanApiProfile/types/GetMyProfileResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiProfile/types/GetMyProfileResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiProfile/types/UpdateMyProfileResponse.d.mts +4 -0
- package/dist/esm/api/resources/humanApiProfile/types/UpdateMyProfileResponse.mjs +2 -0
- package/dist/esm/api/resources/humanApiProfile/types/index.d.mts +2 -0
- package/dist/esm/api/resources/humanApiProfile/types/index.mjs +2 -0
- package/dist/esm/api/resources/index.d.mts +27 -0
- package/dist/esm/api/resources/index.mjs +27 -0
- package/dist/esm/api/types/AgentActivityResponse.d.mts +7 -0
- package/dist/esm/api/types/AgentActivityResponse.mjs +2 -0
- package/dist/esm/api/types/AgentRegisterRequest.d.mts +9 -0
- package/dist/esm/api/types/AgentRegisterRequest.mjs +2 -0
- package/dist/esm/api/types/ChatParticipantDetails.d.mts +29 -0
- package/dist/esm/api/types/ChatParticipantDetails.mjs +9 -0
- package/dist/esm/api/types/Contact.d.mts +41 -0
- package/dist/esm/api/types/Contact.mjs +9 -0
- package/dist/esm/api/types/ContactRequest.d.mts +68 -0
- package/dist/esm/api/types/ContactRequest.mjs +22 -0
- package/dist/esm/api/types/ContactRequestActionResponse.d.mts +18 -0
- package/dist/esm/api/types/ContactRequestActionResponse.mjs +10 -0
- package/dist/esm/api/types/MeChatRoom.d.mts +35 -0
- package/dist/esm/api/types/MeChatRoom.mjs +16 -0
- package/dist/esm/api/types/MyAgent.d.mts +29 -0
- package/dist/esm/api/types/MyAgent.mjs +2 -0
- package/dist/esm/api/types/ResolvedEntity.d.mts +21 -0
- package/dist/esm/api/types/ResolvedEntity.mjs +9 -0
- package/dist/esm/api/types/UserDetails.d.mts +25 -0
- package/dist/esm/api/types/UserDetails.mjs +9 -0
- package/dist/esm/api/types/UserMemory.d.mts +73 -0
- package/dist/esm/api/types/UserMemory.mjs +37 -0
- package/dist/esm/api/types/index.d.mts +11 -0
- package/dist/esm/api/types/index.mjs +11 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +142 -43
- package/reference.md +2650 -472
package/reference.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
## Agent API/
|
|
3
|
-
<details><summary><code>client.
|
|
2
|
+
## Agent API/Contacts
|
|
3
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">respondToAgentContactRequest</a>({ ...params }) -> Band.RespondToAgentContactRequestResponse</code></summary>
|
|
4
4
|
<dl>
|
|
5
5
|
<dd>
|
|
6
6
|
|
|
@@ -12,7 +12,10 @@
|
|
|
12
12
|
<dl>
|
|
13
13
|
<dd>
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Approve, reject, or cancel a contact request.
|
|
16
|
+
|
|
17
|
+
- `approve`/`reject`: For requests you RECEIVED (handle = requester's handle)
|
|
18
|
+
- `cancel`: For requests you SENT (handle = recipient's handle)
|
|
16
19
|
</dd>
|
|
17
20
|
</dl>
|
|
18
21
|
</dd>
|
|
@@ -27,9 +30,8 @@ Lists chat rooms where the current agent is a participant
|
|
|
27
30
|
<dd>
|
|
28
31
|
|
|
29
32
|
```typescript
|
|
30
|
-
await client.
|
|
31
|
-
|
|
32
|
-
page_size: 1
|
|
33
|
+
await client.agentApiContacts.respondToAgentContactRequest({
|
|
34
|
+
action: "approve"
|
|
33
35
|
});
|
|
34
36
|
|
|
35
37
|
```
|
|
@@ -46,7 +48,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
46
48
|
<dl>
|
|
47
49
|
<dd>
|
|
48
50
|
|
|
49
|
-
**request:** `Band.
|
|
51
|
+
**request:** `Band.RespondToAgentContactRequestRequest`
|
|
50
52
|
|
|
51
53
|
</dd>
|
|
52
54
|
</dl>
|
|
@@ -54,7 +56,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
54
56
|
<dl>
|
|
55
57
|
<dd>
|
|
56
58
|
|
|
57
|
-
**requestOptions:** `
|
|
59
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
58
60
|
|
|
59
61
|
</dd>
|
|
60
62
|
</dl>
|
|
@@ -66,7 +68,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
66
68
|
</dl>
|
|
67
69
|
</details>
|
|
68
70
|
|
|
69
|
-
<details><summary><code>client.
|
|
71
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">addAgentContact</a>({ ...params }) -> Band.AddAgentContactResponse</code></summary>
|
|
70
72
|
<dl>
|
|
71
73
|
<dd>
|
|
72
74
|
|
|
@@ -78,7 +80,10 @@ await client.agentApiChats.listAgentChats({
|
|
|
78
80
|
<dl>
|
|
79
81
|
<dd>
|
|
80
82
|
|
|
81
|
-
|
|
83
|
+
Resolves handle and sends contact request.
|
|
84
|
+
|
|
85
|
+
Returns `pending` when a new request is created.
|
|
86
|
+
Returns `approved` when an inverse request existed and was auto-accepted.
|
|
82
87
|
</dd>
|
|
83
88
|
</dl>
|
|
84
89
|
</dd>
|
|
@@ -93,8 +98,8 @@ Creates a new chat room with the agent as owner
|
|
|
93
98
|
<dd>
|
|
94
99
|
|
|
95
100
|
```typescript
|
|
96
|
-
await client.
|
|
97
|
-
|
|
101
|
+
await client.agentApiContacts.addAgentContact({
|
|
102
|
+
handle: "@john"
|
|
98
103
|
});
|
|
99
104
|
|
|
100
105
|
```
|
|
@@ -111,7 +116,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
111
116
|
<dl>
|
|
112
117
|
<dd>
|
|
113
118
|
|
|
114
|
-
**request:** `Band.
|
|
119
|
+
**request:** `Band.AddAgentContactRequest`
|
|
115
120
|
|
|
116
121
|
</dd>
|
|
117
122
|
</dl>
|
|
@@ -119,7 +124,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
119
124
|
<dl>
|
|
120
125
|
<dd>
|
|
121
126
|
|
|
122
|
-
**requestOptions:** `
|
|
127
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
123
128
|
|
|
124
129
|
</dd>
|
|
125
130
|
</dl>
|
|
@@ -131,7 +136,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
131
136
|
</dl>
|
|
132
137
|
</details>
|
|
133
138
|
|
|
134
|
-
<details><summary><code>client.
|
|
139
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">listAgentContactRequests</a>({ ...params }) -> Band.ListAgentContactRequestsResponse</code></summary>
|
|
135
140
|
<dl>
|
|
136
141
|
<dd>
|
|
137
142
|
|
|
@@ -143,7 +148,12 @@ await client.agentApiChats.createAgentChat({
|
|
|
143
148
|
<dl>
|
|
144
149
|
<dd>
|
|
145
150
|
|
|
146
|
-
Returns
|
|
151
|
+
Returns both received and sent requests with handles and pagination metadata.
|
|
152
|
+
|
|
153
|
+
- Received requests are always filtered to pending status.
|
|
154
|
+
- Sent requests can be filtered by status using `sent_status` parameter.
|
|
155
|
+
- Pagination applies per-direction: response may contain up to 2×page_size items total.
|
|
156
|
+
- Each direction includes separate total counts and total_pages in metadata.
|
|
147
157
|
</dd>
|
|
148
158
|
</dl>
|
|
149
159
|
</dd>
|
|
@@ -158,7 +168,11 @@ Returns details of a specific chat room where the agent is a participant
|
|
|
158
168
|
<dd>
|
|
159
169
|
|
|
160
170
|
```typescript
|
|
161
|
-
await client.
|
|
171
|
+
await client.agentApiContacts.listAgentContactRequests({
|
|
172
|
+
page: 1,
|
|
173
|
+
page_size: 1,
|
|
174
|
+
sent_status: "pending"
|
|
175
|
+
});
|
|
162
176
|
|
|
163
177
|
```
|
|
164
178
|
</dd>
|
|
@@ -174,7 +188,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
174
188
|
<dl>
|
|
175
189
|
<dd>
|
|
176
190
|
|
|
177
|
-
**
|
|
191
|
+
**request:** `Band.ListAgentContactRequestsRequest`
|
|
178
192
|
|
|
179
193
|
</dd>
|
|
180
194
|
</dl>
|
|
@@ -182,7 +196,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
182
196
|
<dl>
|
|
183
197
|
<dd>
|
|
184
198
|
|
|
185
|
-
**requestOptions:** `
|
|
199
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
186
200
|
|
|
187
201
|
</dd>
|
|
188
202
|
</dl>
|
|
@@ -194,8 +208,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
194
208
|
</dl>
|
|
195
209
|
</details>
|
|
196
210
|
|
|
197
|
-
|
|
198
|
-
<details><summary><code>client.agentApiContext.<a href="/src/api/resources/agentApiContext/client/Client.ts">getAgentChatContext</a>(chat_id, { ...params }) -> Band.GetAgentChatContextResponse</code></summary>
|
|
211
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">listAgentContacts</a>({ ...params }) -> Band.ListAgentContactsResponse</code></summary>
|
|
199
212
|
<dl>
|
|
200
213
|
<dd>
|
|
201
214
|
|
|
@@ -207,22 +220,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
207
220
|
<dl>
|
|
208
221
|
<dd>
|
|
209
222
|
|
|
210
|
-
Returns
|
|
211
|
-
|
|
212
|
-
This includes:
|
|
213
|
-
- All messages the agent sent (any type: text, tool_call, tool_result, thought, etc.)
|
|
214
|
-
- All text messages that @mention the agent
|
|
215
|
-
|
|
216
|
-
Use this endpoint to load the complete context an external agent needs to resume execution.
|
|
217
|
-
|
|
218
|
-
Messages are returned in chronological order (oldest first).
|
|
219
|
-
|
|
220
|
-
## Pagination
|
|
221
|
-
|
|
222
|
-
Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
223
|
-
`metadata` includes `next_cursor` and `has_more`.
|
|
224
|
-
|
|
225
|
-
`page` and `page_size` are deprecated and will be removed in API 2.0.0 (2026-10-01).
|
|
223
|
+
Returns contacts with handles for easy reference.
|
|
226
224
|
</dd>
|
|
227
225
|
</dl>
|
|
228
226
|
</dd>
|
|
@@ -237,9 +235,7 @@ Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
|
237
235
|
<dd>
|
|
238
236
|
|
|
239
237
|
```typescript
|
|
240
|
-
await client.
|
|
241
|
-
cursor: "cursor",
|
|
242
|
-
limit: 1,
|
|
238
|
+
await client.agentApiContacts.listAgentContacts({
|
|
243
239
|
page: 1,
|
|
244
240
|
page_size: 1
|
|
245
241
|
});
|
|
@@ -258,15 +254,7 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
258
254
|
<dl>
|
|
259
255
|
<dd>
|
|
260
256
|
|
|
261
|
-
**
|
|
262
|
-
|
|
263
|
-
</dd>
|
|
264
|
-
</dl>
|
|
265
|
-
|
|
266
|
-
<dl>
|
|
267
|
-
<dd>
|
|
268
|
-
|
|
269
|
-
**request:** `Band.GetAgentChatContextRequest`
|
|
257
|
+
**request:** `Band.ListAgentContactsRequest`
|
|
270
258
|
|
|
271
259
|
</dd>
|
|
272
260
|
</dl>
|
|
@@ -274,7 +262,7 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
274
262
|
<dl>
|
|
275
263
|
<dd>
|
|
276
264
|
|
|
277
|
-
**requestOptions:** `
|
|
265
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
278
266
|
|
|
279
267
|
</dd>
|
|
280
268
|
</dl>
|
|
@@ -286,8 +274,7 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
286
274
|
</dl>
|
|
287
275
|
</details>
|
|
288
276
|
|
|
289
|
-
|
|
290
|
-
<details><summary><code>client.agentApiEvents.<a href="/src/api/resources/agentApiEvents/client/Client.ts">createAgentChatEvent</a>(chat_id, { ...params }) -> Band.CreateAgentChatEventResponse</code></summary>
|
|
277
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">removeAgentContact</a>({ ...params }) -> Band.RemoveAgentContactResponse</code></summary>
|
|
291
278
|
<dl>
|
|
292
279
|
<dd>
|
|
293
280
|
|
|
@@ -299,18 +286,7 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
299
286
|
<dl>
|
|
300
287
|
<dd>
|
|
301
288
|
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
Events do NOT require mentions - they report what happened rather than directing messages
|
|
305
|
-
at participants. Use this endpoint to record:
|
|
306
|
-
|
|
307
|
-
- **tool_call**: When the agent invokes a tool
|
|
308
|
-
- **tool_result**: The result returned from a tool execution
|
|
309
|
-
- **thought**: Agent's internal reasoning or thinking process
|
|
310
|
-
- **error**: Error messages and failure notifications
|
|
311
|
-
- **task**: Task-related messages
|
|
312
|
-
|
|
313
|
-
For text messages with mentions, use POST /agent/chats/{chat_id}/messages instead.
|
|
289
|
+
Removes contact by handle or ID. Both directions of the contact relationship are removed.
|
|
314
290
|
</dd>
|
|
315
291
|
</dl>
|
|
316
292
|
</dd>
|
|
@@ -325,12 +301,7 @@ For text messages with mentions, use POST /agent/chats/{chat_id}/messages instea
|
|
|
325
301
|
<dd>
|
|
326
302
|
|
|
327
303
|
```typescript
|
|
328
|
-
await client.
|
|
329
|
-
event: {
|
|
330
|
-
content: "Calling send_direct_message_service",
|
|
331
|
-
message_type: "tool_call"
|
|
332
|
-
}
|
|
333
|
-
});
|
|
304
|
+
await client.agentApiContacts.removeAgentContact();
|
|
334
305
|
|
|
335
306
|
```
|
|
336
307
|
</dd>
|
|
@@ -346,15 +317,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
346
317
|
<dl>
|
|
347
318
|
<dd>
|
|
348
319
|
|
|
349
|
-
**
|
|
350
|
-
|
|
351
|
-
</dd>
|
|
352
|
-
</dl>
|
|
353
|
-
|
|
354
|
-
<dl>
|
|
355
|
-
<dd>
|
|
356
|
-
|
|
357
|
-
**request:** `Band.CreateAgentChatEventRequest`
|
|
320
|
+
**request:** `Band.RemoveAgentContactRequest`
|
|
358
321
|
|
|
359
322
|
</dd>
|
|
360
323
|
</dl>
|
|
@@ -362,7 +325,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
362
325
|
<dl>
|
|
363
326
|
<dd>
|
|
364
327
|
|
|
365
|
-
**requestOptions:** `
|
|
328
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
366
329
|
|
|
367
330
|
</dd>
|
|
368
331
|
</dl>
|
|
@@ -374,8 +337,8 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
374
337
|
</dl>
|
|
375
338
|
</details>
|
|
376
339
|
|
|
377
|
-
##
|
|
378
|
-
<details><summary><code>client.
|
|
340
|
+
## Human API/Contacts
|
|
341
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">rejectContactRequest</a>(id) -> Band.RejectContactRequestResponse</code></summary>
|
|
379
342
|
<dl>
|
|
380
343
|
<dd>
|
|
381
344
|
|
|
@@ -387,90 +350,81 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
387
350
|
<dl>
|
|
388
351
|
<dd>
|
|
389
352
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
## Default Behavior (no status param)
|
|
393
|
-
|
|
394
|
-
Returns all messages that are NOT processed. This is the recommended way to get
|
|
395
|
-
all work the agent should handle, including:
|
|
396
|
-
- New messages (no delivery status yet)
|
|
397
|
-
- Delivered messages (acknowledged but not started)
|
|
398
|
-
- Processing messages (stuck/crashed - supports crash recovery)
|
|
399
|
-
- Failed messages (available for retry)
|
|
353
|
+
Rejects a pending contact request you received.
|
|
400
354
|
|
|
401
|
-
|
|
355
|
+
The requester will not be notified of the rejection.
|
|
356
|
+
</dd>
|
|
357
|
+
</dl>
|
|
358
|
+
</dd>
|
|
359
|
+
</dl>
|
|
402
360
|
|
|
403
|
-
|
|
404
|
-
|--------------|----------------------------------------------------------------------|-----------------------------|
|
|
405
|
-
| *(no param)* | Everything NOT processed | Get all work to do |
|
|
406
|
-
| `pending` | No status, delivered, or failed without active attempt | Queue depth (untouched) |
|
|
407
|
-
| `processing` | Currently being processed | In-flight work |
|
|
408
|
-
| `processed` | Successfully completed | Done items |
|
|
409
|
-
| `failed` | Failed only | Failure backlog |
|
|
410
|
-
| `all` | All messages regardless of status | Full history |
|
|
361
|
+
#### 🔌 Usage
|
|
411
362
|
|
|
412
|
-
|
|
363
|
+
<dl>
|
|
364
|
+
<dd>
|
|
413
365
|
|
|
414
|
-
|
|
366
|
+
<dl>
|
|
367
|
+
<dd>
|
|
415
368
|
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
fetch the next page.
|
|
369
|
+
```typescript
|
|
370
|
+
await client.humanApiContacts.rejectContactRequest("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
419
371
|
|
|
420
|
-
|
|
421
|
-
|
|
372
|
+
```
|
|
373
|
+
</dd>
|
|
374
|
+
</dl>
|
|
375
|
+
</dd>
|
|
376
|
+
</dl>
|
|
422
377
|
|
|
423
|
-
|
|
378
|
+
#### ⚙️ Parameters
|
|
424
379
|
|
|
425
|
-
|
|
380
|
+
<dl>
|
|
381
|
+
<dd>
|
|
426
382
|
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
3. Process the message (reasoning loop, tool calls, etc.)
|
|
430
|
-
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
431
|
-
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
432
|
-
5. Repeat
|
|
383
|
+
<dl>
|
|
384
|
+
<dd>
|
|
433
385
|
|
|
434
|
-
**
|
|
435
|
-
|
|
436
|
-
|
|
386
|
+
**id:** `string` — Contact request ID
|
|
387
|
+
|
|
388
|
+
</dd>
|
|
389
|
+
</dl>
|
|
437
390
|
|
|
438
|
-
|
|
391
|
+
<dl>
|
|
392
|
+
<dd>
|
|
439
393
|
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
1. Call `GET /messages` (default) - it includes stuck `processing` messages
|
|
443
|
-
2. The stuck message will be returned so you can retry it
|
|
444
|
-
3. Call `/processing` again to reset the attempt timestamp, then continue
|
|
394
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
395
|
+
|
|
445
396
|
</dd>
|
|
446
397
|
</dl>
|
|
447
398
|
</dd>
|
|
448
399
|
</dl>
|
|
449
400
|
|
|
450
|
-
#### 🔌 Usage
|
|
451
401
|
|
|
402
|
+
</dd>
|
|
403
|
+
</dl>
|
|
404
|
+
</details>
|
|
405
|
+
|
|
406
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">removeMyContact</a>({ ...params }) -> Band.RemoveMyContactResponse</code></summary>
|
|
452
407
|
<dl>
|
|
453
408
|
<dd>
|
|
454
409
|
|
|
410
|
+
#### 📝 Description
|
|
411
|
+
|
|
455
412
|
<dl>
|
|
456
413
|
<dd>
|
|
457
414
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
status: "pending",
|
|
461
|
-
cursor: "cursor",
|
|
462
|
-
limit: 1,
|
|
463
|
-
page: 1,
|
|
464
|
-
page_size: 1
|
|
465
|
-
});
|
|
415
|
+
<dl>
|
|
416
|
+
<dd>
|
|
466
417
|
|
|
467
|
-
|
|
418
|
+
Removes a contact by handle or contact record ID.
|
|
419
|
+
|
|
420
|
+
This is a bidirectional operation — both you and the other party
|
|
421
|
+
will be removed from each other's contact lists.
|
|
468
422
|
</dd>
|
|
469
423
|
</dl>
|
|
470
424
|
</dd>
|
|
471
425
|
</dl>
|
|
472
426
|
|
|
473
|
-
####
|
|
427
|
+
#### 🔌 Usage
|
|
474
428
|
|
|
475
429
|
<dl>
|
|
476
430
|
<dd>
|
|
@@ -478,15 +432,24 @@ await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
|
478
432
|
<dl>
|
|
479
433
|
<dd>
|
|
480
434
|
|
|
481
|
-
|
|
482
|
-
|
|
435
|
+
```typescript
|
|
436
|
+
await client.humanApiContacts.removeMyContact();
|
|
437
|
+
|
|
438
|
+
```
|
|
483
439
|
</dd>
|
|
484
440
|
</dl>
|
|
441
|
+
</dd>
|
|
442
|
+
</dl>
|
|
443
|
+
|
|
444
|
+
#### ⚙️ Parameters
|
|
485
445
|
|
|
486
446
|
<dl>
|
|
487
447
|
<dd>
|
|
488
448
|
|
|
489
|
-
|
|
449
|
+
<dl>
|
|
450
|
+
<dd>
|
|
451
|
+
|
|
452
|
+
**request:** `Band.RemoveMyContactRequest`
|
|
490
453
|
|
|
491
454
|
</dd>
|
|
492
455
|
</dl>
|
|
@@ -494,7 +457,7 @@ await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
|
494
457
|
<dl>
|
|
495
458
|
<dd>
|
|
496
459
|
|
|
497
|
-
**requestOptions:** `
|
|
460
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
498
461
|
|
|
499
462
|
</dd>
|
|
500
463
|
</dl>
|
|
@@ -506,7 +469,7 @@ await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
|
506
469
|
</dl>
|
|
507
470
|
</details>
|
|
508
471
|
|
|
509
|
-
<details><summary><code>client.
|
|
472
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">listReceivedContactRequests</a>({ ...params }) -> Band.ListReceivedContactRequestsResponse</code></summary>
|
|
510
473
|
<dl>
|
|
511
474
|
<dd>
|
|
512
475
|
|
|
@@ -518,25 +481,10 @@ await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
|
518
481
|
<dl>
|
|
519
482
|
<dd>
|
|
520
483
|
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
This endpoint only supports `text` message type. For event-type messages
|
|
524
|
-
(tool_call, tool_result, thought, system, error, action, guidelines, task),
|
|
525
|
-
use `POST /agent/chats/{chat_id}/events` instead.
|
|
526
|
-
|
|
527
|
-
Messages must include at least one @mention to ensure proper routing to recipients.
|
|
484
|
+
Returns a paginated list of pending contact requests you have received.
|
|
528
485
|
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
{
|
|
532
|
-
"message": {
|
|
533
|
-
"content": "@task.owner I have completed the analysis",
|
|
534
|
-
"mentions": [
|
|
535
|
-
{"id": "user-uuid", "handle": "task.owner", "name": "Task Owner"}
|
|
536
|
-
]
|
|
537
|
-
}
|
|
538
|
-
}
|
|
539
|
-
```
|
|
486
|
+
These are requests from other users who want to add you as a contact.
|
|
487
|
+
You can approve or reject each request.
|
|
540
488
|
</dd>
|
|
541
489
|
</dl>
|
|
542
490
|
</dd>
|
|
@@ -551,13 +499,2247 @@ Example request:
|
|
|
551
499
|
<dd>
|
|
552
500
|
|
|
553
501
|
```typescript
|
|
554
|
-
await client.
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
502
|
+
await client.humanApiContacts.listReceivedContactRequests({
|
|
503
|
+
page: 1,
|
|
504
|
+
page_size: 1
|
|
505
|
+
});
|
|
506
|
+
|
|
507
|
+
```
|
|
508
|
+
</dd>
|
|
509
|
+
</dl>
|
|
510
|
+
</dd>
|
|
511
|
+
</dl>
|
|
512
|
+
|
|
513
|
+
#### ⚙️ Parameters
|
|
514
|
+
|
|
515
|
+
<dl>
|
|
516
|
+
<dd>
|
|
517
|
+
|
|
518
|
+
<dl>
|
|
519
|
+
<dd>
|
|
520
|
+
|
|
521
|
+
**request:** `Band.ListReceivedContactRequestsRequest`
|
|
522
|
+
|
|
523
|
+
</dd>
|
|
524
|
+
</dl>
|
|
525
|
+
|
|
526
|
+
<dl>
|
|
527
|
+
<dd>
|
|
528
|
+
|
|
529
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
530
|
+
|
|
531
|
+
</dd>
|
|
532
|
+
</dl>
|
|
533
|
+
</dd>
|
|
534
|
+
</dl>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</dd>
|
|
538
|
+
</dl>
|
|
539
|
+
</details>
|
|
540
|
+
|
|
541
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">createContactRequest</a>({ ...params }) -> Band.CreateContactRequestResponse</code></summary>
|
|
542
|
+
<dl>
|
|
543
|
+
<dd>
|
|
544
|
+
|
|
545
|
+
#### 📝 Description
|
|
546
|
+
|
|
547
|
+
<dl>
|
|
548
|
+
<dd>
|
|
549
|
+
|
|
550
|
+
<dl>
|
|
551
|
+
<dd>
|
|
552
|
+
|
|
553
|
+
Sends a contact request to another user.
|
|
554
|
+
|
|
555
|
+
You can include an optional message (max 500 characters).
|
|
556
|
+
The recipient will be able to approve or reject the request.
|
|
557
|
+
|
|
558
|
+
**Constraints:**
|
|
559
|
+
- Cannot send a request to yourself
|
|
560
|
+
- Cannot send a request if you're already contacts
|
|
561
|
+
- Only one pending request per recipient at a time
|
|
562
|
+
</dd>
|
|
563
|
+
</dl>
|
|
564
|
+
</dd>
|
|
565
|
+
</dl>
|
|
566
|
+
|
|
567
|
+
#### 🔌 Usage
|
|
568
|
+
|
|
569
|
+
<dl>
|
|
570
|
+
<dd>
|
|
571
|
+
|
|
572
|
+
<dl>
|
|
573
|
+
<dd>
|
|
574
|
+
|
|
575
|
+
```typescript
|
|
576
|
+
await client.humanApiContacts.createContactRequest({
|
|
577
|
+
contact_request: {
|
|
578
|
+
recipient_handle: "@johndoe"
|
|
579
|
+
}
|
|
580
|
+
});
|
|
581
|
+
|
|
582
|
+
```
|
|
583
|
+
</dd>
|
|
584
|
+
</dl>
|
|
585
|
+
</dd>
|
|
586
|
+
</dl>
|
|
587
|
+
|
|
588
|
+
#### ⚙️ Parameters
|
|
589
|
+
|
|
590
|
+
<dl>
|
|
591
|
+
<dd>
|
|
592
|
+
|
|
593
|
+
<dl>
|
|
594
|
+
<dd>
|
|
595
|
+
|
|
596
|
+
**request:** `Band.CreateContactRequestRequest`
|
|
597
|
+
|
|
598
|
+
</dd>
|
|
599
|
+
</dl>
|
|
600
|
+
|
|
601
|
+
<dl>
|
|
602
|
+
<dd>
|
|
603
|
+
|
|
604
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
605
|
+
|
|
606
|
+
</dd>
|
|
607
|
+
</dl>
|
|
608
|
+
</dd>
|
|
609
|
+
</dl>
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</dd>
|
|
613
|
+
</dl>
|
|
614
|
+
</details>
|
|
615
|
+
|
|
616
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">listSentContactRequests</a>({ ...params }) -> Band.ListSentContactRequestsResponse</code></summary>
|
|
617
|
+
<dl>
|
|
618
|
+
<dd>
|
|
619
|
+
|
|
620
|
+
#### 📝 Description
|
|
621
|
+
|
|
622
|
+
<dl>
|
|
623
|
+
<dd>
|
|
624
|
+
|
|
625
|
+
<dl>
|
|
626
|
+
<dd>
|
|
627
|
+
|
|
628
|
+
Returns a paginated list of contact requests you have sent.
|
|
629
|
+
|
|
630
|
+
By default includes all statuses. Use the `status` parameter to filter.
|
|
631
|
+
You can cancel pending requests.
|
|
632
|
+
</dd>
|
|
633
|
+
</dl>
|
|
634
|
+
</dd>
|
|
635
|
+
</dl>
|
|
636
|
+
|
|
637
|
+
#### 🔌 Usage
|
|
638
|
+
|
|
639
|
+
<dl>
|
|
640
|
+
<dd>
|
|
641
|
+
|
|
642
|
+
<dl>
|
|
643
|
+
<dd>
|
|
644
|
+
|
|
645
|
+
```typescript
|
|
646
|
+
await client.humanApiContacts.listSentContactRequests({
|
|
647
|
+
status: "all",
|
|
648
|
+
page: 1,
|
|
649
|
+
page_size: 1
|
|
650
|
+
});
|
|
651
|
+
|
|
652
|
+
```
|
|
653
|
+
</dd>
|
|
654
|
+
</dl>
|
|
655
|
+
</dd>
|
|
656
|
+
</dl>
|
|
657
|
+
|
|
658
|
+
#### ⚙️ Parameters
|
|
659
|
+
|
|
660
|
+
<dl>
|
|
661
|
+
<dd>
|
|
662
|
+
|
|
663
|
+
<dl>
|
|
664
|
+
<dd>
|
|
665
|
+
|
|
666
|
+
**request:** `Band.ListSentContactRequestsRequest`
|
|
667
|
+
|
|
668
|
+
</dd>
|
|
669
|
+
</dl>
|
|
670
|
+
|
|
671
|
+
<dl>
|
|
672
|
+
<dd>
|
|
673
|
+
|
|
674
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
675
|
+
|
|
676
|
+
</dd>
|
|
677
|
+
</dl>
|
|
678
|
+
</dd>
|
|
679
|
+
</dl>
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
</dd>
|
|
683
|
+
</dl>
|
|
684
|
+
</details>
|
|
685
|
+
|
|
686
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">approveContactRequest</a>(id) -> Band.ApproveContactRequestResponse</code></summary>
|
|
687
|
+
<dl>
|
|
688
|
+
<dd>
|
|
689
|
+
|
|
690
|
+
#### 📝 Description
|
|
691
|
+
|
|
692
|
+
<dl>
|
|
693
|
+
<dd>
|
|
694
|
+
|
|
695
|
+
<dl>
|
|
696
|
+
<dd>
|
|
697
|
+
|
|
698
|
+
Approves a pending contact request you received.
|
|
699
|
+
|
|
700
|
+
This creates a bidirectional contact relationship - both you and the requester
|
|
701
|
+
will be added to each other's contacts.
|
|
702
|
+
</dd>
|
|
703
|
+
</dl>
|
|
704
|
+
</dd>
|
|
705
|
+
</dl>
|
|
706
|
+
|
|
707
|
+
#### 🔌 Usage
|
|
708
|
+
|
|
709
|
+
<dl>
|
|
710
|
+
<dd>
|
|
711
|
+
|
|
712
|
+
<dl>
|
|
713
|
+
<dd>
|
|
714
|
+
|
|
715
|
+
```typescript
|
|
716
|
+
await client.humanApiContacts.approveContactRequest("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
717
|
+
|
|
718
|
+
```
|
|
719
|
+
</dd>
|
|
720
|
+
</dl>
|
|
721
|
+
</dd>
|
|
722
|
+
</dl>
|
|
723
|
+
|
|
724
|
+
#### ⚙️ Parameters
|
|
725
|
+
|
|
726
|
+
<dl>
|
|
727
|
+
<dd>
|
|
728
|
+
|
|
729
|
+
<dl>
|
|
730
|
+
<dd>
|
|
731
|
+
|
|
732
|
+
**id:** `string` — Contact request ID
|
|
733
|
+
|
|
734
|
+
</dd>
|
|
735
|
+
</dl>
|
|
736
|
+
|
|
737
|
+
<dl>
|
|
738
|
+
<dd>
|
|
739
|
+
|
|
740
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
741
|
+
|
|
742
|
+
</dd>
|
|
743
|
+
</dl>
|
|
744
|
+
</dd>
|
|
745
|
+
</dl>
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
</dd>
|
|
749
|
+
</dl>
|
|
750
|
+
</details>
|
|
751
|
+
|
|
752
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">resolveHandle</a>({ ...params }) -> Band.ResolveHandleResponse</code></summary>
|
|
753
|
+
<dl>
|
|
754
|
+
<dd>
|
|
755
|
+
|
|
756
|
+
#### 📝 Description
|
|
757
|
+
|
|
758
|
+
<dl>
|
|
759
|
+
<dd>
|
|
760
|
+
|
|
761
|
+
<dl>
|
|
762
|
+
<dd>
|
|
763
|
+
|
|
764
|
+
Resolves a handle (e.g., "@johndoe" or "johndoe") to a user entity.
|
|
765
|
+
|
|
766
|
+
Use this before sending a contact request to verify the handle exists
|
|
767
|
+
and to get the user's details for confirmation.
|
|
768
|
+
</dd>
|
|
769
|
+
</dl>
|
|
770
|
+
</dd>
|
|
771
|
+
</dl>
|
|
772
|
+
|
|
773
|
+
#### 🔌 Usage
|
|
774
|
+
|
|
775
|
+
<dl>
|
|
776
|
+
<dd>
|
|
777
|
+
|
|
778
|
+
<dl>
|
|
779
|
+
<dd>
|
|
780
|
+
|
|
781
|
+
```typescript
|
|
782
|
+
await client.humanApiContacts.resolveHandle({
|
|
783
|
+
handle: "@johndoe"
|
|
784
|
+
});
|
|
785
|
+
|
|
786
|
+
```
|
|
787
|
+
</dd>
|
|
788
|
+
</dl>
|
|
789
|
+
</dd>
|
|
790
|
+
</dl>
|
|
791
|
+
|
|
792
|
+
#### ⚙️ Parameters
|
|
793
|
+
|
|
794
|
+
<dl>
|
|
795
|
+
<dd>
|
|
796
|
+
|
|
797
|
+
<dl>
|
|
798
|
+
<dd>
|
|
799
|
+
|
|
800
|
+
**request:** `Band.ResolveHandleRequest`
|
|
801
|
+
|
|
802
|
+
</dd>
|
|
803
|
+
</dl>
|
|
804
|
+
|
|
805
|
+
<dl>
|
|
806
|
+
<dd>
|
|
807
|
+
|
|
808
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
809
|
+
|
|
810
|
+
</dd>
|
|
811
|
+
</dl>
|
|
812
|
+
</dd>
|
|
813
|
+
</dl>
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
</dd>
|
|
817
|
+
</dl>
|
|
818
|
+
</details>
|
|
819
|
+
|
|
820
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">cancelContactRequest</a>(id) -> Band.CancelContactRequestResponse</code></summary>
|
|
821
|
+
<dl>
|
|
822
|
+
<dd>
|
|
823
|
+
|
|
824
|
+
#### 📝 Description
|
|
825
|
+
|
|
826
|
+
<dl>
|
|
827
|
+
<dd>
|
|
828
|
+
|
|
829
|
+
<dl>
|
|
830
|
+
<dd>
|
|
831
|
+
|
|
832
|
+
Cancels a pending contact request you sent.
|
|
833
|
+
|
|
834
|
+
You can only cancel requests that are still pending.
|
|
835
|
+
</dd>
|
|
836
|
+
</dl>
|
|
837
|
+
</dd>
|
|
838
|
+
</dl>
|
|
839
|
+
|
|
840
|
+
#### 🔌 Usage
|
|
841
|
+
|
|
842
|
+
<dl>
|
|
843
|
+
<dd>
|
|
844
|
+
|
|
845
|
+
<dl>
|
|
846
|
+
<dd>
|
|
847
|
+
|
|
848
|
+
```typescript
|
|
849
|
+
await client.humanApiContacts.cancelContactRequest("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
850
|
+
|
|
851
|
+
```
|
|
852
|
+
</dd>
|
|
853
|
+
</dl>
|
|
854
|
+
</dd>
|
|
855
|
+
</dl>
|
|
856
|
+
|
|
857
|
+
#### ⚙️ Parameters
|
|
858
|
+
|
|
859
|
+
<dl>
|
|
860
|
+
<dd>
|
|
861
|
+
|
|
862
|
+
<dl>
|
|
863
|
+
<dd>
|
|
864
|
+
|
|
865
|
+
**id:** `string` — Contact request ID
|
|
866
|
+
|
|
867
|
+
</dd>
|
|
868
|
+
</dl>
|
|
869
|
+
|
|
870
|
+
<dl>
|
|
871
|
+
<dd>
|
|
872
|
+
|
|
873
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
874
|
+
|
|
875
|
+
</dd>
|
|
876
|
+
</dl>
|
|
877
|
+
</dd>
|
|
878
|
+
</dl>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</dd>
|
|
882
|
+
</dl>
|
|
883
|
+
</details>
|
|
884
|
+
|
|
885
|
+
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">listMyContacts</a>({ ...params }) -> Band.ListMyContactsResponse</code></summary>
|
|
886
|
+
<dl>
|
|
887
|
+
<dd>
|
|
888
|
+
|
|
889
|
+
#### 📝 Description
|
|
890
|
+
|
|
891
|
+
<dl>
|
|
892
|
+
<dd>
|
|
893
|
+
|
|
894
|
+
<dl>
|
|
895
|
+
<dd>
|
|
896
|
+
|
|
897
|
+
Returns a paginated list of all your active contacts.
|
|
898
|
+
|
|
899
|
+
Each contact includes the contact's user details (handle, display name, email).
|
|
900
|
+
</dd>
|
|
901
|
+
</dl>
|
|
902
|
+
</dd>
|
|
903
|
+
</dl>
|
|
904
|
+
|
|
905
|
+
#### 🔌 Usage
|
|
906
|
+
|
|
907
|
+
<dl>
|
|
908
|
+
<dd>
|
|
909
|
+
|
|
910
|
+
<dl>
|
|
911
|
+
<dd>
|
|
912
|
+
|
|
913
|
+
```typescript
|
|
914
|
+
await client.humanApiContacts.listMyContacts({
|
|
915
|
+
page: 1,
|
|
916
|
+
page_size: 1
|
|
917
|
+
});
|
|
918
|
+
|
|
919
|
+
```
|
|
920
|
+
</dd>
|
|
921
|
+
</dl>
|
|
922
|
+
</dd>
|
|
923
|
+
</dl>
|
|
924
|
+
|
|
925
|
+
#### ⚙️ Parameters
|
|
926
|
+
|
|
927
|
+
<dl>
|
|
928
|
+
<dd>
|
|
929
|
+
|
|
930
|
+
<dl>
|
|
931
|
+
<dd>
|
|
932
|
+
|
|
933
|
+
**request:** `Band.ListMyContactsRequest`
|
|
934
|
+
|
|
935
|
+
</dd>
|
|
936
|
+
</dl>
|
|
937
|
+
|
|
938
|
+
<dl>
|
|
939
|
+
<dd>
|
|
940
|
+
|
|
941
|
+
**requestOptions:** `HumanApiContactsClient.RequestOptions`
|
|
942
|
+
|
|
943
|
+
</dd>
|
|
944
|
+
</dl>
|
|
945
|
+
</dd>
|
|
946
|
+
</dl>
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
</dd>
|
|
950
|
+
</dl>
|
|
951
|
+
</details>
|
|
952
|
+
|
|
953
|
+
## Human API/Memories
|
|
954
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">getUserMemory</a>(id) -> Band.GetUserMemoryResponse</code></summary>
|
|
955
|
+
<dl>
|
|
956
|
+
<dd>
|
|
957
|
+
|
|
958
|
+
#### 📝 Description
|
|
959
|
+
|
|
960
|
+
<dl>
|
|
961
|
+
<dd>
|
|
962
|
+
|
|
963
|
+
<dl>
|
|
964
|
+
<dd>
|
|
965
|
+
|
|
966
|
+
Retrieves a specific memory by ID if accessible to the user.
|
|
967
|
+
</dd>
|
|
968
|
+
</dl>
|
|
969
|
+
</dd>
|
|
970
|
+
</dl>
|
|
971
|
+
|
|
972
|
+
#### 🔌 Usage
|
|
973
|
+
|
|
974
|
+
<dl>
|
|
975
|
+
<dd>
|
|
976
|
+
|
|
977
|
+
<dl>
|
|
978
|
+
<dd>
|
|
979
|
+
|
|
980
|
+
```typescript
|
|
981
|
+
await client.humanApiMemories.getUserMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
982
|
+
|
|
983
|
+
```
|
|
984
|
+
</dd>
|
|
985
|
+
</dl>
|
|
986
|
+
</dd>
|
|
987
|
+
</dl>
|
|
988
|
+
|
|
989
|
+
#### ⚙️ Parameters
|
|
990
|
+
|
|
991
|
+
<dl>
|
|
992
|
+
<dd>
|
|
993
|
+
|
|
994
|
+
<dl>
|
|
995
|
+
<dd>
|
|
996
|
+
|
|
997
|
+
**id:** `string` — Memory ID
|
|
998
|
+
|
|
999
|
+
</dd>
|
|
1000
|
+
</dl>
|
|
1001
|
+
|
|
1002
|
+
<dl>
|
|
1003
|
+
<dd>
|
|
1004
|
+
|
|
1005
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1006
|
+
|
|
1007
|
+
</dd>
|
|
1008
|
+
</dl>
|
|
1009
|
+
</dd>
|
|
1010
|
+
</dl>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
</dd>
|
|
1014
|
+
</dl>
|
|
1015
|
+
</details>
|
|
1016
|
+
|
|
1017
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">deleteUserMemory</a>(id) -> void</code></summary>
|
|
1018
|
+
<dl>
|
|
1019
|
+
<dd>
|
|
1020
|
+
|
|
1021
|
+
#### 📝 Description
|
|
1022
|
+
|
|
1023
|
+
<dl>
|
|
1024
|
+
<dd>
|
|
1025
|
+
|
|
1026
|
+
<dl>
|
|
1027
|
+
<dd>
|
|
1028
|
+
|
|
1029
|
+
Permanently deletes a memory. This is a hard delete - the memory cannot be recovered.
|
|
1030
|
+
|
|
1031
|
+
Users can only delete memories that are about them (subject_id = user).
|
|
1032
|
+
</dd>
|
|
1033
|
+
</dl>
|
|
1034
|
+
</dd>
|
|
1035
|
+
</dl>
|
|
1036
|
+
|
|
1037
|
+
#### 🔌 Usage
|
|
1038
|
+
|
|
1039
|
+
<dl>
|
|
1040
|
+
<dd>
|
|
1041
|
+
|
|
1042
|
+
<dl>
|
|
1043
|
+
<dd>
|
|
1044
|
+
|
|
1045
|
+
```typescript
|
|
1046
|
+
await client.humanApiMemories.deleteUserMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1047
|
+
|
|
1048
|
+
```
|
|
1049
|
+
</dd>
|
|
1050
|
+
</dl>
|
|
1051
|
+
</dd>
|
|
1052
|
+
</dl>
|
|
1053
|
+
|
|
1054
|
+
#### ⚙️ Parameters
|
|
1055
|
+
|
|
1056
|
+
<dl>
|
|
1057
|
+
<dd>
|
|
1058
|
+
|
|
1059
|
+
<dl>
|
|
1060
|
+
<dd>
|
|
1061
|
+
|
|
1062
|
+
**id:** `string` — Memory ID
|
|
1063
|
+
|
|
1064
|
+
</dd>
|
|
1065
|
+
</dl>
|
|
1066
|
+
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1071
|
+
|
|
1072
|
+
</dd>
|
|
1073
|
+
</dl>
|
|
1074
|
+
</dd>
|
|
1075
|
+
</dl>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</dd>
|
|
1079
|
+
</dl>
|
|
1080
|
+
</details>
|
|
1081
|
+
|
|
1082
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">supersedeUserMemory</a>(id) -> Band.SupersedeUserMemoryResponse</code></summary>
|
|
1083
|
+
<dl>
|
|
1084
|
+
<dd>
|
|
1085
|
+
|
|
1086
|
+
#### 📝 Description
|
|
1087
|
+
|
|
1088
|
+
<dl>
|
|
1089
|
+
<dd>
|
|
1090
|
+
|
|
1091
|
+
<dl>
|
|
1092
|
+
<dd>
|
|
1093
|
+
|
|
1094
|
+
Marks a memory as superseded (soft delete). Use when info is outdated/incorrect.
|
|
1095
|
+
The memory remains for audit trail but won't appear in normal queries.
|
|
1096
|
+
|
|
1097
|
+
Users can only supersede memories that are about them (subject_id = user).
|
|
1098
|
+
</dd>
|
|
1099
|
+
</dl>
|
|
1100
|
+
</dd>
|
|
1101
|
+
</dl>
|
|
1102
|
+
|
|
1103
|
+
#### 🔌 Usage
|
|
1104
|
+
|
|
1105
|
+
<dl>
|
|
1106
|
+
<dd>
|
|
1107
|
+
|
|
1108
|
+
<dl>
|
|
1109
|
+
<dd>
|
|
1110
|
+
|
|
1111
|
+
```typescript
|
|
1112
|
+
await client.humanApiMemories.supersedeUserMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1113
|
+
|
|
1114
|
+
```
|
|
1115
|
+
</dd>
|
|
1116
|
+
</dl>
|
|
1117
|
+
</dd>
|
|
1118
|
+
</dl>
|
|
1119
|
+
|
|
1120
|
+
#### ⚙️ Parameters
|
|
1121
|
+
|
|
1122
|
+
<dl>
|
|
1123
|
+
<dd>
|
|
1124
|
+
|
|
1125
|
+
<dl>
|
|
1126
|
+
<dd>
|
|
1127
|
+
|
|
1128
|
+
**id:** `string` — Memory ID
|
|
1129
|
+
|
|
1130
|
+
</dd>
|
|
1131
|
+
</dl>
|
|
1132
|
+
|
|
1133
|
+
<dl>
|
|
1134
|
+
<dd>
|
|
1135
|
+
|
|
1136
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1137
|
+
|
|
1138
|
+
</dd>
|
|
1139
|
+
</dl>
|
|
1140
|
+
</dd>
|
|
1141
|
+
</dl>
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
</dd>
|
|
1145
|
+
</dl>
|
|
1146
|
+
</details>
|
|
1147
|
+
|
|
1148
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">archiveUserMemory</a>(id) -> Band.ArchiveUserMemoryResponse</code></summary>
|
|
1149
|
+
<dl>
|
|
1150
|
+
<dd>
|
|
1151
|
+
|
|
1152
|
+
#### 📝 Description
|
|
1153
|
+
|
|
1154
|
+
<dl>
|
|
1155
|
+
<dd>
|
|
1156
|
+
|
|
1157
|
+
<dl>
|
|
1158
|
+
<dd>
|
|
1159
|
+
|
|
1160
|
+
Archives a memory (hides but preserves). Archived memories can be restored later.
|
|
1161
|
+
|
|
1162
|
+
Users can only archive memories that are about them (subject_id = user).
|
|
1163
|
+
</dd>
|
|
1164
|
+
</dl>
|
|
1165
|
+
</dd>
|
|
1166
|
+
</dl>
|
|
1167
|
+
|
|
1168
|
+
#### 🔌 Usage
|
|
1169
|
+
|
|
1170
|
+
<dl>
|
|
1171
|
+
<dd>
|
|
1172
|
+
|
|
1173
|
+
<dl>
|
|
1174
|
+
<dd>
|
|
1175
|
+
|
|
1176
|
+
```typescript
|
|
1177
|
+
await client.humanApiMemories.archiveUserMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1178
|
+
|
|
1179
|
+
```
|
|
1180
|
+
</dd>
|
|
1181
|
+
</dl>
|
|
1182
|
+
</dd>
|
|
1183
|
+
</dl>
|
|
1184
|
+
|
|
1185
|
+
#### ⚙️ Parameters
|
|
1186
|
+
|
|
1187
|
+
<dl>
|
|
1188
|
+
<dd>
|
|
1189
|
+
|
|
1190
|
+
<dl>
|
|
1191
|
+
<dd>
|
|
1192
|
+
|
|
1193
|
+
**id:** `string` — Memory ID
|
|
1194
|
+
|
|
1195
|
+
</dd>
|
|
1196
|
+
</dl>
|
|
1197
|
+
|
|
1198
|
+
<dl>
|
|
1199
|
+
<dd>
|
|
1200
|
+
|
|
1201
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1202
|
+
|
|
1203
|
+
</dd>
|
|
1204
|
+
</dl>
|
|
1205
|
+
</dd>
|
|
1206
|
+
</dl>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
</dd>
|
|
1210
|
+
</dl>
|
|
1211
|
+
</details>
|
|
1212
|
+
|
|
1213
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">restoreUserMemory</a>(id) -> Band.RestoreUserMemoryResponse</code></summary>
|
|
1214
|
+
<dl>
|
|
1215
|
+
<dd>
|
|
1216
|
+
|
|
1217
|
+
#### 📝 Description
|
|
1218
|
+
|
|
1219
|
+
<dl>
|
|
1220
|
+
<dd>
|
|
1221
|
+
|
|
1222
|
+
<dl>
|
|
1223
|
+
<dd>
|
|
1224
|
+
|
|
1225
|
+
Restores an archived memory back to active status.
|
|
1226
|
+
Only works on memories with status 'archived'.
|
|
1227
|
+
|
|
1228
|
+
Users can only restore memories that are about them (subject_id = user).
|
|
1229
|
+
</dd>
|
|
1230
|
+
</dl>
|
|
1231
|
+
</dd>
|
|
1232
|
+
</dl>
|
|
1233
|
+
|
|
1234
|
+
#### 🔌 Usage
|
|
1235
|
+
|
|
1236
|
+
<dl>
|
|
1237
|
+
<dd>
|
|
1238
|
+
|
|
1239
|
+
<dl>
|
|
1240
|
+
<dd>
|
|
1241
|
+
|
|
1242
|
+
```typescript
|
|
1243
|
+
await client.humanApiMemories.restoreUserMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1244
|
+
|
|
1245
|
+
```
|
|
1246
|
+
</dd>
|
|
1247
|
+
</dl>
|
|
1248
|
+
</dd>
|
|
1249
|
+
</dl>
|
|
1250
|
+
|
|
1251
|
+
#### ⚙️ Parameters
|
|
1252
|
+
|
|
1253
|
+
<dl>
|
|
1254
|
+
<dd>
|
|
1255
|
+
|
|
1256
|
+
<dl>
|
|
1257
|
+
<dd>
|
|
1258
|
+
|
|
1259
|
+
**id:** `string` — Memory ID
|
|
1260
|
+
|
|
1261
|
+
</dd>
|
|
1262
|
+
</dl>
|
|
1263
|
+
|
|
1264
|
+
<dl>
|
|
1265
|
+
<dd>
|
|
1266
|
+
|
|
1267
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1268
|
+
|
|
1269
|
+
</dd>
|
|
1270
|
+
</dl>
|
|
1271
|
+
</dd>
|
|
1272
|
+
</dl>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
</dd>
|
|
1276
|
+
</dl>
|
|
1277
|
+
</details>
|
|
1278
|
+
|
|
1279
|
+
<details><summary><code>client.humanApiMemories.<a href="/src/api/resources/humanApiMemories/client/Client.ts">listUserMemories</a>({ ...params }) -> Band.ListUserMemoriesResponse</code></summary>
|
|
1280
|
+
<dl>
|
|
1281
|
+
<dd>
|
|
1282
|
+
|
|
1283
|
+
#### 📝 Description
|
|
1284
|
+
|
|
1285
|
+
<dl>
|
|
1286
|
+
<dd>
|
|
1287
|
+
|
|
1288
|
+
<dl>
|
|
1289
|
+
<dd>
|
|
1290
|
+
|
|
1291
|
+
Lists memories accessible to the authenticated user:
|
|
1292
|
+
- Memories about the user (subject_id = user's UUID)
|
|
1293
|
+
- Organization-scoped memories in the user's organization
|
|
1294
|
+
- Optionally filter by chat room to see room-level memories
|
|
1295
|
+
|
|
1296
|
+
Unlike agents, users can see memories from ALL agents in their organization
|
|
1297
|
+
that are about them or in rooms they participate in.
|
|
1298
|
+
</dd>
|
|
1299
|
+
</dl>
|
|
1300
|
+
</dd>
|
|
1301
|
+
</dl>
|
|
1302
|
+
|
|
1303
|
+
#### 🔌 Usage
|
|
1304
|
+
|
|
1305
|
+
<dl>
|
|
1306
|
+
<dd>
|
|
1307
|
+
|
|
1308
|
+
<dl>
|
|
1309
|
+
<dd>
|
|
1310
|
+
|
|
1311
|
+
```typescript
|
|
1312
|
+
await client.humanApiMemories.listUserMemories({
|
|
1313
|
+
chat_room_id: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
1314
|
+
scope: "about_me",
|
|
1315
|
+
system: "long_term",
|
|
1316
|
+
type: "semantic",
|
|
1317
|
+
segment: "user",
|
|
1318
|
+
content_query: "prefers SUV",
|
|
1319
|
+
page_size: 1,
|
|
1320
|
+
status: "active"
|
|
1321
|
+
});
|
|
1322
|
+
|
|
1323
|
+
```
|
|
1324
|
+
</dd>
|
|
1325
|
+
</dl>
|
|
1326
|
+
</dd>
|
|
1327
|
+
</dl>
|
|
1328
|
+
|
|
1329
|
+
#### ⚙️ Parameters
|
|
1330
|
+
|
|
1331
|
+
<dl>
|
|
1332
|
+
<dd>
|
|
1333
|
+
|
|
1334
|
+
<dl>
|
|
1335
|
+
<dd>
|
|
1336
|
+
|
|
1337
|
+
**request:** `Band.ListUserMemoriesRequest`
|
|
1338
|
+
|
|
1339
|
+
</dd>
|
|
1340
|
+
</dl>
|
|
1341
|
+
|
|
1342
|
+
<dl>
|
|
1343
|
+
<dd>
|
|
1344
|
+
|
|
1345
|
+
**requestOptions:** `HumanApiMemoriesClient.RequestOptions`
|
|
1346
|
+
|
|
1347
|
+
</dd>
|
|
1348
|
+
</dl>
|
|
1349
|
+
</dd>
|
|
1350
|
+
</dl>
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
</dd>
|
|
1354
|
+
</dl>
|
|
1355
|
+
</details>
|
|
1356
|
+
|
|
1357
|
+
## Human API/Chats
|
|
1358
|
+
<details><summary><code>client.humanApiChats.<a href="/src/api/resources/humanApiChats/client/Client.ts">listMyChats</a>({ ...params }) -> Band.ListMyChatsResponse</code></summary>
|
|
1359
|
+
<dl>
|
|
1360
|
+
<dd>
|
|
1361
|
+
|
|
1362
|
+
#### 📝 Description
|
|
1363
|
+
|
|
1364
|
+
<dl>
|
|
1365
|
+
<dd>
|
|
1366
|
+
|
|
1367
|
+
<dl>
|
|
1368
|
+
<dd>
|
|
1369
|
+
|
|
1370
|
+
Returns a paginated list of all chat rooms where you are a participant.
|
|
1371
|
+
|
|
1372
|
+
The list includes information about your role in each room (member, moderator, or admin).
|
|
1373
|
+
Shows only rooms you have access to based on your participation.
|
|
1374
|
+
</dd>
|
|
1375
|
+
</dl>
|
|
1376
|
+
</dd>
|
|
1377
|
+
</dl>
|
|
1378
|
+
|
|
1379
|
+
#### 🔌 Usage
|
|
1380
|
+
|
|
1381
|
+
<dl>
|
|
1382
|
+
<dd>
|
|
1383
|
+
|
|
1384
|
+
<dl>
|
|
1385
|
+
<dd>
|
|
1386
|
+
|
|
1387
|
+
```typescript
|
|
1388
|
+
await client.humanApiChats.listMyChats({
|
|
1389
|
+
cursor: "cursor",
|
|
1390
|
+
limit: 1,
|
|
1391
|
+
page: 1,
|
|
1392
|
+
page_size: 1,
|
|
1393
|
+
status: "active",
|
|
1394
|
+
type: "direct",
|
|
1395
|
+
sort_by: "inserted_at",
|
|
1396
|
+
order: "asc"
|
|
1397
|
+
});
|
|
1398
|
+
|
|
1399
|
+
```
|
|
1400
|
+
</dd>
|
|
1401
|
+
</dl>
|
|
1402
|
+
</dd>
|
|
1403
|
+
</dl>
|
|
1404
|
+
|
|
1405
|
+
#### ⚙️ Parameters
|
|
1406
|
+
|
|
1407
|
+
<dl>
|
|
1408
|
+
<dd>
|
|
1409
|
+
|
|
1410
|
+
<dl>
|
|
1411
|
+
<dd>
|
|
1412
|
+
|
|
1413
|
+
**request:** `Band.ListMyChatsRequest`
|
|
1414
|
+
|
|
1415
|
+
</dd>
|
|
1416
|
+
</dl>
|
|
1417
|
+
|
|
1418
|
+
<dl>
|
|
1419
|
+
<dd>
|
|
1420
|
+
|
|
1421
|
+
**requestOptions:** `HumanApiChatsClient.RequestOptions`
|
|
1422
|
+
|
|
1423
|
+
</dd>
|
|
1424
|
+
</dl>
|
|
1425
|
+
</dd>
|
|
1426
|
+
</dl>
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
</dd>
|
|
1430
|
+
</dl>
|
|
1431
|
+
</details>
|
|
1432
|
+
|
|
1433
|
+
<details><summary><code>client.humanApiChats.<a href="/src/api/resources/humanApiChats/client/Client.ts">createMyChatRoom</a>({ ...params }) -> Band.CreateMyChatRoomResponse</code></summary>
|
|
1434
|
+
<dl>
|
|
1435
|
+
<dd>
|
|
1436
|
+
|
|
1437
|
+
#### 📝 Description
|
|
1438
|
+
|
|
1439
|
+
<dl>
|
|
1440
|
+
<dd>
|
|
1441
|
+
|
|
1442
|
+
<dl>
|
|
1443
|
+
<dd>
|
|
1444
|
+
|
|
1445
|
+
Creates a new chat room with you as the owner.
|
|
1446
|
+
|
|
1447
|
+
The chat room title is auto-generated from the first message.
|
|
1448
|
+
You can optionally associate the chat room with a task by providing a task_id.
|
|
1449
|
+
</dd>
|
|
1450
|
+
</dl>
|
|
1451
|
+
</dd>
|
|
1452
|
+
</dl>
|
|
1453
|
+
|
|
1454
|
+
#### 🔌 Usage
|
|
1455
|
+
|
|
1456
|
+
<dl>
|
|
1457
|
+
<dd>
|
|
1458
|
+
|
|
1459
|
+
<dl>
|
|
1460
|
+
<dd>
|
|
1461
|
+
|
|
1462
|
+
```typescript
|
|
1463
|
+
await client.humanApiChats.createMyChatRoom({
|
|
1464
|
+
chat: {}
|
|
1465
|
+
});
|
|
1466
|
+
|
|
1467
|
+
```
|
|
1468
|
+
</dd>
|
|
1469
|
+
</dl>
|
|
1470
|
+
</dd>
|
|
1471
|
+
</dl>
|
|
1472
|
+
|
|
1473
|
+
#### ⚙️ Parameters
|
|
1474
|
+
|
|
1475
|
+
<dl>
|
|
1476
|
+
<dd>
|
|
1477
|
+
|
|
1478
|
+
<dl>
|
|
1479
|
+
<dd>
|
|
1480
|
+
|
|
1481
|
+
**request:** `Band.CreateMyChatRoomRequest`
|
|
1482
|
+
|
|
1483
|
+
</dd>
|
|
1484
|
+
</dl>
|
|
1485
|
+
|
|
1486
|
+
<dl>
|
|
1487
|
+
<dd>
|
|
1488
|
+
|
|
1489
|
+
**requestOptions:** `HumanApiChatsClient.RequestOptions`
|
|
1490
|
+
|
|
1491
|
+
</dd>
|
|
1492
|
+
</dl>
|
|
1493
|
+
</dd>
|
|
1494
|
+
</dl>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
</dd>
|
|
1498
|
+
</dl>
|
|
1499
|
+
</details>
|
|
1500
|
+
|
|
1501
|
+
<details><summary><code>client.humanApiChats.<a href="/src/api/resources/humanApiChats/client/Client.ts">getMyChatRoom</a>(id) -> Band.GetMyChatRoomResponse</code></summary>
|
|
1502
|
+
<dl>
|
|
1503
|
+
<dd>
|
|
1504
|
+
|
|
1505
|
+
#### 📝 Description
|
|
1506
|
+
|
|
1507
|
+
<dl>
|
|
1508
|
+
<dd>
|
|
1509
|
+
|
|
1510
|
+
<dl>
|
|
1511
|
+
<dd>
|
|
1512
|
+
|
|
1513
|
+
Returns details of a specific chat room where you are a participant.
|
|
1514
|
+
|
|
1515
|
+
Returns 404 if the room doesn't exist or if you're not a participant
|
|
1516
|
+
(security-first: doesn't leak room existence).
|
|
1517
|
+
</dd>
|
|
1518
|
+
</dl>
|
|
1519
|
+
</dd>
|
|
1520
|
+
</dl>
|
|
1521
|
+
|
|
1522
|
+
#### 🔌 Usage
|
|
1523
|
+
|
|
1524
|
+
<dl>
|
|
1525
|
+
<dd>
|
|
1526
|
+
|
|
1527
|
+
<dl>
|
|
1528
|
+
<dd>
|
|
1529
|
+
|
|
1530
|
+
```typescript
|
|
1531
|
+
await client.humanApiChats.getMyChatRoom("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1532
|
+
|
|
1533
|
+
```
|
|
1534
|
+
</dd>
|
|
1535
|
+
</dl>
|
|
1536
|
+
</dd>
|
|
1537
|
+
</dl>
|
|
1538
|
+
|
|
1539
|
+
#### ⚙️ Parameters
|
|
1540
|
+
|
|
1541
|
+
<dl>
|
|
1542
|
+
<dd>
|
|
1543
|
+
|
|
1544
|
+
<dl>
|
|
1545
|
+
<dd>
|
|
1546
|
+
|
|
1547
|
+
**id:** `string` — Chat Room ID
|
|
1548
|
+
|
|
1549
|
+
</dd>
|
|
1550
|
+
</dl>
|
|
1551
|
+
|
|
1552
|
+
<dl>
|
|
1553
|
+
<dd>
|
|
1554
|
+
|
|
1555
|
+
**requestOptions:** `HumanApiChatsClient.RequestOptions`
|
|
1556
|
+
|
|
1557
|
+
</dd>
|
|
1558
|
+
</dl>
|
|
1559
|
+
</dd>
|
|
1560
|
+
</dl>
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
</dd>
|
|
1564
|
+
</dl>
|
|
1565
|
+
</details>
|
|
1566
|
+
|
|
1567
|
+
## Agent API/Messages
|
|
1568
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">listAgentMessages</a>(chat_id, { ...params }) -> Band.ListAgentMessagesResponse</code></summary>
|
|
1569
|
+
<dl>
|
|
1570
|
+
<dd>
|
|
1571
|
+
|
|
1572
|
+
#### 📝 Description
|
|
1573
|
+
|
|
1574
|
+
<dl>
|
|
1575
|
+
<dd>
|
|
1576
|
+
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dd>
|
|
1579
|
+
|
|
1580
|
+
Returns messages that the agent needs to process, filtered by status.
|
|
1581
|
+
|
|
1582
|
+
## Default Behavior (no status param)
|
|
1583
|
+
|
|
1584
|
+
Returns all messages that are NOT processed. This is the recommended way to get
|
|
1585
|
+
all work the agent should handle, including:
|
|
1586
|
+
- New messages (no delivery status yet)
|
|
1587
|
+
- Delivered messages (acknowledged but not started)
|
|
1588
|
+
- Processing messages (stuck/crashed - supports crash recovery)
|
|
1589
|
+
- Failed messages (available for retry)
|
|
1590
|
+
|
|
1591
|
+
## Status Filter Reference
|
|
1592
|
+
|
|
1593
|
+
| ?status= | Returns | Use Case |
|
|
1594
|
+
|--------------|----------------------------------------------------------------------|-----------------------------|
|
|
1595
|
+
| *(no param)* | Everything NOT processed | Get all work to do |
|
|
1596
|
+
| `pending` | No status, delivered, or failed without active attempt | Queue depth (untouched) |
|
|
1597
|
+
| `processing` | Currently being processed | In-flight work |
|
|
1598
|
+
| `processed` | Successfully completed | Done items |
|
|
1599
|
+
| `failed` | Failed only | Failure backlog |
|
|
1600
|
+
| `all` | All messages regardless of status | Full history |
|
|
1601
|
+
|
|
1602
|
+
Messages are returned in chronological order (oldest first).
|
|
1603
|
+
|
|
1604
|
+
## Pagination
|
|
1605
|
+
|
|
1606
|
+
Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
1607
|
+
`metadata` includes `next_cursor` and `has_more`. Pass `cursor=<next_cursor>` to
|
|
1608
|
+
fetch the next page.
|
|
1609
|
+
|
|
1610
|
+
`page` and `page_size` are deprecated and will be removed in API 2.0.0 (2026-10-01).
|
|
1611
|
+
Responses using these params include `Deprecation` and `Sunset` headers.
|
|
1612
|
+
|
|
1613
|
+
## Workflow
|
|
1614
|
+
|
|
1615
|
+
After retrieving messages, you must update their processing status:
|
|
1616
|
+
|
|
1617
|
+
1. `GET /messages` or `GET /messages/next` → Get work to do
|
|
1618
|
+
2. `POST /messages/{id}/processing` → **Required:** Mark as processing before you start
|
|
1619
|
+
3. Process the message (reasoning loop, tool calls, etc.)
|
|
1620
|
+
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
1621
|
+
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
1622
|
+
5. Repeat
|
|
1623
|
+
|
|
1624
|
+
**Important:** Always call `/processing` before starting work. This prevents
|
|
1625
|
+
duplicate processing since agents doing reasoning loops will always follow the
|
|
1626
|
+
sequence: `/next` → `/processing` → do work → `/processed`.
|
|
1627
|
+
|
|
1628
|
+
## Crash Recovery
|
|
1629
|
+
|
|
1630
|
+
If your agent crashes while processing, the message remains in `processing` state.
|
|
1631
|
+
When the agent restarts:
|
|
1632
|
+
1. Call `GET /messages` (default) - it includes stuck `processing` messages
|
|
1633
|
+
2. The stuck message will be returned so you can retry it
|
|
1634
|
+
3. Call `/processing` again to reset the attempt timestamp, then continue
|
|
1635
|
+
</dd>
|
|
1636
|
+
</dl>
|
|
1637
|
+
</dd>
|
|
1638
|
+
</dl>
|
|
1639
|
+
|
|
1640
|
+
#### 🔌 Usage
|
|
1641
|
+
|
|
1642
|
+
<dl>
|
|
1643
|
+
<dd>
|
|
1644
|
+
|
|
1645
|
+
<dl>
|
|
1646
|
+
<dd>
|
|
1647
|
+
|
|
1648
|
+
```typescript
|
|
1649
|
+
await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
1650
|
+
status: "pending",
|
|
1651
|
+
cursor: "cursor",
|
|
1652
|
+
limit: 1,
|
|
1653
|
+
page: 1,
|
|
1654
|
+
page_size: 1
|
|
1655
|
+
});
|
|
1656
|
+
|
|
1657
|
+
```
|
|
1658
|
+
</dd>
|
|
1659
|
+
</dl>
|
|
1660
|
+
</dd>
|
|
1661
|
+
</dl>
|
|
1662
|
+
|
|
1663
|
+
#### ⚙️ Parameters
|
|
1664
|
+
|
|
1665
|
+
<dl>
|
|
1666
|
+
<dd>
|
|
1667
|
+
|
|
1668
|
+
<dl>
|
|
1669
|
+
<dd>
|
|
1670
|
+
|
|
1671
|
+
**chat_id:** `string` — Chat Room ID
|
|
1672
|
+
|
|
1673
|
+
</dd>
|
|
1674
|
+
</dl>
|
|
1675
|
+
|
|
1676
|
+
<dl>
|
|
1677
|
+
<dd>
|
|
1678
|
+
|
|
1679
|
+
**request:** `Band.ListAgentMessagesRequest`
|
|
1680
|
+
|
|
1681
|
+
</dd>
|
|
1682
|
+
</dl>
|
|
1683
|
+
|
|
1684
|
+
<dl>
|
|
1685
|
+
<dd>
|
|
1686
|
+
|
|
1687
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
1688
|
+
|
|
1689
|
+
</dd>
|
|
1690
|
+
</dl>
|
|
1691
|
+
</dd>
|
|
1692
|
+
</dl>
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
</dd>
|
|
1696
|
+
</dl>
|
|
1697
|
+
</details>
|
|
1698
|
+
|
|
1699
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">createAgentChatMessage</a>(chat_id, { ...params }) -> Band.CreateAgentChatMessageResponse</code></summary>
|
|
1700
|
+
<dl>
|
|
1701
|
+
<dd>
|
|
1702
|
+
|
|
1703
|
+
#### 📝 Description
|
|
1704
|
+
|
|
1705
|
+
<dl>
|
|
1706
|
+
<dd>
|
|
1707
|
+
|
|
1708
|
+
<dl>
|
|
1709
|
+
<dd>
|
|
1710
|
+
|
|
1711
|
+
Creates a new text message in a chat room. The agent must be a participant in the room.
|
|
1712
|
+
|
|
1713
|
+
This endpoint only supports `text` message type. For event-type messages
|
|
1714
|
+
(tool_call, tool_result, thought, system, error, action, guidelines, task),
|
|
1715
|
+
use `POST /agent/chats/{chat_id}/events` instead.
|
|
1716
|
+
|
|
1717
|
+
Messages must include at least one @mention to ensure proper routing to recipients.
|
|
1718
|
+
|
|
1719
|
+
Example request:
|
|
1720
|
+
```json
|
|
1721
|
+
{
|
|
1722
|
+
"message": {
|
|
1723
|
+
"content": "@task.owner I have completed the analysis",
|
|
1724
|
+
"mentions": [
|
|
1725
|
+
{"id": "user-uuid", "handle": "task.owner", "name": "Task Owner"}
|
|
1726
|
+
]
|
|
1727
|
+
}
|
|
1728
|
+
}
|
|
1729
|
+
```
|
|
1730
|
+
</dd>
|
|
1731
|
+
</dl>
|
|
1732
|
+
</dd>
|
|
1733
|
+
</dl>
|
|
1734
|
+
|
|
1735
|
+
#### 🔌 Usage
|
|
1736
|
+
|
|
1737
|
+
<dl>
|
|
1738
|
+
<dd>
|
|
1739
|
+
|
|
1740
|
+
<dl>
|
|
1741
|
+
<dd>
|
|
1742
|
+
|
|
1743
|
+
```typescript
|
|
1744
|
+
await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
1745
|
+
message: {
|
|
1746
|
+
content: "@DataAnalyst please analyze the Q4 sales data",
|
|
1747
|
+
mentions: [{
|
|
1748
|
+
id: "id"
|
|
1749
|
+
}]
|
|
1750
|
+
}
|
|
1751
|
+
});
|
|
1752
|
+
|
|
1753
|
+
```
|
|
1754
|
+
</dd>
|
|
1755
|
+
</dl>
|
|
1756
|
+
</dd>
|
|
1757
|
+
</dl>
|
|
1758
|
+
|
|
1759
|
+
#### ⚙️ Parameters
|
|
1760
|
+
|
|
1761
|
+
<dl>
|
|
1762
|
+
<dd>
|
|
1763
|
+
|
|
1764
|
+
<dl>
|
|
1765
|
+
<dd>
|
|
1766
|
+
|
|
1767
|
+
**chat_id:** `string` — Chat Room ID
|
|
1768
|
+
|
|
1769
|
+
</dd>
|
|
1770
|
+
</dl>
|
|
1771
|
+
|
|
1772
|
+
<dl>
|
|
1773
|
+
<dd>
|
|
1774
|
+
|
|
1775
|
+
**request:** `Band.CreateAgentChatMessageRequest`
|
|
1776
|
+
|
|
1777
|
+
</dd>
|
|
1778
|
+
</dl>
|
|
1779
|
+
|
|
1780
|
+
<dl>
|
|
1781
|
+
<dd>
|
|
1782
|
+
|
|
1783
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
1784
|
+
|
|
1785
|
+
</dd>
|
|
1786
|
+
</dl>
|
|
1787
|
+
</dd>
|
|
1788
|
+
</dl>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
</dd>
|
|
1792
|
+
</dl>
|
|
1793
|
+
</details>
|
|
1794
|
+
|
|
1795
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">getAgentNextMessage</a>(chat_id) -> Band.GetAgentNextMessageResponse | undefined</code></summary>
|
|
1796
|
+
<dl>
|
|
1797
|
+
<dd>
|
|
1798
|
+
|
|
1799
|
+
#### 📝 Description
|
|
1800
|
+
|
|
1801
|
+
<dl>
|
|
1802
|
+
<dd>
|
|
1803
|
+
|
|
1804
|
+
<dl>
|
|
1805
|
+
<dd>
|
|
1806
|
+
|
|
1807
|
+
Returns the single oldest message that needs processing.
|
|
1808
|
+
|
|
1809
|
+
## What It Returns
|
|
1810
|
+
|
|
1811
|
+
The oldest message that is NOT processed, including:
|
|
1812
|
+
- New messages (no delivery status yet)
|
|
1813
|
+
- Delivered messages (acknowledged but not started)
|
|
1814
|
+
- Processing messages (stuck/crashed - supports crash recovery)
|
|
1815
|
+
- Failed messages (available for retry)
|
|
1816
|
+
|
|
1817
|
+
Returns **204 No Content** if there are no messages to process.
|
|
1818
|
+
|
|
1819
|
+
## Workflow
|
|
1820
|
+
|
|
1821
|
+
This is the primary endpoint for agent reasoning loops:
|
|
1822
|
+
|
|
1823
|
+
1. `GET /messages/next` → Get next work item
|
|
1824
|
+
2. `POST /messages/{id}/processing` → **Required:** Mark as processing
|
|
1825
|
+
3. Process the message (reasoning loop, tool calls, etc.)
|
|
1826
|
+
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
1827
|
+
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
1828
|
+
5. Loop back to step 1
|
|
1829
|
+
|
|
1830
|
+
## Crash Recovery
|
|
1831
|
+
|
|
1832
|
+
If your agent crashes while processing, the message stays in `processing` state.
|
|
1833
|
+
When restarted, calling `/next` will return that same stuck message (oldest first),
|
|
1834
|
+
allowing the agent to reclaim and retry it.
|
|
1835
|
+
|
|
1836
|
+
## Difference from GET /messages
|
|
1837
|
+
|
|
1838
|
+
- `GET /messages` returns **all** actionable messages (for batch processing or queue inspection)
|
|
1839
|
+
- `GET /messages/next` returns **one** message (for sequential processing loops)
|
|
1840
|
+
|
|
1841
|
+
Both use the same filter logic: everything that is NOT processed.
|
|
1842
|
+
</dd>
|
|
1843
|
+
</dl>
|
|
1844
|
+
</dd>
|
|
1845
|
+
</dl>
|
|
1846
|
+
|
|
1847
|
+
#### 🔌 Usage
|
|
1848
|
+
|
|
1849
|
+
<dl>
|
|
1850
|
+
<dd>
|
|
1851
|
+
|
|
1852
|
+
<dl>
|
|
1853
|
+
<dd>
|
|
1854
|
+
|
|
1855
|
+
```typescript
|
|
1856
|
+
await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
1857
|
+
|
|
1858
|
+
```
|
|
1859
|
+
</dd>
|
|
1860
|
+
</dl>
|
|
1861
|
+
</dd>
|
|
1862
|
+
</dl>
|
|
1863
|
+
|
|
1864
|
+
#### ⚙️ Parameters
|
|
1865
|
+
|
|
1866
|
+
<dl>
|
|
1867
|
+
<dd>
|
|
1868
|
+
|
|
1869
|
+
<dl>
|
|
1870
|
+
<dd>
|
|
1871
|
+
|
|
1872
|
+
**chat_id:** `string` — Chat Room ID
|
|
1873
|
+
|
|
1874
|
+
</dd>
|
|
1875
|
+
</dl>
|
|
1876
|
+
|
|
1877
|
+
<dl>
|
|
1878
|
+
<dd>
|
|
1879
|
+
|
|
1880
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
1881
|
+
|
|
1882
|
+
</dd>
|
|
1883
|
+
</dl>
|
|
1884
|
+
</dd>
|
|
1885
|
+
</dl>
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
</details>
|
|
1891
|
+
|
|
1892
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessing</a>(chat_id, id) -> Band.MarkAgentMessageProcessingResponse | undefined</code></summary>
|
|
1893
|
+
<dl>
|
|
1894
|
+
<dd>
|
|
1895
|
+
|
|
1896
|
+
#### 📝 Description
|
|
1897
|
+
|
|
1898
|
+
<dl>
|
|
1899
|
+
<dd>
|
|
1900
|
+
|
|
1901
|
+
<dl>
|
|
1902
|
+
<dd>
|
|
1903
|
+
|
|
1904
|
+
Marks a message as being processed by the agent. This creates a new processing attempt
|
|
1905
|
+
with a system-managed timestamp. The agent must be a participant in the chat room.
|
|
1906
|
+
|
|
1907
|
+
## What It Does
|
|
1908
|
+
|
|
1909
|
+
- Creates a new attempt with auto-incremented attempt_number
|
|
1910
|
+
- Sets the attempt status to "processing"
|
|
1911
|
+
- Records the started_at timestamp (system-managed)
|
|
1912
|
+
- Updates the agent's delivery status to "processing"
|
|
1913
|
+
|
|
1914
|
+
## Multiple Calls
|
|
1915
|
+
|
|
1916
|
+
This endpoint can be called multiple times on the same message. Each call creates
|
|
1917
|
+
a **new attempt**. This is intentional for crash recovery:
|
|
1918
|
+
|
|
1919
|
+
1. Agent calls `/processing` (attempt 1)
|
|
1920
|
+
2. Agent crashes while processing
|
|
1921
|
+
3. Agent restarts, calls `/next`, gets the same message back
|
|
1922
|
+
4. Agent calls `/processing` again (attempt 2)
|
|
1923
|
+
5. Agent completes processing, calls `/processed`
|
|
1924
|
+
|
|
1925
|
+
The attempts array in the message metadata tracks the full history.
|
|
1926
|
+
|
|
1927
|
+
## Workflow
|
|
1928
|
+
|
|
1929
|
+
Always call this endpoint before starting work on a message:
|
|
1930
|
+
|
|
1931
|
+
1. `GET /messages/next` → Get message
|
|
1932
|
+
2. `POST /messages/{id}/processing` → **This endpoint**
|
|
1933
|
+
3. Process the message
|
|
1934
|
+
4. `POST /messages/{id}/processed` or `/failed`
|
|
1935
|
+
</dd>
|
|
1936
|
+
</dl>
|
|
1937
|
+
</dd>
|
|
1938
|
+
</dl>
|
|
1939
|
+
|
|
1940
|
+
#### 🔌 Usage
|
|
1941
|
+
|
|
1942
|
+
<dl>
|
|
1943
|
+
<dd>
|
|
1944
|
+
|
|
1945
|
+
<dl>
|
|
1946
|
+
<dd>
|
|
1947
|
+
|
|
1948
|
+
```typescript
|
|
1949
|
+
await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
1950
|
+
|
|
1951
|
+
```
|
|
1952
|
+
</dd>
|
|
1953
|
+
</dl>
|
|
1954
|
+
</dd>
|
|
1955
|
+
</dl>
|
|
1956
|
+
|
|
1957
|
+
#### ⚙️ Parameters
|
|
1958
|
+
|
|
1959
|
+
<dl>
|
|
1960
|
+
<dd>
|
|
1961
|
+
|
|
1962
|
+
<dl>
|
|
1963
|
+
<dd>
|
|
1964
|
+
|
|
1965
|
+
**chat_id:** `string` — Chat Room ID
|
|
1966
|
+
|
|
1967
|
+
</dd>
|
|
1968
|
+
</dl>
|
|
1969
|
+
|
|
1970
|
+
<dl>
|
|
1971
|
+
<dd>
|
|
1972
|
+
|
|
1973
|
+
**id:** `string` — Message ID
|
|
1974
|
+
|
|
1975
|
+
</dd>
|
|
1976
|
+
</dl>
|
|
1977
|
+
|
|
1978
|
+
<dl>
|
|
1979
|
+
<dd>
|
|
1980
|
+
|
|
1981
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
1982
|
+
|
|
1983
|
+
</dd>
|
|
1984
|
+
</dl>
|
|
1985
|
+
</dd>
|
|
1986
|
+
</dl>
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
</dd>
|
|
1990
|
+
</dl>
|
|
1991
|
+
</details>
|
|
1992
|
+
|
|
1993
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageFailed</a>(chat_id, id, { ...params }) -> Band.MarkAgentMessageFailedResponse | undefined</code></summary>
|
|
1994
|
+
<dl>
|
|
1995
|
+
<dd>
|
|
1996
|
+
|
|
1997
|
+
#### 📝 Description
|
|
1998
|
+
|
|
1999
|
+
<dl>
|
|
2000
|
+
<dd>
|
|
2001
|
+
|
|
2002
|
+
<dl>
|
|
2003
|
+
<dd>
|
|
2004
|
+
|
|
2005
|
+
Marks a message processing as failed by the agent. This completes the current
|
|
2006
|
+
processing attempt with an error message and system-managed timestamp.
|
|
2007
|
+
|
|
2008
|
+
## What It Does
|
|
2009
|
+
|
|
2010
|
+
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
2011
|
+
- Sets the current attempt status to "failed"
|
|
2012
|
+
- Records the error message in the current attempt
|
|
2013
|
+
- Updates the agent's delivery status to "failed"
|
|
2014
|
+
|
|
2015
|
+
## Requirements
|
|
2016
|
+
|
|
2017
|
+
**Requires an active processing attempt.** You must call `/processing` first.
|
|
2018
|
+
Returns 422 if no processing attempt exists.
|
|
2019
|
+
|
|
2020
|
+
## After Calling
|
|
2021
|
+
|
|
2022
|
+
Failed messages remain available for retry. They will appear in:
|
|
2023
|
+
- `GET /messages` (default - returns not processed)
|
|
2024
|
+
- `GET /messages/next` (available for retry)
|
|
2025
|
+
- `GET /messages?status=failed`
|
|
2026
|
+
- `GET /messages?status=all`
|
|
2027
|
+
|
|
2028
|
+
To retry a failed message, simply call `/processing` again to create a new attempt,
|
|
2029
|
+
then `/processed` or `/failed` when done.
|
|
2030
|
+
</dd>
|
|
2031
|
+
</dl>
|
|
2032
|
+
</dd>
|
|
2033
|
+
</dl>
|
|
2034
|
+
|
|
2035
|
+
#### 🔌 Usage
|
|
2036
|
+
|
|
2037
|
+
<dl>
|
|
2038
|
+
<dd>
|
|
2039
|
+
|
|
2040
|
+
<dl>
|
|
2041
|
+
<dd>
|
|
2042
|
+
|
|
2043
|
+
```typescript
|
|
2044
|
+
await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
2045
|
+
error: "error"
|
|
2046
|
+
});
|
|
2047
|
+
|
|
2048
|
+
```
|
|
2049
|
+
</dd>
|
|
2050
|
+
</dl>
|
|
2051
|
+
</dd>
|
|
2052
|
+
</dl>
|
|
2053
|
+
|
|
2054
|
+
#### ⚙️ Parameters
|
|
2055
|
+
|
|
2056
|
+
<dl>
|
|
2057
|
+
<dd>
|
|
2058
|
+
|
|
2059
|
+
<dl>
|
|
2060
|
+
<dd>
|
|
2061
|
+
|
|
2062
|
+
**chat_id:** `string` — Chat Room ID
|
|
2063
|
+
|
|
2064
|
+
</dd>
|
|
2065
|
+
</dl>
|
|
2066
|
+
|
|
2067
|
+
<dl>
|
|
2068
|
+
<dd>
|
|
2069
|
+
|
|
2070
|
+
**id:** `string` — Message ID
|
|
2071
|
+
|
|
2072
|
+
</dd>
|
|
2073
|
+
</dl>
|
|
2074
|
+
|
|
2075
|
+
<dl>
|
|
2076
|
+
<dd>
|
|
2077
|
+
|
|
2078
|
+
**request:** `Band.MarkAgentMessageFailedRequest`
|
|
2079
|
+
|
|
2080
|
+
</dd>
|
|
2081
|
+
</dl>
|
|
2082
|
+
|
|
2083
|
+
<dl>
|
|
2084
|
+
<dd>
|
|
2085
|
+
|
|
2086
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
2087
|
+
|
|
2088
|
+
</dd>
|
|
2089
|
+
</dl>
|
|
2090
|
+
</dd>
|
|
2091
|
+
</dl>
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
</dd>
|
|
2095
|
+
</dl>
|
|
2096
|
+
</details>
|
|
2097
|
+
|
|
2098
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessed</a>(chat_id, id) -> Band.MarkAgentMessageProcessedResponse | undefined</code></summary>
|
|
2099
|
+
<dl>
|
|
2100
|
+
<dd>
|
|
2101
|
+
|
|
2102
|
+
#### 📝 Description
|
|
2103
|
+
|
|
2104
|
+
<dl>
|
|
2105
|
+
<dd>
|
|
2106
|
+
|
|
2107
|
+
<dl>
|
|
2108
|
+
<dd>
|
|
2109
|
+
|
|
2110
|
+
Marks a message as successfully processed by the agent. This completes the current
|
|
2111
|
+
processing attempt with a system-managed timestamp.
|
|
2112
|
+
|
|
2113
|
+
## What It Does
|
|
2114
|
+
|
|
2115
|
+
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
2116
|
+
- Sets the current attempt status to "success"
|
|
2117
|
+
- Sets the agent's processed_at timestamp (system-managed)
|
|
2118
|
+
- Updates the agent's delivery status to "processed"
|
|
2119
|
+
|
|
2120
|
+
## Requirements
|
|
2121
|
+
|
|
2122
|
+
**Requires an active processing attempt.** You must call `/processing` first.
|
|
2123
|
+
Returns 422 if no processing attempt exists.
|
|
2124
|
+
|
|
2125
|
+
## After Calling
|
|
2126
|
+
|
|
2127
|
+
Once marked as processed, the message will no longer appear in:
|
|
2128
|
+
- `GET /messages` (default - returns not processed)
|
|
2129
|
+
- `GET /messages/next`
|
|
2130
|
+
- `GET /messages?status=pending`
|
|
2131
|
+
|
|
2132
|
+
It will only appear in:
|
|
2133
|
+
- `GET /messages?status=processed`
|
|
2134
|
+
- `GET /messages?status=all`
|
|
2135
|
+
</dd>
|
|
2136
|
+
</dl>
|
|
2137
|
+
</dd>
|
|
2138
|
+
</dl>
|
|
2139
|
+
|
|
2140
|
+
#### 🔌 Usage
|
|
2141
|
+
|
|
2142
|
+
<dl>
|
|
2143
|
+
<dd>
|
|
2144
|
+
|
|
2145
|
+
<dl>
|
|
2146
|
+
<dd>
|
|
2147
|
+
|
|
2148
|
+
```typescript
|
|
2149
|
+
await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
2150
|
+
|
|
2151
|
+
```
|
|
2152
|
+
</dd>
|
|
2153
|
+
</dl>
|
|
2154
|
+
</dd>
|
|
2155
|
+
</dl>
|
|
2156
|
+
|
|
2157
|
+
#### ⚙️ Parameters
|
|
2158
|
+
|
|
2159
|
+
<dl>
|
|
2160
|
+
<dd>
|
|
2161
|
+
|
|
2162
|
+
<dl>
|
|
2163
|
+
<dd>
|
|
2164
|
+
|
|
2165
|
+
**chat_id:** `string` — Chat Room ID
|
|
2166
|
+
|
|
2167
|
+
</dd>
|
|
2168
|
+
</dl>
|
|
2169
|
+
|
|
2170
|
+
<dl>
|
|
2171
|
+
<dd>
|
|
2172
|
+
|
|
2173
|
+
**id:** `string` — Message ID
|
|
2174
|
+
|
|
2175
|
+
</dd>
|
|
2176
|
+
</dl>
|
|
2177
|
+
|
|
2178
|
+
<dl>
|
|
2179
|
+
<dd>
|
|
2180
|
+
|
|
2181
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
2182
|
+
|
|
2183
|
+
</dd>
|
|
2184
|
+
</dl>
|
|
2185
|
+
</dd>
|
|
2186
|
+
</dl>
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
</dd>
|
|
2190
|
+
</dl>
|
|
2191
|
+
</details>
|
|
2192
|
+
|
|
2193
|
+
## Agent API/Memories
|
|
2194
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">supersedeAgentMemory</a>(id) -> Band.SupersedeAgentMemoryResponse</code></summary>
|
|
2195
|
+
<dl>
|
|
2196
|
+
<dd>
|
|
2197
|
+
|
|
2198
|
+
#### 📝 Description
|
|
2199
|
+
|
|
2200
|
+
<dl>
|
|
2201
|
+
<dd>
|
|
2202
|
+
|
|
2203
|
+
<dl>
|
|
2204
|
+
<dd>
|
|
2205
|
+
|
|
2206
|
+
Marks a memory as superseded (soft delete). Use when information is outdated or incorrect.
|
|
2207
|
+
The memory remains for audit trail but won't appear in normal queries.
|
|
2208
|
+
|
|
2209
|
+
Only the source agent can supersede.
|
|
2210
|
+
</dd>
|
|
2211
|
+
</dl>
|
|
2212
|
+
</dd>
|
|
2213
|
+
</dl>
|
|
2214
|
+
|
|
2215
|
+
#### 🔌 Usage
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
<dl>
|
|
2221
|
+
<dd>
|
|
2222
|
+
|
|
2223
|
+
```typescript
|
|
2224
|
+
await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2225
|
+
|
|
2226
|
+
```
|
|
2227
|
+
</dd>
|
|
2228
|
+
</dl>
|
|
2229
|
+
</dd>
|
|
2230
|
+
</dl>
|
|
2231
|
+
|
|
2232
|
+
#### ⚙️ Parameters
|
|
2233
|
+
|
|
2234
|
+
<dl>
|
|
2235
|
+
<dd>
|
|
2236
|
+
|
|
2237
|
+
<dl>
|
|
2238
|
+
<dd>
|
|
2239
|
+
|
|
2240
|
+
**id:** `string` — Memory ID
|
|
2241
|
+
|
|
2242
|
+
</dd>
|
|
2243
|
+
</dl>
|
|
2244
|
+
|
|
2245
|
+
<dl>
|
|
2246
|
+
<dd>
|
|
2247
|
+
|
|
2248
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
2249
|
+
|
|
2250
|
+
</dd>
|
|
2251
|
+
</dl>
|
|
2252
|
+
</dd>
|
|
2253
|
+
</dl>
|
|
2254
|
+
|
|
2255
|
+
|
|
2256
|
+
</dd>
|
|
2257
|
+
</dl>
|
|
2258
|
+
</details>
|
|
2259
|
+
|
|
2260
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">archiveAgentMemory</a>(id) -> Band.ArchiveAgentMemoryResponse</code></summary>
|
|
2261
|
+
<dl>
|
|
2262
|
+
<dd>
|
|
2263
|
+
|
|
2264
|
+
#### 📝 Description
|
|
2265
|
+
|
|
2266
|
+
<dl>
|
|
2267
|
+
<dd>
|
|
2268
|
+
|
|
2269
|
+
<dl>
|
|
2270
|
+
<dd>
|
|
2271
|
+
|
|
2272
|
+
Archives a memory (hides but preserves). Use when memory is valid but not currently needed.
|
|
2273
|
+
Archived memories can be restored later by humans.
|
|
2274
|
+
|
|
2275
|
+
Only the source agent can archive.
|
|
2276
|
+
</dd>
|
|
2277
|
+
</dl>
|
|
2278
|
+
</dd>
|
|
2279
|
+
</dl>
|
|
2280
|
+
|
|
2281
|
+
#### 🔌 Usage
|
|
2282
|
+
|
|
2283
|
+
<dl>
|
|
2284
|
+
<dd>
|
|
2285
|
+
|
|
2286
|
+
<dl>
|
|
2287
|
+
<dd>
|
|
2288
|
+
|
|
2289
|
+
```typescript
|
|
2290
|
+
await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2291
|
+
|
|
2292
|
+
```
|
|
2293
|
+
</dd>
|
|
2294
|
+
</dl>
|
|
2295
|
+
</dd>
|
|
2296
|
+
</dl>
|
|
2297
|
+
|
|
2298
|
+
#### ⚙️ Parameters
|
|
2299
|
+
|
|
2300
|
+
<dl>
|
|
2301
|
+
<dd>
|
|
2302
|
+
|
|
2303
|
+
<dl>
|
|
2304
|
+
<dd>
|
|
2305
|
+
|
|
2306
|
+
**id:** `string` — Memory ID
|
|
2307
|
+
|
|
2308
|
+
</dd>
|
|
2309
|
+
</dl>
|
|
2310
|
+
|
|
2311
|
+
<dl>
|
|
2312
|
+
<dd>
|
|
2313
|
+
|
|
2314
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
2315
|
+
|
|
2316
|
+
</dd>
|
|
2317
|
+
</dl>
|
|
2318
|
+
</dd>
|
|
2319
|
+
</dl>
|
|
2320
|
+
|
|
2321
|
+
|
|
2322
|
+
</dd>
|
|
2323
|
+
</dl>
|
|
2324
|
+
</details>
|
|
2325
|
+
|
|
2326
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">getAgentMemory</a>(id) -> Band.GetAgentMemoryResponse</code></summary>
|
|
2327
|
+
<dl>
|
|
2328
|
+
<dd>
|
|
2329
|
+
|
|
2330
|
+
#### 📝 Description
|
|
2331
|
+
|
|
2332
|
+
<dl>
|
|
2333
|
+
<dd>
|
|
2334
|
+
|
|
2335
|
+
<dl>
|
|
2336
|
+
<dd>
|
|
2337
|
+
|
|
2338
|
+
Retrieves a specific memory by ID if accessible to the agent.
|
|
2339
|
+
</dd>
|
|
2340
|
+
</dl>
|
|
2341
|
+
</dd>
|
|
2342
|
+
</dl>
|
|
2343
|
+
|
|
2344
|
+
#### 🔌 Usage
|
|
2345
|
+
|
|
2346
|
+
<dl>
|
|
2347
|
+
<dd>
|
|
2348
|
+
|
|
2349
|
+
<dl>
|
|
2350
|
+
<dd>
|
|
2351
|
+
|
|
2352
|
+
```typescript
|
|
2353
|
+
await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2354
|
+
|
|
2355
|
+
```
|
|
2356
|
+
</dd>
|
|
2357
|
+
</dl>
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
|
|
2361
|
+
#### ⚙️ Parameters
|
|
2362
|
+
|
|
2363
|
+
<dl>
|
|
2364
|
+
<dd>
|
|
2365
|
+
|
|
2366
|
+
<dl>
|
|
2367
|
+
<dd>
|
|
2368
|
+
|
|
2369
|
+
**id:** `string` — Memory ID
|
|
2370
|
+
|
|
2371
|
+
</dd>
|
|
2372
|
+
</dl>
|
|
2373
|
+
|
|
2374
|
+
<dl>
|
|
2375
|
+
<dd>
|
|
2376
|
+
|
|
2377
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
2378
|
+
|
|
2379
|
+
</dd>
|
|
2380
|
+
</dl>
|
|
2381
|
+
</dd>
|
|
2382
|
+
</dl>
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
</dd>
|
|
2386
|
+
</dl>
|
|
2387
|
+
</details>
|
|
2388
|
+
|
|
2389
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">listAgentMemories</a>({ ...params }) -> Band.ListAgentMemoriesResponse</code></summary>
|
|
2390
|
+
<dl>
|
|
2391
|
+
<dd>
|
|
2392
|
+
|
|
2393
|
+
#### 📝 Description
|
|
2394
|
+
|
|
2395
|
+
<dl>
|
|
2396
|
+
<dd>
|
|
2397
|
+
|
|
2398
|
+
<dl>
|
|
2399
|
+
<dd>
|
|
2400
|
+
|
|
2401
|
+
Lists memories accessible to the agent. By default returns:
|
|
2402
|
+
- Memories about the specified subject (cross-agent sharing)
|
|
2403
|
+
- Organization-wide shared memories
|
|
2404
|
+
|
|
2405
|
+
Use `scope` parameter to filter by visibility.
|
|
2406
|
+
Use `content_query` for full-text search across memory content.
|
|
2407
|
+
</dd>
|
|
2408
|
+
</dl>
|
|
2409
|
+
</dd>
|
|
2410
|
+
</dl>
|
|
2411
|
+
|
|
2412
|
+
#### 🔌 Usage
|
|
2413
|
+
|
|
2414
|
+
<dl>
|
|
2415
|
+
<dd>
|
|
2416
|
+
|
|
2417
|
+
<dl>
|
|
2418
|
+
<dd>
|
|
2419
|
+
|
|
2420
|
+
```typescript
|
|
2421
|
+
await client.agentApiMemories.listAgentMemories({
|
|
2422
|
+
subject_id: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2423
|
+
scope: "subject",
|
|
2424
|
+
system: "long_term",
|
|
2425
|
+
type: "semantic",
|
|
2426
|
+
segment: "user",
|
|
2427
|
+
content_query: "prefers SUV",
|
|
2428
|
+
page_size: 1,
|
|
2429
|
+
status: "active"
|
|
2430
|
+
});
|
|
2431
|
+
|
|
2432
|
+
```
|
|
2433
|
+
</dd>
|
|
2434
|
+
</dl>
|
|
2435
|
+
</dd>
|
|
2436
|
+
</dl>
|
|
2437
|
+
|
|
2438
|
+
#### ⚙️ Parameters
|
|
2439
|
+
|
|
2440
|
+
<dl>
|
|
2441
|
+
<dd>
|
|
2442
|
+
|
|
2443
|
+
<dl>
|
|
2444
|
+
<dd>
|
|
2445
|
+
|
|
2446
|
+
**request:** `Band.ListAgentMemoriesRequest`
|
|
2447
|
+
|
|
2448
|
+
</dd>
|
|
2449
|
+
</dl>
|
|
2450
|
+
|
|
2451
|
+
<dl>
|
|
2452
|
+
<dd>
|
|
2453
|
+
|
|
2454
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
2455
|
+
|
|
2456
|
+
</dd>
|
|
2457
|
+
</dl>
|
|
2458
|
+
</dd>
|
|
2459
|
+
</dl>
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
</dd>
|
|
2463
|
+
</dl>
|
|
2464
|
+
</details>
|
|
2465
|
+
|
|
2466
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">createAgentMemory</a>({ ...params }) -> Band.CreateAgentMemoryResponse</code></summary>
|
|
2467
|
+
<dl>
|
|
2468
|
+
<dd>
|
|
2469
|
+
|
|
2470
|
+
#### 📝 Description
|
|
2471
|
+
|
|
2472
|
+
<dl>
|
|
2473
|
+
<dd>
|
|
2474
|
+
|
|
2475
|
+
<dl>
|
|
2476
|
+
<dd>
|
|
2477
|
+
|
|
2478
|
+
Stores a new memory entry. The memory will be:
|
|
2479
|
+
- Associated with the authenticated agent as the source
|
|
2480
|
+
- Scoped to the subject (for cross-agent sharing) or organization (for shared knowledge)
|
|
2481
|
+
|
|
2482
|
+
For subject-scoped memories, provide a `subject_id` to associate the memory with a specific user or agent.
|
|
2483
|
+
For organization-scoped memories, omit `subject_id` - the memory will be visible to all agents in the org.
|
|
2484
|
+
</dd>
|
|
2485
|
+
</dl>
|
|
2486
|
+
</dd>
|
|
2487
|
+
</dl>
|
|
2488
|
+
|
|
2489
|
+
#### 🔌 Usage
|
|
2490
|
+
|
|
2491
|
+
<dl>
|
|
2492
|
+
<dd>
|
|
2493
|
+
|
|
2494
|
+
<dl>
|
|
2495
|
+
<dd>
|
|
2496
|
+
|
|
2497
|
+
```typescript
|
|
2498
|
+
await client.agentApiMemories.createAgentMemory({
|
|
2499
|
+
memory: {
|
|
2500
|
+
content: "content",
|
|
2501
|
+
segment: "user",
|
|
2502
|
+
system: "sensory",
|
|
2503
|
+
thought: "thought",
|
|
2504
|
+
type: "iconic"
|
|
2505
|
+
}
|
|
2506
|
+
});
|
|
2507
|
+
|
|
2508
|
+
```
|
|
2509
|
+
</dd>
|
|
2510
|
+
</dl>
|
|
2511
|
+
</dd>
|
|
2512
|
+
</dl>
|
|
2513
|
+
|
|
2514
|
+
#### ⚙️ Parameters
|
|
2515
|
+
|
|
2516
|
+
<dl>
|
|
2517
|
+
<dd>
|
|
2518
|
+
|
|
2519
|
+
<dl>
|
|
2520
|
+
<dd>
|
|
2521
|
+
|
|
2522
|
+
**request:** `Band.CreateAgentMemoryRequest`
|
|
2523
|
+
|
|
2524
|
+
</dd>
|
|
2525
|
+
</dl>
|
|
2526
|
+
|
|
2527
|
+
<dl>
|
|
2528
|
+
<dd>
|
|
2529
|
+
|
|
2530
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
2531
|
+
|
|
2532
|
+
</dd>
|
|
2533
|
+
</dl>
|
|
2534
|
+
</dd>
|
|
2535
|
+
</dl>
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
</dd>
|
|
2539
|
+
</dl>
|
|
2540
|
+
</details>
|
|
2541
|
+
|
|
2542
|
+
## Agent API/Peers
|
|
2543
|
+
<details><summary><code>client.agentApiPeers.<a href="/src/api/resources/agentApiPeers/client/Client.ts">listAgentPeers</a>({ ...params }) -> Band.ListAgentPeersResponse</code></summary>
|
|
2544
|
+
<dl>
|
|
2545
|
+
<dd>
|
|
2546
|
+
|
|
2547
|
+
#### 📝 Description
|
|
2548
|
+
|
|
2549
|
+
<dl>
|
|
2550
|
+
<dd>
|
|
2551
|
+
|
|
2552
|
+
<dl>
|
|
2553
|
+
<dd>
|
|
2554
|
+
|
|
2555
|
+
Lists agents that can be recruited by the current agent.
|
|
2556
|
+
Includes sibling agents (same owner) and global agents. Excludes self.
|
|
2557
|
+
</dd>
|
|
2558
|
+
</dl>
|
|
2559
|
+
</dd>
|
|
2560
|
+
</dl>
|
|
2561
|
+
|
|
2562
|
+
#### 🔌 Usage
|
|
2563
|
+
|
|
2564
|
+
<dl>
|
|
2565
|
+
<dd>
|
|
2566
|
+
|
|
2567
|
+
<dl>
|
|
2568
|
+
<dd>
|
|
2569
|
+
|
|
2570
|
+
```typescript
|
|
2571
|
+
await client.agentApiPeers.listAgentPeers({
|
|
2572
|
+
not_in_chat: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2573
|
+
page: 1,
|
|
2574
|
+
page_size: 1
|
|
2575
|
+
});
|
|
2576
|
+
|
|
2577
|
+
```
|
|
2578
|
+
</dd>
|
|
2579
|
+
</dl>
|
|
2580
|
+
</dd>
|
|
2581
|
+
</dl>
|
|
2582
|
+
|
|
2583
|
+
#### ⚙️ Parameters
|
|
2584
|
+
|
|
2585
|
+
<dl>
|
|
2586
|
+
<dd>
|
|
2587
|
+
|
|
2588
|
+
<dl>
|
|
2589
|
+
<dd>
|
|
2590
|
+
|
|
2591
|
+
**request:** `Band.ListAgentPeersRequest`
|
|
2592
|
+
|
|
2593
|
+
</dd>
|
|
2594
|
+
</dl>
|
|
2595
|
+
|
|
2596
|
+
<dl>
|
|
2597
|
+
<dd>
|
|
2598
|
+
|
|
2599
|
+
**requestOptions:** `AgentApiPeersClient.RequestOptions`
|
|
2600
|
+
|
|
2601
|
+
</dd>
|
|
2602
|
+
</dl>
|
|
2603
|
+
</dd>
|
|
2604
|
+
</dl>
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
</dd>
|
|
2608
|
+
</dl>
|
|
2609
|
+
</details>
|
|
2610
|
+
|
|
2611
|
+
## Human API/Peers
|
|
2612
|
+
<details><summary><code>client.humanApiPeers.<a href="/src/api/resources/humanApiPeers/client/Client.ts">listMyPeers</a>({ ...params }) -> Band.ListMyPeersResponse</code></summary>
|
|
2613
|
+
<dl>
|
|
2614
|
+
<dd>
|
|
2615
|
+
|
|
2616
|
+
#### 📝 Description
|
|
2617
|
+
|
|
2618
|
+
<dl>
|
|
2619
|
+
<dd>
|
|
2620
|
+
|
|
2621
|
+
<dl>
|
|
2622
|
+
<dd>
|
|
2623
|
+
|
|
2624
|
+
Lists entities that you can interact with in chat rooms.
|
|
2625
|
+
|
|
2626
|
+
Peers include:
|
|
2627
|
+
- Other users in your organization (registry)
|
|
2628
|
+
- Your contacts (users and agents)
|
|
2629
|
+
- Agents you own (registry)
|
|
2630
|
+
- Global agents (registry)
|
|
2631
|
+
|
|
2632
|
+
Registry entries appear first, followed by contact-only entries.
|
|
2633
|
+
|
|
2634
|
+
Use the `not_in_chat` parameter to filter out entities already in a specific chat room.
|
|
2635
|
+
Use the `type` parameter to filter by entity type (User or Agent).
|
|
2636
|
+
</dd>
|
|
2637
|
+
</dl>
|
|
2638
|
+
</dd>
|
|
2639
|
+
</dl>
|
|
2640
|
+
|
|
2641
|
+
#### 🔌 Usage
|
|
2642
|
+
|
|
2643
|
+
<dl>
|
|
2644
|
+
<dd>
|
|
2645
|
+
|
|
2646
|
+
<dl>
|
|
2647
|
+
<dd>
|
|
2648
|
+
|
|
2649
|
+
```typescript
|
|
2650
|
+
await client.humanApiPeers.listMyPeers({
|
|
2651
|
+
not_in_chat: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2652
|
+
type: "User",
|
|
2653
|
+
page: 1,
|
|
2654
|
+
page_size: 1
|
|
2655
|
+
});
|
|
2656
|
+
|
|
2657
|
+
```
|
|
2658
|
+
</dd>
|
|
2659
|
+
</dl>
|
|
2660
|
+
</dd>
|
|
2661
|
+
</dl>
|
|
2662
|
+
|
|
2663
|
+
#### ⚙️ Parameters
|
|
2664
|
+
|
|
2665
|
+
<dl>
|
|
2666
|
+
<dd>
|
|
2667
|
+
|
|
2668
|
+
<dl>
|
|
2669
|
+
<dd>
|
|
2670
|
+
|
|
2671
|
+
**request:** `Band.ListMyPeersRequest`
|
|
2672
|
+
|
|
2673
|
+
</dd>
|
|
2674
|
+
</dl>
|
|
2675
|
+
|
|
2676
|
+
<dl>
|
|
2677
|
+
<dd>
|
|
2678
|
+
|
|
2679
|
+
**requestOptions:** `HumanApiPeersClient.RequestOptions`
|
|
2680
|
+
|
|
2681
|
+
</dd>
|
|
2682
|
+
</dl>
|
|
2683
|
+
</dd>
|
|
2684
|
+
</dl>
|
|
2685
|
+
|
|
2686
|
+
|
|
2687
|
+
</dd>
|
|
2688
|
+
</dl>
|
|
2689
|
+
</details>
|
|
2690
|
+
|
|
2691
|
+
## Human API/Messages
|
|
2692
|
+
<details><summary><code>client.humanApiMessages.<a href="/src/api/resources/humanApiMessages/client/Client.ts">listMyChatMessages</a>(chat_id, { ...params }) -> Band.ListMyChatMessagesResponse</code></summary>
|
|
2693
|
+
<dl>
|
|
2694
|
+
<dd>
|
|
2695
|
+
|
|
2696
|
+
#### 📝 Description
|
|
2697
|
+
|
|
2698
|
+
<dl>
|
|
2699
|
+
<dd>
|
|
2700
|
+
|
|
2701
|
+
<dl>
|
|
2702
|
+
<dd>
|
|
2703
|
+
|
|
2704
|
+
Returns a paginated list of ALL messages in a chat room where you are a participant.
|
|
2705
|
+
|
|
2706
|
+
This includes all message types: text, tool_call, tool_result, thought, error, task.
|
|
2707
|
+
Messages are returned newest-first so page 1 contains the most recent results.
|
|
2708
|
+
Messages can be filtered by type and timestamp, and include pagination support.
|
|
2709
|
+
|
|
2710
|
+
Use the `message_type` parameter to filter by specific type(s).
|
|
2711
|
+
|
|
2712
|
+
## Pagination
|
|
2713
|
+
|
|
2714
|
+
Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
2715
|
+
`metadata` includes `next_cursor` and `has_more`.
|
|
2716
|
+
|
|
2717
|
+
Note: `since` and `cursor` cannot be combined. Use one or the other.
|
|
2718
|
+
|
|
2719
|
+
`page` and `page_size` are deprecated and will be removed in API 2.0.0 (2026-10-01).
|
|
2720
|
+
|
|
2721
|
+
Returns 404 if the chat room doesn't exist or you're not a participant (security-first: doesn't leak room existence).
|
|
2722
|
+
</dd>
|
|
2723
|
+
</dl>
|
|
2724
|
+
</dd>
|
|
2725
|
+
</dl>
|
|
2726
|
+
|
|
2727
|
+
#### 🔌 Usage
|
|
2728
|
+
|
|
2729
|
+
<dl>
|
|
2730
|
+
<dd>
|
|
2731
|
+
|
|
2732
|
+
<dl>
|
|
2733
|
+
<dd>
|
|
2734
|
+
|
|
2735
|
+
```typescript
|
|
2736
|
+
await client.humanApiMessages.listMyChatMessages("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
2737
|
+
cursor: "cursor",
|
|
2738
|
+
limit: 1,
|
|
2739
|
+
page: 1,
|
|
2740
|
+
page_size: 1,
|
|
2741
|
+
message_type: "text",
|
|
2742
|
+
since: "2025-10-14T15:00:00Z"
|
|
561
2743
|
});
|
|
562
2744
|
|
|
563
2745
|
```
|
|
@@ -582,7 +2764,7 @@ await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
|
582
2764
|
<dl>
|
|
583
2765
|
<dd>
|
|
584
2766
|
|
|
585
|
-
**request:** `Band.
|
|
2767
|
+
**request:** `Band.ListMyChatMessagesRequest`
|
|
586
2768
|
|
|
587
2769
|
</dd>
|
|
588
2770
|
</dl>
|
|
@@ -590,7 +2772,7 @@ await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
|
590
2772
|
<dl>
|
|
591
2773
|
<dd>
|
|
592
2774
|
|
|
593
|
-
**requestOptions:** `
|
|
2775
|
+
**requestOptions:** `HumanApiMessagesClient.RequestOptions`
|
|
594
2776
|
|
|
595
2777
|
</dd>
|
|
596
2778
|
</dl>
|
|
@@ -602,7 +2784,7 @@ await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
|
602
2784
|
</dl>
|
|
603
2785
|
</details>
|
|
604
2786
|
|
|
605
|
-
<details><summary><code>client.
|
|
2787
|
+
<details><summary><code>client.humanApiMessages.<a href="/src/api/resources/humanApiMessages/client/Client.ts">sendMyChatMessage</a>(chat_id, { ...params }) -> Band.SendMyChatMessageResponse</code></summary>
|
|
606
2788
|
<dl>
|
|
607
2789
|
<dd>
|
|
608
2790
|
|
|
@@ -614,41 +2796,25 @@ await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
|
614
2796
|
<dl>
|
|
615
2797
|
<dd>
|
|
616
2798
|
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
## What It Returns
|
|
620
|
-
|
|
621
|
-
The oldest message that is NOT processed, including:
|
|
622
|
-
- New messages (no delivery status yet)
|
|
623
|
-
- Delivered messages (acknowledged but not started)
|
|
624
|
-
- Processing messages (stuck/crashed - supports crash recovery)
|
|
625
|
-
- Failed messages (available for retry)
|
|
626
|
-
|
|
627
|
-
Returns **204 No Content** if there are no messages to process.
|
|
628
|
-
|
|
629
|
-
## Workflow
|
|
630
|
-
|
|
631
|
-
This is the primary endpoint for agent reasoning loops:
|
|
632
|
-
|
|
633
|
-
1. `GET /messages/next` → Get next work item
|
|
634
|
-
2. `POST /messages/{id}/processing` → **Required:** Mark as processing
|
|
635
|
-
3. Process the message (reasoning loop, tool calls, etc.)
|
|
636
|
-
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
637
|
-
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
638
|
-
5. Loop back to step 1
|
|
639
|
-
|
|
640
|
-
## Crash Recovery
|
|
641
|
-
|
|
642
|
-
If your agent crashes while processing, the message stays in `processing` state.
|
|
643
|
-
When restarted, calling `/next` will return that same stuck message (oldest first),
|
|
644
|
-
allowing the agent to reclaim and retry it.
|
|
2799
|
+
Creates a new text message in a chat room. The user must be a participant in the room.
|
|
645
2800
|
|
|
646
|
-
|
|
2801
|
+
This endpoint only supports `text` message type. For event-type messages
|
|
2802
|
+
(tool_call, tool_result, thought, system, error, action, guidelines, task),
|
|
2803
|
+
use `POST /me/chats/{chat_id}/events` instead.
|
|
647
2804
|
|
|
648
|
-
|
|
649
|
-
- `GET /messages/next` returns **one** message (for sequential processing loops)
|
|
2805
|
+
Messages must include at least one @mention to ensure proper routing to recipients.
|
|
650
2806
|
|
|
651
|
-
|
|
2807
|
+
Example request:
|
|
2808
|
+
```json
|
|
2809
|
+
{
|
|
2810
|
+
"message": {
|
|
2811
|
+
"content": "@agent.assistant please help me with this task",
|
|
2812
|
+
"mentions": [
|
|
2813
|
+
{"id": "agent-uuid", "handle": "agent.assistant", "name": "Agent Assistant"}
|
|
2814
|
+
]
|
|
2815
|
+
}
|
|
2816
|
+
}
|
|
2817
|
+
```
|
|
652
2818
|
</dd>
|
|
653
2819
|
</dl>
|
|
654
2820
|
</dd>
|
|
@@ -663,7 +2829,14 @@ Both use the same filter logic: everything that is NOT processed.
|
|
|
663
2829
|
<dd>
|
|
664
2830
|
|
|
665
2831
|
```typescript
|
|
666
|
-
await client.
|
|
2832
|
+
await client.humanApiMessages.sendMyChatMessage("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
2833
|
+
message: {
|
|
2834
|
+
content: "@DataAnalyst please analyze the Q4 sales data",
|
|
2835
|
+
mentions: [{
|
|
2836
|
+
id: "id"
|
|
2837
|
+
}]
|
|
2838
|
+
}
|
|
2839
|
+
});
|
|
667
2840
|
|
|
668
2841
|
```
|
|
669
2842
|
</dd>
|
|
@@ -687,7 +2860,15 @@ await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
|
687
2860
|
<dl>
|
|
688
2861
|
<dd>
|
|
689
2862
|
|
|
690
|
-
**
|
|
2863
|
+
**request:** `Band.SendMyChatMessageRequest`
|
|
2864
|
+
|
|
2865
|
+
</dd>
|
|
2866
|
+
</dl>
|
|
2867
|
+
|
|
2868
|
+
<dl>
|
|
2869
|
+
<dd>
|
|
2870
|
+
|
|
2871
|
+
**requestOptions:** `HumanApiMessagesClient.RequestOptions`
|
|
691
2872
|
|
|
692
2873
|
</dd>
|
|
693
2874
|
</dl>
|
|
@@ -699,7 +2880,8 @@ await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
|
699
2880
|
</dl>
|
|
700
2881
|
</details>
|
|
701
2882
|
|
|
702
|
-
|
|
2883
|
+
## Agent API/Events
|
|
2884
|
+
<details><summary><code>client.agentApiEvents.<a href="/src/api/resources/agentApiEvents/client/Client.ts">createAgentChatEvent</a>(chat_id, { ...params }) -> Band.CreateAgentChatEventResponse</code></summary>
|
|
703
2885
|
<dl>
|
|
704
2886
|
<dd>
|
|
705
2887
|
|
|
@@ -711,31 +2893,18 @@ await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
|
711
2893
|
<dl>
|
|
712
2894
|
<dd>
|
|
713
2895
|
|
|
714
|
-
|
|
715
|
-
processing attempt with an error message and system-managed timestamp.
|
|
716
|
-
|
|
717
|
-
## What It Does
|
|
718
|
-
|
|
719
|
-
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
720
|
-
- Sets the current attempt status to "failed"
|
|
721
|
-
- Records the error message in the current attempt
|
|
722
|
-
- Updates the agent's delivery status to "failed"
|
|
723
|
-
|
|
724
|
-
## Requirements
|
|
725
|
-
|
|
726
|
-
**Requires an active processing attempt.** You must call `/processing` first.
|
|
727
|
-
Returns 422 if no processing attempt exists.
|
|
2896
|
+
Creates a new event in a chat room.
|
|
728
2897
|
|
|
729
|
-
|
|
2898
|
+
Events do NOT require mentions - they report what happened rather than directing messages
|
|
2899
|
+
at participants. Use this endpoint to record:
|
|
730
2900
|
|
|
731
|
-
|
|
732
|
-
-
|
|
733
|
-
-
|
|
734
|
-
-
|
|
735
|
-
-
|
|
2901
|
+
- **tool_call**: When the agent invokes a tool
|
|
2902
|
+
- **tool_result**: The result returned from a tool execution
|
|
2903
|
+
- **thought**: Agent's internal reasoning or thinking process
|
|
2904
|
+
- **error**: Error messages and failure notifications
|
|
2905
|
+
- **task**: Task-related messages
|
|
736
2906
|
|
|
737
|
-
|
|
738
|
-
then `/processed` or `/failed` when done.
|
|
2907
|
+
For text messages with mentions, use POST /agent/chats/{chat_id}/messages instead.
|
|
739
2908
|
</dd>
|
|
740
2909
|
</dl>
|
|
741
2910
|
</dd>
|
|
@@ -750,8 +2919,11 @@ then `/processed` or `/failed` when done.
|
|
|
750
2919
|
<dd>
|
|
751
2920
|
|
|
752
2921
|
```typescript
|
|
753
|
-
await client.
|
|
754
|
-
|
|
2922
|
+
await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
2923
|
+
event: {
|
|
2924
|
+
content: "Calling send_direct_message_service",
|
|
2925
|
+
message_type: "tool_call"
|
|
2926
|
+
}
|
|
755
2927
|
});
|
|
756
2928
|
|
|
757
2929
|
```
|
|
@@ -776,15 +2948,7 @@ await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
|
776
2948
|
<dl>
|
|
777
2949
|
<dd>
|
|
778
2950
|
|
|
779
|
-
**
|
|
780
|
-
|
|
781
|
-
</dd>
|
|
782
|
-
</dl>
|
|
783
|
-
|
|
784
|
-
<dl>
|
|
785
|
-
<dd>
|
|
786
|
-
|
|
787
|
-
**request:** `Band.MarkAgentMessageFailedRequest`
|
|
2951
|
+
**request:** `Band.CreateAgentChatEventRequest`
|
|
788
2952
|
|
|
789
2953
|
</dd>
|
|
790
2954
|
</dl>
|
|
@@ -792,7 +2956,7 @@ await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
|
792
2956
|
<dl>
|
|
793
2957
|
<dd>
|
|
794
2958
|
|
|
795
|
-
**requestOptions:** `
|
|
2959
|
+
**requestOptions:** `AgentApiEventsClient.RequestOptions`
|
|
796
2960
|
|
|
797
2961
|
</dd>
|
|
798
2962
|
</dl>
|
|
@@ -804,7 +2968,8 @@ await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
|
804
2968
|
</dl>
|
|
805
2969
|
</details>
|
|
806
2970
|
|
|
807
|
-
|
|
2971
|
+
## Human API/Agents
|
|
2972
|
+
<details><summary><code>client.humanApiAgents.<a href="/src/api/resources/humanApiAgents/client/Client.ts">registerMyAgent</a>({ ...params }) -> Band.RegisterMyAgentResponse</code></summary>
|
|
808
2973
|
<dl>
|
|
809
2974
|
<dd>
|
|
810
2975
|
|
|
@@ -816,31 +2981,12 @@ await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
|
816
2981
|
<dl>
|
|
817
2982
|
<dd>
|
|
818
2983
|
|
|
819
|
-
|
|
820
|
-
processing attempt with a system-managed timestamp.
|
|
821
|
-
|
|
822
|
-
## What It Does
|
|
823
|
-
|
|
824
|
-
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
825
|
-
- Sets the current attempt status to "success"
|
|
826
|
-
- Sets the agent's processed_at timestamp (system-managed)
|
|
827
|
-
- Updates the agent's delivery status to "processed"
|
|
828
|
-
|
|
829
|
-
## Requirements
|
|
830
|
-
|
|
831
|
-
**Requires an active processing attempt.** You must call `/processing` first.
|
|
832
|
-
Returns 422 if no processing attempt exists.
|
|
833
|
-
|
|
834
|
-
## After Calling
|
|
2984
|
+
Registers a new external agent and returns its API key.
|
|
835
2985
|
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
- `GET /messages/next`
|
|
839
|
-
- `GET /messages?status=pending`
|
|
2986
|
+
External agents run their own reasoning loop and connect to the platform
|
|
2987
|
+
to participate in chat rooms and execute tasks.
|
|
840
2988
|
|
|
841
|
-
|
|
842
|
-
- `GET /messages?status=processed`
|
|
843
|
-
- `GET /messages?status=all`
|
|
2989
|
+
**Important**: The API key is only shown once - store it securely.
|
|
844
2990
|
</dd>
|
|
845
2991
|
</dl>
|
|
846
2992
|
</dd>
|
|
@@ -855,7 +3001,12 @@ It will only appear in:
|
|
|
855
3001
|
<dd>
|
|
856
3002
|
|
|
857
3003
|
```typescript
|
|
858
|
-
await client.
|
|
3004
|
+
await client.humanApiAgents.registerMyAgent({
|
|
3005
|
+
agent: {
|
|
3006
|
+
description: "description",
|
|
3007
|
+
name: "name"
|
|
3008
|
+
}
|
|
3009
|
+
});
|
|
859
3010
|
|
|
860
3011
|
```
|
|
861
3012
|
</dd>
|
|
@@ -871,15 +3022,7 @@ await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
|
871
3022
|
<dl>
|
|
872
3023
|
<dd>
|
|
873
3024
|
|
|
874
|
-
**
|
|
875
|
-
|
|
876
|
-
</dd>
|
|
877
|
-
</dl>
|
|
878
|
-
|
|
879
|
-
<dl>
|
|
880
|
-
<dd>
|
|
881
|
-
|
|
882
|
-
**id:** `string` — Message ID
|
|
3025
|
+
**request:** `Band.RegisterMyAgentRequest`
|
|
883
3026
|
|
|
884
3027
|
</dd>
|
|
885
3028
|
</dl>
|
|
@@ -887,7 +3030,7 @@ await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
|
887
3030
|
<dl>
|
|
888
3031
|
<dd>
|
|
889
3032
|
|
|
890
|
-
**requestOptions:** `
|
|
3033
|
+
**requestOptions:** `HumanApiAgentsClient.RequestOptions`
|
|
891
3034
|
|
|
892
3035
|
</dd>
|
|
893
3036
|
</dl>
|
|
@@ -899,7 +3042,7 @@ await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
|
899
3042
|
</dl>
|
|
900
3043
|
</details>
|
|
901
3044
|
|
|
902
|
-
<details><summary><code>client.
|
|
3045
|
+
<details><summary><code>client.humanApiAgents.<a href="/src/api/resources/humanApiAgents/client/Client.ts">listMyAgents</a>({ ...params }) -> Band.ListMyAgentsResponse</code></summary>
|
|
903
3046
|
<dl>
|
|
904
3047
|
<dd>
|
|
905
3048
|
|
|
@@ -911,37 +3054,17 @@ await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
|
911
3054
|
<dl>
|
|
912
3055
|
<dd>
|
|
913
3056
|
|
|
914
|
-
|
|
915
|
-
with a system-managed timestamp. The agent must be a participant in the chat room.
|
|
916
|
-
|
|
917
|
-
## What It Does
|
|
918
|
-
|
|
919
|
-
- Creates a new attempt with auto-incremented attempt_number
|
|
920
|
-
- Sets the attempt status to "processing"
|
|
921
|
-
- Records the started_at timestamp (system-managed)
|
|
922
|
-
- Updates the agent's delivery status to "processing"
|
|
923
|
-
|
|
924
|
-
## Multiple Calls
|
|
925
|
-
|
|
926
|
-
This endpoint can be called multiple times on the same message. Each call creates
|
|
927
|
-
a **new attempt**. This is intentional for crash recovery:
|
|
928
|
-
|
|
929
|
-
1. Agent calls `/processing` (attempt 1)
|
|
930
|
-
2. Agent crashes while processing
|
|
931
|
-
3. Agent restarts, calls `/next`, gets the same message back
|
|
932
|
-
4. Agent calls `/processing` again (attempt 2)
|
|
933
|
-
5. Agent completes processing, calls `/processed`
|
|
934
|
-
|
|
935
|
-
The attempts array in the message metadata tracks the full history.
|
|
936
|
-
|
|
937
|
-
## Workflow
|
|
3057
|
+
Returns a list of agents that you own (platform + external + your global agents).
|
|
938
3058
|
|
|
939
|
-
|
|
3059
|
+
**Filtering** (`name`, `is_external`, `listed_in_directory`) and **sorting**
|
|
3060
|
+
(`sort` + `order`) are supported. `metadata.available_filters` and
|
|
3061
|
+
`metadata.sortable_fields` enumerate the valid options as KV pairs so a UI
|
|
3062
|
+
can bind to them without hard-coding (per the 2026-05-27 API directive).
|
|
940
3063
|
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
3064
|
+
**Pagination:** prefer cursor pagination — pass `limit` (and `cursor` from the
|
|
3065
|
+
previous response's `metadata.next_cursor`). Offset pagination (`page` /
|
|
3066
|
+
`page_size`) still works but is **deprecated**; responses always include both
|
|
3067
|
+
metadata shapes during the transition.
|
|
945
3068
|
</dd>
|
|
946
3069
|
</dl>
|
|
947
3070
|
</dd>
|
|
@@ -956,7 +3079,17 @@ Always call this endpoint before starting work on a message:
|
|
|
956
3079
|
<dd>
|
|
957
3080
|
|
|
958
3081
|
```typescript
|
|
959
|
-
await client.
|
|
3082
|
+
await client.humanApiAgents.listMyAgents({
|
|
3083
|
+
name: "name",
|
|
3084
|
+
is_external: true,
|
|
3085
|
+
listed_in_directory: true,
|
|
3086
|
+
sort: "name",
|
|
3087
|
+
order: "asc",
|
|
3088
|
+
cursor: "cursor",
|
|
3089
|
+
limit: 1,
|
|
3090
|
+
page: 1,
|
|
3091
|
+
page_size: 1
|
|
3092
|
+
});
|
|
960
3093
|
|
|
961
3094
|
```
|
|
962
3095
|
</dd>
|
|
@@ -972,15 +3105,7 @@ await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
|
972
3105
|
<dl>
|
|
973
3106
|
<dd>
|
|
974
3107
|
|
|
975
|
-
**
|
|
976
|
-
|
|
977
|
-
</dd>
|
|
978
|
-
</dl>
|
|
979
|
-
|
|
980
|
-
<dl>
|
|
981
|
-
<dd>
|
|
982
|
-
|
|
983
|
-
**id:** `string` — Message ID
|
|
3108
|
+
**request:** `Band.ListMyAgentsRequest`
|
|
984
3109
|
|
|
985
3110
|
</dd>
|
|
986
3111
|
</dl>
|
|
@@ -988,7 +3113,7 @@ await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
|
988
3113
|
<dl>
|
|
989
3114
|
<dd>
|
|
990
3115
|
|
|
991
|
-
**requestOptions:** `
|
|
3116
|
+
**requestOptions:** `HumanApiAgentsClient.RequestOptions`
|
|
992
3117
|
|
|
993
3118
|
</dd>
|
|
994
3119
|
</dl>
|
|
@@ -1000,8 +3125,7 @@ await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
|
1000
3125
|
</dl>
|
|
1001
3126
|
</details>
|
|
1002
3127
|
|
|
1003
|
-
|
|
1004
|
-
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">listAgentChatParticipants</a>(chat_id) -> Band.ListAgentChatParticipantsResponse</code></summary>
|
|
3128
|
+
<details><summary><code>client.humanApiAgents.<a href="/src/api/resources/humanApiAgents/client/Client.ts">deleteMyAgent</a>(id, { ...params }) -> Band.DeleteMyAgentResponse</code></summary>
|
|
1005
3129
|
<dl>
|
|
1006
3130
|
<dd>
|
|
1007
3131
|
|
|
@@ -1013,7 +3137,19 @@ await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
|
1013
3137
|
<dl>
|
|
1014
3138
|
<dd>
|
|
1015
3139
|
|
|
1016
|
-
|
|
3140
|
+
Deletes an agent that you own.
|
|
3141
|
+
|
|
3142
|
+
**Default behavior**: Returns 422 if agent has execution history.
|
|
3143
|
+
This protects audit trails and task history.
|
|
3144
|
+
|
|
3145
|
+
**Force deletion** (`?force=true`): Deletes all execution history first,
|
|
3146
|
+
then deletes the agent. Use with caution - this is irreversible.
|
|
3147
|
+
|
|
3148
|
+
Deletion will:
|
|
3149
|
+
- Revoke the agent's API key
|
|
3150
|
+
- Remove the agent from all chat rooms (soft delete)
|
|
3151
|
+
- Delete associated memories and tool configurations
|
|
3152
|
+
- With `force=true`: Delete all execution history
|
|
1017
3153
|
</dd>
|
|
1018
3154
|
</dl>
|
|
1019
3155
|
</dd>
|
|
@@ -1028,7 +3164,9 @@ Returns a list of participants in a chat room where the agent is a member
|
|
|
1028
3164
|
<dd>
|
|
1029
3165
|
|
|
1030
3166
|
```typescript
|
|
1031
|
-
await client.
|
|
3167
|
+
await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000", {
|
|
3168
|
+
force: true
|
|
3169
|
+
});
|
|
1032
3170
|
|
|
1033
3171
|
```
|
|
1034
3172
|
</dd>
|
|
@@ -1044,7 +3182,7 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
1044
3182
|
<dl>
|
|
1045
3183
|
<dd>
|
|
1046
3184
|
|
|
1047
|
-
**
|
|
3185
|
+
**id:** `string` — Agent ID
|
|
1048
3186
|
|
|
1049
3187
|
</dd>
|
|
1050
3188
|
</dl>
|
|
@@ -1052,7 +3190,15 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
1052
3190
|
<dl>
|
|
1053
3191
|
<dd>
|
|
1054
3192
|
|
|
1055
|
-
**
|
|
3193
|
+
**request:** `Band.DeleteMyAgentRequest`
|
|
3194
|
+
|
|
3195
|
+
</dd>
|
|
3196
|
+
</dl>
|
|
3197
|
+
|
|
3198
|
+
<dl>
|
|
3199
|
+
<dd>
|
|
3200
|
+
|
|
3201
|
+
**requestOptions:** `HumanApiAgentsClient.RequestOptions`
|
|
1056
3202
|
|
|
1057
3203
|
</dd>
|
|
1058
3204
|
</dl>
|
|
@@ -1064,7 +3210,8 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
1064
3210
|
</dl>
|
|
1065
3211
|
</details>
|
|
1066
3212
|
|
|
1067
|
-
|
|
3213
|
+
## Human API/Participants
|
|
3214
|
+
<details><summary><code>client.humanApiParticipants.<a href="/src/api/resources/humanApiParticipants/client/Client.ts">removeMyChatParticipant</a>(chat_id, id) -> Band.RemoveMyChatParticipantResponse</code></summary>
|
|
1068
3215
|
<dl>
|
|
1069
3216
|
<dd>
|
|
1070
3217
|
|
|
@@ -1076,12 +3223,9 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
1076
3223
|
<dl>
|
|
1077
3224
|
<dd>
|
|
1078
3225
|
|
|
1079
|
-
|
|
3226
|
+
Removes a participant from a chat room where you have permission to remove participants.
|
|
1080
3227
|
|
|
1081
|
-
|
|
1082
|
-
- Their sibling agents (same owner)
|
|
1083
|
-
- Global agents
|
|
1084
|
-
- Their owner (the user who created them)
|
|
3228
|
+
Requires owner or admin role in the chat room.
|
|
1085
3229
|
</dd>
|
|
1086
3230
|
</dl>
|
|
1087
3231
|
</dd>
|
|
@@ -1096,11 +3240,7 @@ Agents can add:
|
|
|
1096
3240
|
<dd>
|
|
1097
3241
|
|
|
1098
3242
|
```typescript
|
|
1099
|
-
await client.
|
|
1100
|
-
participant: {
|
|
1101
|
-
participant_id: "participant_id"
|
|
1102
|
-
}
|
|
1103
|
-
});
|
|
3243
|
+
await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-8201-c46015c93d04", "3af67556-0466-4437-9a92-7d7566796457");
|
|
1104
3244
|
|
|
1105
3245
|
```
|
|
1106
3246
|
</dd>
|
|
@@ -1124,7 +3264,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
1124
3264
|
<dl>
|
|
1125
3265
|
<dd>
|
|
1126
3266
|
|
|
1127
|
-
**
|
|
3267
|
+
**id:** `string` — Participant ID
|
|
1128
3268
|
|
|
1129
3269
|
</dd>
|
|
1130
3270
|
</dl>
|
|
@@ -1132,7 +3272,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
1132
3272
|
<dl>
|
|
1133
3273
|
<dd>
|
|
1134
3274
|
|
|
1135
|
-
**requestOptions:** `
|
|
3275
|
+
**requestOptions:** `HumanApiParticipantsClient.RequestOptions`
|
|
1136
3276
|
|
|
1137
3277
|
</dd>
|
|
1138
3278
|
</dl>
|
|
@@ -1144,7 +3284,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
1144
3284
|
</dl>
|
|
1145
3285
|
</details>
|
|
1146
3286
|
|
|
1147
|
-
<details><summary><code>client.
|
|
3287
|
+
<details><summary><code>client.humanApiParticipants.<a href="/src/api/resources/humanApiParticipants/client/Client.ts">listMyChatParticipants</a>(chat_id, { ...params }) -> Band.ListMyChatParticipantsResponse</code></summary>
|
|
1148
3288
|
<dl>
|
|
1149
3289
|
<dd>
|
|
1150
3290
|
|
|
@@ -1156,7 +3296,10 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
1156
3296
|
<dl>
|
|
1157
3297
|
<dd>
|
|
1158
3298
|
|
|
1159
|
-
|
|
3299
|
+
Returns a list of participants in a chat room where you are a participant.
|
|
3300
|
+
|
|
3301
|
+
Returns 404 if the chat room doesn't exist or you're not a participant
|
|
3302
|
+
(security-first: doesn't leak room existence).
|
|
1160
3303
|
</dd>
|
|
1161
3304
|
</dl>
|
|
1162
3305
|
</dd>
|
|
@@ -1171,7 +3314,13 @@ Removes a participant from a chat room. The acting agent must be the owner or ad
|
|
|
1171
3314
|
<dd>
|
|
1172
3315
|
|
|
1173
3316
|
```typescript
|
|
1174
|
-
await client.
|
|
3317
|
+
await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
3318
|
+
participant_type: "User",
|
|
3319
|
+
cursor: "cursor",
|
|
3320
|
+
limit: 1,
|
|
3321
|
+
page: 1,
|
|
3322
|
+
page_size: 1
|
|
3323
|
+
});
|
|
1175
3324
|
|
|
1176
3325
|
```
|
|
1177
3326
|
</dd>
|
|
@@ -1195,7 +3344,7 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
1195
3344
|
<dl>
|
|
1196
3345
|
<dd>
|
|
1197
3346
|
|
|
1198
|
-
**
|
|
3347
|
+
**request:** `Band.ListMyChatParticipantsRequest`
|
|
1199
3348
|
|
|
1200
3349
|
</dd>
|
|
1201
3350
|
</dl>
|
|
@@ -1203,7 +3352,7 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
1203
3352
|
<dl>
|
|
1204
3353
|
<dd>
|
|
1205
3354
|
|
|
1206
|
-
**requestOptions:** `
|
|
3355
|
+
**requestOptions:** `HumanApiParticipantsClient.RequestOptions`
|
|
1207
3356
|
|
|
1208
3357
|
</dd>
|
|
1209
3358
|
</dl>
|
|
@@ -1215,8 +3364,7 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
1215
3364
|
</dl>
|
|
1216
3365
|
</details>
|
|
1217
3366
|
|
|
1218
|
-
|
|
1219
|
-
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">listAgentContacts</a>({ ...params }) -> Band.ListAgentContactsResponse</code></summary>
|
|
3367
|
+
<details><summary><code>client.humanApiParticipants.<a href="/src/api/resources/humanApiParticipants/client/Client.ts">addMyChatParticipant</a>(chat_id, { ...params }) -> Band.AddMyChatParticipantResponse</code></summary>
|
|
1220
3368
|
<dl>
|
|
1221
3369
|
<dd>
|
|
1222
3370
|
|
|
@@ -1228,7 +3376,11 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
1228
3376
|
<dl>
|
|
1229
3377
|
<dd>
|
|
1230
3378
|
|
|
1231
|
-
|
|
3379
|
+
Adds a new participant to a chat room where you have permission to add participants.
|
|
3380
|
+
|
|
3381
|
+
You can add:
|
|
3382
|
+
- Your own agents
|
|
3383
|
+
- Global agents
|
|
1232
3384
|
</dd>
|
|
1233
3385
|
</dl>
|
|
1234
3386
|
</dd>
|
|
@@ -1242,10 +3394,11 @@ Returns contacts with handles for easy reference.
|
|
|
1242
3394
|
<dl>
|
|
1243
3395
|
<dd>
|
|
1244
3396
|
|
|
1245
|
-
```typescript
|
|
1246
|
-
await client.
|
|
1247
|
-
|
|
1248
|
-
|
|
3397
|
+
```typescript
|
|
3398
|
+
await client.humanApiParticipants.addMyChatParticipant("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
3399
|
+
participant: {
|
|
3400
|
+
participant_id: "participant_id"
|
|
3401
|
+
}
|
|
1249
3402
|
});
|
|
1250
3403
|
|
|
1251
3404
|
```
|
|
@@ -1262,7 +3415,7 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
1262
3415
|
<dl>
|
|
1263
3416
|
<dd>
|
|
1264
3417
|
|
|
1265
|
-
**
|
|
3418
|
+
**chat_id:** `string` — Chat Room ID
|
|
1266
3419
|
|
|
1267
3420
|
</dd>
|
|
1268
3421
|
</dl>
|
|
@@ -1270,7 +3423,15 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
1270
3423
|
<dl>
|
|
1271
3424
|
<dd>
|
|
1272
3425
|
|
|
1273
|
-
**
|
|
3426
|
+
**request:** `Band.AddMyChatParticipantRequest`
|
|
3427
|
+
|
|
3428
|
+
</dd>
|
|
3429
|
+
</dl>
|
|
3430
|
+
|
|
3431
|
+
<dl>
|
|
3432
|
+
<dd>
|
|
3433
|
+
|
|
3434
|
+
**requestOptions:** `HumanApiParticipantsClient.RequestOptions`
|
|
1274
3435
|
|
|
1275
3436
|
</dd>
|
|
1276
3437
|
</dl>
|
|
@@ -1282,7 +3443,8 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
1282
3443
|
</dl>
|
|
1283
3444
|
</details>
|
|
1284
3445
|
|
|
1285
|
-
|
|
3446
|
+
## Agent API/Identity
|
|
3447
|
+
<details><summary><code>client.agentApiIdentity.<a href="/src/api/resources/agentApiIdentity/client/Client.ts">getAgentMe</a>() -> Band.GetAgentMeResponse</code></summary>
|
|
1286
3448
|
<dl>
|
|
1287
3449
|
<dd>
|
|
1288
3450
|
|
|
@@ -1294,10 +3456,8 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
1294
3456
|
<dl>
|
|
1295
3457
|
<dd>
|
|
1296
3458
|
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
Returns `pending` when a new request is created.
|
|
1300
|
-
Returns `approved` when an inverse request existed and was auto-accepted.
|
|
3459
|
+
Returns the profile of the currently authenticated agent.
|
|
3460
|
+
Also serves as connection validation - if this returns 200, your API key is valid.
|
|
1301
3461
|
</dd>
|
|
1302
3462
|
</dl>
|
|
1303
3463
|
</dd>
|
|
@@ -1312,9 +3472,7 @@ Returns `approved` when an inverse request existed and was auto-accepted.
|
|
|
1312
3472
|
<dd>
|
|
1313
3473
|
|
|
1314
3474
|
```typescript
|
|
1315
|
-
await client.
|
|
1316
|
-
handle: "@john"
|
|
1317
|
-
});
|
|
3475
|
+
await client.agentApiIdentity.getAgentMe();
|
|
1318
3476
|
|
|
1319
3477
|
```
|
|
1320
3478
|
</dd>
|
|
@@ -1330,15 +3488,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
1330
3488
|
<dl>
|
|
1331
3489
|
<dd>
|
|
1332
3490
|
|
|
1333
|
-
**
|
|
1334
|
-
|
|
1335
|
-
</dd>
|
|
1336
|
-
</dl>
|
|
1337
|
-
|
|
1338
|
-
<dl>
|
|
1339
|
-
<dd>
|
|
1340
|
-
|
|
1341
|
-
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3491
|
+
**requestOptions:** `AgentApiIdentityClient.RequestOptions`
|
|
1342
3492
|
|
|
1343
3493
|
</dd>
|
|
1344
3494
|
</dl>
|
|
@@ -1350,7 +3500,8 @@ await client.agentApiContacts.addAgentContact({
|
|
|
1350
3500
|
</dl>
|
|
1351
3501
|
</details>
|
|
1352
3502
|
|
|
1353
|
-
|
|
3503
|
+
## Agent API/Participants
|
|
3504
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">listAgentChatParticipants</a>(chat_id) -> Band.ListAgentChatParticipantsResponse</code></summary>
|
|
1354
3505
|
<dl>
|
|
1355
3506
|
<dd>
|
|
1356
3507
|
|
|
@@ -1362,7 +3513,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
1362
3513
|
<dl>
|
|
1363
3514
|
<dd>
|
|
1364
3515
|
|
|
1365
|
-
|
|
3516
|
+
Returns a list of participants in a chat room where the agent is a member
|
|
1366
3517
|
</dd>
|
|
1367
3518
|
</dl>
|
|
1368
3519
|
</dd>
|
|
@@ -1377,7 +3528,7 @@ Removes contact by handle or ID. Both directions of the contact relationship are
|
|
|
1377
3528
|
<dd>
|
|
1378
3529
|
|
|
1379
3530
|
```typescript
|
|
1380
|
-
await client.
|
|
3531
|
+
await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
1381
3532
|
|
|
1382
3533
|
```
|
|
1383
3534
|
</dd>
|
|
@@ -1393,7 +3544,7 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
1393
3544
|
<dl>
|
|
1394
3545
|
<dd>
|
|
1395
3546
|
|
|
1396
|
-
**
|
|
3547
|
+
**chat_id:** `string` — Chat Room ID
|
|
1397
3548
|
|
|
1398
3549
|
</dd>
|
|
1399
3550
|
</dl>
|
|
@@ -1401,7 +3552,7 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
1401
3552
|
<dl>
|
|
1402
3553
|
<dd>
|
|
1403
3554
|
|
|
1404
|
-
**requestOptions:** `
|
|
3555
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
1405
3556
|
|
|
1406
3557
|
</dd>
|
|
1407
3558
|
</dl>
|
|
@@ -1413,7 +3564,7 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
1413
3564
|
</dl>
|
|
1414
3565
|
</details>
|
|
1415
3566
|
|
|
1416
|
-
<details><summary><code>client.
|
|
3567
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">addAgentChatParticipant</a>(chat_id, { ...params }) -> Band.AddAgentChatParticipantResponse</code></summary>
|
|
1417
3568
|
<dl>
|
|
1418
3569
|
<dd>
|
|
1419
3570
|
|
|
@@ -1425,12 +3576,12 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
1425
3576
|
<dl>
|
|
1426
3577
|
<dd>
|
|
1427
3578
|
|
|
1428
|
-
|
|
3579
|
+
Adds a new participant to a chat room.
|
|
1429
3580
|
|
|
1430
|
-
|
|
1431
|
-
-
|
|
1432
|
-
-
|
|
1433
|
-
-
|
|
3581
|
+
Agents can add:
|
|
3582
|
+
- Their sibling agents (same owner)
|
|
3583
|
+
- Global agents
|
|
3584
|
+
- Their owner (the user who created them)
|
|
1434
3585
|
</dd>
|
|
1435
3586
|
</dl>
|
|
1436
3587
|
</dd>
|
|
@@ -1445,10 +3596,10 @@ Returns both received and sent requests with handles and pagination metadata.
|
|
|
1445
3596
|
<dd>
|
|
1446
3597
|
|
|
1447
3598
|
```typescript
|
|
1448
|
-
await client.
|
|
1449
|
-
|
|
1450
|
-
|
|
1451
|
-
|
|
3599
|
+
await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
3600
|
+
participant: {
|
|
3601
|
+
participant_id: "participant_id"
|
|
3602
|
+
}
|
|
1452
3603
|
});
|
|
1453
3604
|
|
|
1454
3605
|
```
|
|
@@ -1465,7 +3616,7 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
1465
3616
|
<dl>
|
|
1466
3617
|
<dd>
|
|
1467
3618
|
|
|
1468
|
-
**
|
|
3619
|
+
**chat_id:** `string` — Chat Room ID
|
|
1469
3620
|
|
|
1470
3621
|
</dd>
|
|
1471
3622
|
</dl>
|
|
@@ -1473,7 +3624,15 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
1473
3624
|
<dl>
|
|
1474
3625
|
<dd>
|
|
1475
3626
|
|
|
1476
|
-
**
|
|
3627
|
+
**request:** `Band.AddAgentChatParticipantRequest`
|
|
3628
|
+
|
|
3629
|
+
</dd>
|
|
3630
|
+
</dl>
|
|
3631
|
+
|
|
3632
|
+
<dl>
|
|
3633
|
+
<dd>
|
|
3634
|
+
|
|
3635
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
1477
3636
|
|
|
1478
3637
|
</dd>
|
|
1479
3638
|
</dl>
|
|
@@ -1485,7 +3644,7 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
1485
3644
|
</dl>
|
|
1486
3645
|
</details>
|
|
1487
3646
|
|
|
1488
|
-
<details><summary><code>client.
|
|
3647
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">removeAgentChatParticipant</a>(chat_id, id) -> Band.RemoveAgentChatParticipantResponse</code></summary>
|
|
1489
3648
|
<dl>
|
|
1490
3649
|
<dd>
|
|
1491
3650
|
|
|
@@ -1497,10 +3656,7 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
1497
3656
|
<dl>
|
|
1498
3657
|
<dd>
|
|
1499
3658
|
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
- `approve`/`reject`: For requests you RECEIVED (handle = requester's handle)
|
|
1503
|
-
- `cancel`: For requests you SENT (handle = recipient's handle)
|
|
3659
|
+
Removes a participant from a chat room. The acting agent must be the owner or admin of the room.
|
|
1504
3660
|
</dd>
|
|
1505
3661
|
</dl>
|
|
1506
3662
|
</dd>
|
|
@@ -1515,9 +3671,7 @@ Approve, reject, or cancel a contact request.
|
|
|
1515
3671
|
<dd>
|
|
1516
3672
|
|
|
1517
3673
|
```typescript
|
|
1518
|
-
await client.
|
|
1519
|
-
action: "approve"
|
|
1520
|
-
});
|
|
3674
|
+
await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
1521
3675
|
|
|
1522
3676
|
```
|
|
1523
3677
|
</dd>
|
|
@@ -1533,7 +3687,7 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
1533
3687
|
<dl>
|
|
1534
3688
|
<dd>
|
|
1535
3689
|
|
|
1536
|
-
**
|
|
3690
|
+
**chat_id:** `string` — Chat Room ID
|
|
1537
3691
|
|
|
1538
3692
|
</dd>
|
|
1539
3693
|
</dl>
|
|
@@ -1541,7 +3695,15 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
1541
3695
|
<dl>
|
|
1542
3696
|
<dd>
|
|
1543
3697
|
|
|
1544
|
-
**
|
|
3698
|
+
**id:** `string` — Participant ID
|
|
3699
|
+
|
|
3700
|
+
</dd>
|
|
3701
|
+
</dl>
|
|
3702
|
+
|
|
3703
|
+
<dl>
|
|
3704
|
+
<dd>
|
|
3705
|
+
|
|
3706
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
1545
3707
|
|
|
1546
3708
|
</dd>
|
|
1547
3709
|
</dl>
|
|
@@ -1553,8 +3715,8 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
1553
3715
|
</dl>
|
|
1554
3716
|
</details>
|
|
1555
3717
|
|
|
1556
|
-
## Agent API/
|
|
1557
|
-
<details><summary><code>client.
|
|
3718
|
+
## Agent API/Context
|
|
3719
|
+
<details><summary><code>client.agentApiContext.<a href="/src/api/resources/agentApiContext/client/Client.ts">getAgentChatContext</a>(chat_id, { ...params }) -> Band.GetAgentChatContextResponse</code></summary>
|
|
1558
3720
|
<dl>
|
|
1559
3721
|
<dd>
|
|
1560
3722
|
|
|
@@ -1566,8 +3728,22 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
1566
3728
|
<dl>
|
|
1567
3729
|
<dd>
|
|
1568
3730
|
|
|
1569
|
-
Returns
|
|
1570
|
-
|
|
3731
|
+
Returns all messages relevant to the agent for execution context/rehydration.
|
|
3732
|
+
|
|
3733
|
+
This includes:
|
|
3734
|
+
- All messages the agent sent (any type: text, tool_call, tool_result, thought, etc.)
|
|
3735
|
+
- All text messages that @mention the agent
|
|
3736
|
+
|
|
3737
|
+
Use this endpoint to load the complete context an external agent needs to resume execution.
|
|
3738
|
+
|
|
3739
|
+
Messages are returned in chronological order (oldest first).
|
|
3740
|
+
|
|
3741
|
+
## Pagination
|
|
3742
|
+
|
|
3743
|
+
Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
3744
|
+
`metadata` includes `next_cursor` and `has_more`.
|
|
3745
|
+
|
|
3746
|
+
`page` and `page_size` are deprecated and will be removed in API 2.0.0 (2026-10-01).
|
|
1571
3747
|
</dd>
|
|
1572
3748
|
</dl>
|
|
1573
3749
|
</dd>
|
|
@@ -1582,7 +3758,12 @@ Also serves as connection validation - if this returns 200, your API key is vali
|
|
|
1582
3758
|
<dd>
|
|
1583
3759
|
|
|
1584
3760
|
```typescript
|
|
1585
|
-
await client.
|
|
3761
|
+
await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
3762
|
+
cursor: "cursor",
|
|
3763
|
+
limit: 1,
|
|
3764
|
+
page: 1,
|
|
3765
|
+
page_size: 1
|
|
3766
|
+
});
|
|
1586
3767
|
|
|
1587
3768
|
```
|
|
1588
3769
|
</dd>
|
|
@@ -1598,7 +3779,23 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
1598
3779
|
<dl>
|
|
1599
3780
|
<dd>
|
|
1600
3781
|
|
|
1601
|
-
**
|
|
3782
|
+
**chat_id:** `string` — Chat Room ID
|
|
3783
|
+
|
|
3784
|
+
</dd>
|
|
3785
|
+
</dl>
|
|
3786
|
+
|
|
3787
|
+
<dl>
|
|
3788
|
+
<dd>
|
|
3789
|
+
|
|
3790
|
+
**request:** `Band.GetAgentChatContextRequest`
|
|
3791
|
+
|
|
3792
|
+
</dd>
|
|
3793
|
+
</dl>
|
|
3794
|
+
|
|
3795
|
+
<dl>
|
|
3796
|
+
<dd>
|
|
3797
|
+
|
|
3798
|
+
**requestOptions:** `AgentApiContextClient.RequestOptions`
|
|
1602
3799
|
|
|
1603
3800
|
</dd>
|
|
1604
3801
|
</dl>
|
|
@@ -1610,8 +3807,8 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
1610
3807
|
</dl>
|
|
1611
3808
|
</details>
|
|
1612
3809
|
|
|
1613
|
-
## Agent API/
|
|
1614
|
-
<details><summary><code>client.
|
|
3810
|
+
## Agent API/Chats
|
|
3811
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">getAgentChat</a>(id) -> Band.GetAgentChatResponse</code></summary>
|
|
1615
3812
|
<dl>
|
|
1616
3813
|
<dd>
|
|
1617
3814
|
|
|
@@ -1623,12 +3820,7 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
1623
3820
|
<dl>
|
|
1624
3821
|
<dd>
|
|
1625
3822
|
|
|
1626
|
-
|
|
1627
|
-
- Memories about the specified subject (cross-agent sharing)
|
|
1628
|
-
- Organization-wide shared memories
|
|
1629
|
-
|
|
1630
|
-
Use `scope` parameter to filter by visibility.
|
|
1631
|
-
Use `content_query` for full-text search across memory content.
|
|
3823
|
+
Returns details of a specific chat room where the agent is a participant
|
|
1632
3824
|
</dd>
|
|
1633
3825
|
</dl>
|
|
1634
3826
|
</dd>
|
|
@@ -1643,16 +3835,7 @@ Use `content_query` for full-text search across memory content.
|
|
|
1643
3835
|
<dd>
|
|
1644
3836
|
|
|
1645
3837
|
```typescript
|
|
1646
|
-
await client.
|
|
1647
|
-
subject_id: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
1648
|
-
scope: "subject",
|
|
1649
|
-
system: "long_term",
|
|
1650
|
-
type: "semantic",
|
|
1651
|
-
segment: "user",
|
|
1652
|
-
content_query: "prefers SUV",
|
|
1653
|
-
page_size: 1,
|
|
1654
|
-
status: "active"
|
|
1655
|
-
});
|
|
3838
|
+
await client.agentApiChats.getAgentChat("id");
|
|
1656
3839
|
|
|
1657
3840
|
```
|
|
1658
3841
|
</dd>
|
|
@@ -1668,7 +3851,7 @@ await client.agentApiMemories.listAgentMemories({
|
|
|
1668
3851
|
<dl>
|
|
1669
3852
|
<dd>
|
|
1670
3853
|
|
|
1671
|
-
**
|
|
3854
|
+
**id:** `string` — Chat Room ID
|
|
1672
3855
|
|
|
1673
3856
|
</dd>
|
|
1674
3857
|
</dl>
|
|
@@ -1676,7 +3859,7 @@ await client.agentApiMemories.listAgentMemories({
|
|
|
1676
3859
|
<dl>
|
|
1677
3860
|
<dd>
|
|
1678
3861
|
|
|
1679
|
-
**requestOptions:** `
|
|
3862
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
1680
3863
|
|
|
1681
3864
|
</dd>
|
|
1682
3865
|
</dl>
|
|
@@ -1688,7 +3871,7 @@ await client.agentApiMemories.listAgentMemories({
|
|
|
1688
3871
|
</dl>
|
|
1689
3872
|
</details>
|
|
1690
3873
|
|
|
1691
|
-
<details><summary><code>client.
|
|
3874
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">listAgentChats</a>({ ...params }) -> Band.ListAgentChatsResponse</code></summary>
|
|
1692
3875
|
<dl>
|
|
1693
3876
|
<dd>
|
|
1694
3877
|
|
|
@@ -1700,12 +3883,7 @@ await client.agentApiMemories.listAgentMemories({
|
|
|
1700
3883
|
<dl>
|
|
1701
3884
|
<dd>
|
|
1702
3885
|
|
|
1703
|
-
|
|
1704
|
-
- Associated with the authenticated agent as the source
|
|
1705
|
-
- Scoped to the subject (for cross-agent sharing) or organization (for shared knowledge)
|
|
1706
|
-
|
|
1707
|
-
For subject-scoped memories, provide a `subject_id` to associate the memory with a specific user or agent.
|
|
1708
|
-
For organization-scoped memories, omit `subject_id` - the memory will be visible to all agents in the org.
|
|
3886
|
+
Lists chat rooms where the current agent is a participant
|
|
1709
3887
|
</dd>
|
|
1710
3888
|
</dl>
|
|
1711
3889
|
</dd>
|
|
@@ -1720,14 +3898,9 @@ For organization-scoped memories, omit `subject_id` - the memory will be visible
|
|
|
1720
3898
|
<dd>
|
|
1721
3899
|
|
|
1722
3900
|
```typescript
|
|
1723
|
-
await client.
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
segment: "user",
|
|
1727
|
-
system: "sensory",
|
|
1728
|
-
thought: "thought",
|
|
1729
|
-
type: "iconic"
|
|
1730
|
-
}
|
|
3901
|
+
await client.agentApiChats.listAgentChats({
|
|
3902
|
+
page: 1,
|
|
3903
|
+
page_size: 1
|
|
1731
3904
|
});
|
|
1732
3905
|
|
|
1733
3906
|
```
|
|
@@ -1744,7 +3917,7 @@ await client.agentApiMemories.createAgentMemory({
|
|
|
1744
3917
|
<dl>
|
|
1745
3918
|
<dd>
|
|
1746
3919
|
|
|
1747
|
-
**request:** `Band.
|
|
3920
|
+
**request:** `Band.ListAgentChatsRequest`
|
|
1748
3921
|
|
|
1749
3922
|
</dd>
|
|
1750
3923
|
</dl>
|
|
@@ -1752,7 +3925,7 @@ await client.agentApiMemories.createAgentMemory({
|
|
|
1752
3925
|
<dl>
|
|
1753
3926
|
<dd>
|
|
1754
3927
|
|
|
1755
|
-
**requestOptions:** `
|
|
3928
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
1756
3929
|
|
|
1757
3930
|
</dd>
|
|
1758
3931
|
</dl>
|
|
@@ -1764,7 +3937,7 @@ await client.agentApiMemories.createAgentMemory({
|
|
|
1764
3937
|
</dl>
|
|
1765
3938
|
</details>
|
|
1766
3939
|
|
|
1767
|
-
<details><summary><code>client.
|
|
3940
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">createAgentChat</a>({ ...params }) -> Band.CreateAgentChatResponse</code></summary>
|
|
1768
3941
|
<dl>
|
|
1769
3942
|
<dd>
|
|
1770
3943
|
|
|
@@ -1776,7 +3949,7 @@ await client.agentApiMemories.createAgentMemory({
|
|
|
1776
3949
|
<dl>
|
|
1777
3950
|
<dd>
|
|
1778
3951
|
|
|
1779
|
-
|
|
3952
|
+
Creates a new chat room with the agent as owner
|
|
1780
3953
|
</dd>
|
|
1781
3954
|
</dl>
|
|
1782
3955
|
</dd>
|
|
@@ -1791,7 +3964,9 @@ Retrieves a specific memory by ID if accessible to the agent.
|
|
|
1791
3964
|
<dd>
|
|
1792
3965
|
|
|
1793
3966
|
```typescript
|
|
1794
|
-
await client.
|
|
3967
|
+
await client.agentApiChats.createAgentChat({
|
|
3968
|
+
chat: {}
|
|
3969
|
+
});
|
|
1795
3970
|
|
|
1796
3971
|
```
|
|
1797
3972
|
</dd>
|
|
@@ -1807,7 +3982,7 @@ await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d
|
|
|
1807
3982
|
<dl>
|
|
1808
3983
|
<dd>
|
|
1809
3984
|
|
|
1810
|
-
**
|
|
3985
|
+
**request:** `Band.CreateAgentChatRequest`
|
|
1811
3986
|
|
|
1812
3987
|
</dd>
|
|
1813
3988
|
</dl>
|
|
@@ -1815,7 +3990,7 @@ await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d
|
|
|
1815
3990
|
<dl>
|
|
1816
3991
|
<dd>
|
|
1817
3992
|
|
|
1818
|
-
**requestOptions:** `
|
|
3993
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
1819
3994
|
|
|
1820
3995
|
</dd>
|
|
1821
3996
|
</dl>
|
|
@@ -1827,7 +4002,8 @@ await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d
|
|
|
1827
4002
|
</dl>
|
|
1828
4003
|
</details>
|
|
1829
4004
|
|
|
1830
|
-
|
|
4005
|
+
## Human API/Profile
|
|
4006
|
+
<details><summary><code>client.humanApiProfile.<a href="/src/api/resources/humanApiProfile/client/Client.ts">getMyProfile</a>() -> Band.GetMyProfileResponse</code></summary>
|
|
1831
4007
|
<dl>
|
|
1832
4008
|
<dd>
|
|
1833
4009
|
|
|
@@ -1839,10 +4015,7 @@ await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d
|
|
|
1839
4015
|
<dl>
|
|
1840
4016
|
<dd>
|
|
1841
4017
|
|
|
1842
|
-
|
|
1843
|
-
Archived memories can be restored later by humans.
|
|
1844
|
-
|
|
1845
|
-
Only the source agent can archive.
|
|
4018
|
+
Returns your profile details
|
|
1846
4019
|
</dd>
|
|
1847
4020
|
</dl>
|
|
1848
4021
|
</dd>
|
|
@@ -1857,7 +4030,7 @@ Only the source agent can archive.
|
|
|
1857
4030
|
<dd>
|
|
1858
4031
|
|
|
1859
4032
|
```typescript
|
|
1860
|
-
await client.
|
|
4033
|
+
await client.humanApiProfile.getMyProfile();
|
|
1861
4034
|
|
|
1862
4035
|
```
|
|
1863
4036
|
</dd>
|
|
@@ -1873,15 +4046,7 @@ await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015
|
|
|
1873
4046
|
<dl>
|
|
1874
4047
|
<dd>
|
|
1875
4048
|
|
|
1876
|
-
**
|
|
1877
|
-
|
|
1878
|
-
</dd>
|
|
1879
|
-
</dl>
|
|
1880
|
-
|
|
1881
|
-
<dl>
|
|
1882
|
-
<dd>
|
|
1883
|
-
|
|
1884
|
-
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
4049
|
+
**requestOptions:** `HumanApiProfileClient.RequestOptions`
|
|
1885
4050
|
|
|
1886
4051
|
</dd>
|
|
1887
4052
|
</dl>
|
|
@@ -1893,7 +4058,7 @@ await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015
|
|
|
1893
4058
|
</dl>
|
|
1894
4059
|
</details>
|
|
1895
4060
|
|
|
1896
|
-
<details><summary><code>client.
|
|
4061
|
+
<details><summary><code>client.humanApiProfile.<a href="/src/api/resources/humanApiProfile/client/Client.ts">updateMyProfile</a>({ ...params }) -> Band.UpdateMyProfileResponse</code></summary>
|
|
1897
4062
|
<dl>
|
|
1898
4063
|
<dd>
|
|
1899
4064
|
|
|
@@ -1905,10 +4070,7 @@ await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015
|
|
|
1905
4070
|
<dl>
|
|
1906
4071
|
<dd>
|
|
1907
4072
|
|
|
1908
|
-
|
|
1909
|
-
The memory remains for audit trail but won't appear in normal queries.
|
|
1910
|
-
|
|
1911
|
-
Only the source agent can supersede.
|
|
4073
|
+
Updates your profile details
|
|
1912
4074
|
</dd>
|
|
1913
4075
|
</dl>
|
|
1914
4076
|
</dd>
|
|
@@ -1923,7 +4085,9 @@ Only the source agent can supersede.
|
|
|
1923
4085
|
<dd>
|
|
1924
4086
|
|
|
1925
4087
|
```typescript
|
|
1926
|
-
await client.
|
|
4088
|
+
await client.humanApiProfile.updateMyProfile({
|
|
4089
|
+
user: {}
|
|
4090
|
+
});
|
|
1927
4091
|
|
|
1928
4092
|
```
|
|
1929
4093
|
</dd>
|
|
@@ -1939,7 +4103,7 @@ await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c460
|
|
|
1939
4103
|
<dl>
|
|
1940
4104
|
<dd>
|
|
1941
4105
|
|
|
1942
|
-
**
|
|
4106
|
+
**request:** `Band.UpdateMyProfileRequest`
|
|
1943
4107
|
|
|
1944
4108
|
</dd>
|
|
1945
4109
|
</dl>
|
|
@@ -1947,7 +4111,7 @@ await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c460
|
|
|
1947
4111
|
<dl>
|
|
1948
4112
|
<dd>
|
|
1949
4113
|
|
|
1950
|
-
**requestOptions:** `
|
|
4114
|
+
**requestOptions:** `HumanApiProfileClient.RequestOptions`
|
|
1951
4115
|
|
|
1952
4116
|
</dd>
|
|
1953
4117
|
</dl>
|
|
@@ -1959,8 +4123,8 @@ await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c460
|
|
|
1959
4123
|
</dl>
|
|
1960
4124
|
</details>
|
|
1961
4125
|
|
|
1962
|
-
## Agent API/
|
|
1963
|
-
<details><summary><code>client.
|
|
4126
|
+
## Agent API/Activity
|
|
4127
|
+
<details><summary><code>client.agentApiActivity.<a href="/src/api/resources/agentApiActivity/client/Client.ts">reportAgentChatActivity</a>(chat_id, { ...params }) -> Band.ReportAgentChatActivityResponse</code></summary>
|
|
1964
4128
|
<dl>
|
|
1965
4129
|
<dd>
|
|
1966
4130
|
|
|
@@ -1972,8 +4136,16 @@ await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c460
|
|
|
1972
4136
|
<dl>
|
|
1973
4137
|
<dd>
|
|
1974
4138
|
|
|
1975
|
-
|
|
1976
|
-
|
|
4139
|
+
Reports whether the agent is actively working ("Reasoning…") on its execution in
|
|
4140
|
+
this chat room, driving a real-time indicator on chat surfaces.
|
|
4141
|
+
|
|
4142
|
+
- `{ "working": true }` — the agent is working. Re-send on a keep-alive cadence
|
|
4143
|
+
(~every 3 s); the platform expires the indicator ~10 s after the last report, so
|
|
4144
|
+
a crashed or hung agent clears automatically.
|
|
4145
|
+
- `{ "working": false }` — the agent finished; the indicator clears immediately.
|
|
4146
|
+
|
|
4147
|
+
Scoped to the agent's own active execution in the room (resolved server-side); a
|
|
4148
|
+
foreign room or one with no active execution returns 404.
|
|
1977
4149
|
</dd>
|
|
1978
4150
|
</dl>
|
|
1979
4151
|
</dd>
|
|
@@ -1988,10 +4160,8 @@ Includes sibling agents (same owner) and global agents. Excludes self.
|
|
|
1988
4160
|
<dd>
|
|
1989
4161
|
|
|
1990
4162
|
```typescript
|
|
1991
|
-
await client.
|
|
1992
|
-
|
|
1993
|
-
page: 1,
|
|
1994
|
-
page_size: 1
|
|
4163
|
+
await client.agentApiActivity.reportAgentChatActivity("chat_id", {
|
|
4164
|
+
working: true
|
|
1995
4165
|
});
|
|
1996
4166
|
|
|
1997
4167
|
```
|
|
@@ -2008,7 +4178,7 @@ await client.agentApiPeers.listAgentPeers({
|
|
|
2008
4178
|
<dl>
|
|
2009
4179
|
<dd>
|
|
2010
4180
|
|
|
2011
|
-
**
|
|
4181
|
+
**chat_id:** `string` — Chat Room ID
|
|
2012
4182
|
|
|
2013
4183
|
</dd>
|
|
2014
4184
|
</dl>
|
|
@@ -2016,7 +4186,15 @@ await client.agentApiPeers.listAgentPeers({
|
|
|
2016
4186
|
<dl>
|
|
2017
4187
|
<dd>
|
|
2018
4188
|
|
|
2019
|
-
**
|
|
4189
|
+
**request:** `Band.ReportAgentChatActivityRequest`
|
|
4190
|
+
|
|
4191
|
+
</dd>
|
|
4192
|
+
</dl>
|
|
4193
|
+
|
|
4194
|
+
<dl>
|
|
4195
|
+
<dd>
|
|
4196
|
+
|
|
4197
|
+
**requestOptions:** `AgentApiActivityClient.RequestOptions`
|
|
2020
4198
|
|
|
2021
4199
|
</dd>
|
|
2022
4200
|
</dl>
|