@band-ai/rest-client 0.0.113 → 0.0.117
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 +106 -39
- package/dist/cjs/BaseClient.d.ts +42 -0
- package/dist/cjs/BaseClient.js +77 -0
- package/dist/cjs/Client.d.ts +50 -0
- package/dist/cjs/Client.js +123 -0
- package/dist/cjs/api/errors/BadRequestError.d.ts +6 -0
- package/dist/cjs/api/errors/BadRequestError.js +54 -0
- package/dist/cjs/api/errors/ConflictError.d.ts +6 -0
- package/dist/cjs/api/errors/ConflictError.js +54 -0
- package/dist/cjs/api/errors/ForbiddenError.d.ts +6 -0
- package/dist/cjs/api/errors/ForbiddenError.js +54 -0
- package/dist/cjs/api/errors/NotFoundError.d.ts +6 -0
- package/dist/cjs/api/errors/NotFoundError.js +54 -0
- package/dist/cjs/api/errors/UnauthorizedError.d.ts +6 -0
- package/dist/cjs/api/errors/UnauthorizedError.js +54 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +6 -0
- package/dist/cjs/api/errors/UnprocessableEntityError.js +54 -0
- package/dist/cjs/api/errors/index.d.ts +6 -0
- package/dist/cjs/api/errors/index.js +22 -0
- package/dist/cjs/api/index.d.ts +3 -0
- package/dist/cjs/api/index.js +19 -0
- package/dist/cjs/api/resources/agentApiChats/client/Client.d.ts +65 -0
- package/dist/cjs/api/resources/agentApiChats/client/Client.js +238 -0
- package/dist/cjs/api/resources/agentApiChats/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiChats/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/CreateAgentChatRequest.d.ts +10 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/CreateAgentChatRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/ListAgentChatsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/ListAgentChatsRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiChats/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiChats/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiChats/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiChats/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiChats/index.js +18 -0
- package/dist/cjs/api/resources/agentApiChats/types/CreateAgentChatResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiChats/types/CreateAgentChatResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiChats/types/GetAgentChatResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiChats/types/GetAgentChatResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiChats/types/ListAgentChatsResponse.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiChats/types/ListAgentChatsResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiChats/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/agentApiChats/types/index.js +19 -0
- package/dist/cjs/api/resources/agentApiContacts/client/Client.d.ts +112 -0
- package/dist/cjs/api/resources/agentApiContacts/client/Client.js +385 -0
- package/dist/cjs/api/resources/agentApiContacts/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiContacts/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/AddAgentContactRequest.d.ts +11 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/AddAgentContactRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/ListAgentContactRequestsRequest.d.ts +17 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/ListAgentContactRequestsRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/ListAgentContactsRequest.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/ListAgentContactsRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/RemoveAgentContactRequest.d.ts +10 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/RemoveAgentContactRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/RespondToAgentContactRequestRequest.d.ts +21 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/RespondToAgentContactRequestRequest.js +12 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/agentApiContacts/client/requests/index.js +5 -0
- package/dist/cjs/api/resources/agentApiContacts/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiContacts/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiContacts/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiContacts/index.js +18 -0
- package/dist/cjs/api/resources/agentApiContacts/types/AddAgentContactResponse.d.ts +16 -0
- package/dist/cjs/api/resources/agentApiContacts/types/AddAgentContactResponse.js +14 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactRequestsRequestSentStatus.d.ts +8 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactRequestsRequestSentStatus.js +11 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactRequestsResponse.d.ts +35 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactRequestsResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactsResponse.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiContacts/types/ListAgentContactsResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/types/RemoveAgentContactResponse.d.ts +8 -0
- package/dist/cjs/api/resources/agentApiContacts/types/RemoveAgentContactResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiContacts/types/RespondToAgentContactRequestResponse.d.ts +17 -0
- package/dist/cjs/api/resources/agentApiContacts/types/RespondToAgentContactRequestResponse.js +15 -0
- package/dist/cjs/api/resources/agentApiContacts/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/agentApiContacts/types/index.js +22 -0
- package/dist/cjs/api/resources/agentApiContext/client/Client.d.ts +53 -0
- package/dist/cjs/api/resources/agentApiContext/client/Client.js +151 -0
- package/dist/cjs/api/resources/agentApiContext/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiContext/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiContext/client/requests/GetAgentChatContextRequest.d.ts +19 -0
- package/dist/cjs/api/resources/agentApiContext/client/requests/GetAgentChatContextRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiContext/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiContext/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiContext/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiContext/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiContext/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiContext/index.js +18 -0
- package/dist/cjs/api/resources/agentApiContext/types/GetAgentChatContextResponse.d.ts +37 -0
- package/dist/cjs/api/resources/agentApiContext/types/GetAgentChatContextResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiContext/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiContext/types/index.js +17 -0
- package/dist/cjs/api/resources/agentApiEvents/client/Client.d.ts +49 -0
- package/dist/cjs/api/resources/agentApiEvents/client/Client.js +139 -0
- package/dist/cjs/api/resources/agentApiEvents/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiEvents/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiEvents/client/requests/CreateAgentChatEventRequest.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiEvents/client/requests/CreateAgentChatEventRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiEvents/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiEvents/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiEvents/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiEvents/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiEvents/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiEvents/index.js +18 -0
- package/dist/cjs/api/resources/agentApiEvents/types/CreateAgentChatEventResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiEvents/types/CreateAgentChatEventResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiEvents/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiEvents/types/index.js +17 -0
- package/dist/cjs/api/resources/agentApiIdentity/client/Client.d.ts +30 -0
- package/dist/cjs/api/resources/agentApiIdentity/client/Client.js +113 -0
- package/dist/cjs/api/resources/agentApiIdentity/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiIdentity/client/index.js +2 -0
- package/dist/cjs/api/resources/agentApiIdentity/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiIdentity/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiIdentity/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiIdentity/index.js +18 -0
- package/dist/cjs/api/resources/agentApiIdentity/types/GetAgentMeResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiIdentity/types/GetAgentMeResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiIdentity/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiIdentity/types/index.js +17 -0
- package/dist/cjs/api/resources/agentApiMemories/client/Client.d.ts +120 -0
- package/dist/cjs/api/resources/agentApiMemories/client/Client.js +371 -0
- package/dist/cjs/api/resources/agentApiMemories/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiMemories/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/CreateAgentMemoryRequest.d.ts +16 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/CreateAgentMemoryRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/ListAgentMemoriesRequest.d.ts +31 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/ListAgentMemoriesRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiMemories/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiMemories/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiMemories/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiMemories/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiMemories/index.js +18 -0
- package/dist/cjs/api/resources/agentApiMemories/types/ArchiveAgentMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMemories/types/ArchiveAgentMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/types/CreateAgentMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMemories/types/CreateAgentMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/types/GetAgentMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMemories/types/GetAgentMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/types/ListAgentMemoriesResponse.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiMemories/types/ListAgentMemoriesResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/types/SupersedeAgentMemoryResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMemories/types/SupersedeAgentMemoryResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMemories/types/index.d.ts +5 -0
- package/dist/cjs/api/resources/agentApiMemories/types/index.js +21 -0
- package/dist/cjs/api/resources/agentApiMessages/client/Client.d.ts +316 -0
- package/dist/cjs/api/resources/agentApiMessages/client/Client.js +633 -0
- package/dist/cjs/api/resources/agentApiMessages/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiMessages/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/CreateAgentChatMessageRequest.d.ts +15 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/CreateAgentChatMessageRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/ListAgentMessagesRequest.d.ts +23 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/ListAgentMessagesRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/MarkAgentMessageFailedRequest.d.ts +10 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/MarkAgentMessageFailedRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/index.d.ts +3 -0
- package/dist/cjs/api/resources/agentApiMessages/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiMessages/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiMessages/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiMessages/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiMessages/index.js +18 -0
- package/dist/cjs/api/resources/agentApiMessages/types/CreateAgentChatMessageResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMessages/types/CreateAgentChatMessageResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/GetAgentNextMessageResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMessages/types/GetAgentNextMessageResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/ListAgentMessagesRequestStatus.d.ts +8 -0
- package/dist/cjs/api/resources/agentApiMessages/types/ListAgentMessagesRequestStatus.js +11 -0
- package/dist/cjs/api/resources/agentApiMessages/types/ListAgentMessagesResponse.d.ts +25 -0
- package/dist/cjs/api/resources/agentApiMessages/types/ListAgentMessagesResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageFailedResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageFailedResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageProcessedResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageProcessedResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageProcessingResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiMessages/types/MarkAgentMessageProcessingResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiMessages/types/index.d.ts +7 -0
- package/dist/cjs/api/resources/agentApiMessages/types/index.js +23 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/Client.d.ts +73 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/Client.js +247 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/requests/AddAgentChatParticipantRequest.d.ts +12 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/requests/AddAgentChatParticipantRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiParticipants/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiParticipants/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiParticipants/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiParticipants/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiParticipants/index.js +18 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/AddAgentChatParticipantResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/AddAgentChatParticipantResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/ListAgentChatParticipantsResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/ListAgentChatParticipantsResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/RemoveAgentChatParticipantResponse.d.ts +4 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/RemoveAgentChatParticipantResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/agentApiParticipants/types/index.js +19 -0
- package/dist/cjs/api/resources/agentApiPeers/client/Client.d.ts +35 -0
- package/dist/cjs/api/resources/agentApiPeers/client/Client.js +128 -0
- package/dist/cjs/api/resources/agentApiPeers/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiPeers/client/index.js +17 -0
- package/dist/cjs/api/resources/agentApiPeers/client/requests/ListAgentPeersRequest.d.ts +16 -0
- package/dist/cjs/api/resources/agentApiPeers/client/requests/ListAgentPeersRequest.js +3 -0
- package/dist/cjs/api/resources/agentApiPeers/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiPeers/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/agentApiPeers/exports.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiPeers/exports.js +21 -0
- package/dist/cjs/api/resources/agentApiPeers/index.d.ts +2 -0
- package/dist/cjs/api/resources/agentApiPeers/index.js +18 -0
- package/dist/cjs/api/resources/agentApiPeers/types/ListAgentPeersResponse.d.ts +13 -0
- package/dist/cjs/api/resources/agentApiPeers/types/ListAgentPeersResponse.js +3 -0
- package/dist/cjs/api/resources/agentApiPeers/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/agentApiPeers/types/index.js +17 -0
- package/dist/cjs/api/resources/index.d.ts +26 -0
- package/dist/cjs/api/resources/index.js +65 -0
- package/dist/cjs/api/types/AgentContact.d.ts +30 -0
- package/dist/cjs/api/types/AgentContact.js +12 -0
- package/dist/cjs/api/types/AgentMe.d.ts +23 -0
- package/dist/cjs/api/types/AgentMe.js +3 -0
- package/dist/cjs/api/types/AgentMemory.d.ts +71 -0
- package/dist/cjs/api/types/AgentMemory.js +40 -0
- package/dist/cjs/api/types/AgentMemoryCreateRequest.d.ts +63 -0
- package/dist/cjs/api/types/AgentMemoryCreateRequest.js +34 -0
- package/dist/cjs/api/types/ChatEventMessageType.d.ts +19 -0
- package/dist/cjs/api/types/ChatEventMessageType.js +22 -0
- package/dist/cjs/api/types/ChatEventRequest.d.ts +22 -0
- package/dist/cjs/api/types/ChatEventRequest.js +3 -0
- package/dist/cjs/api/types/ChatMessage.d.ts +25 -0
- package/dist/cjs/api/types/ChatMessage.js +3 -0
- package/dist/cjs/api/types/ChatMessageRequest.d.ts +22 -0
- package/dist/cjs/api/types/ChatMessageRequest.js +3 -0
- package/dist/cjs/api/types/ChatParticipant.d.ts +25 -0
- package/dist/cjs/api/types/ChatParticipant.js +12 -0
- package/dist/cjs/api/types/ChatRoom.d.ts +15 -0
- package/dist/cjs/api/types/ChatRoom.js +3 -0
- package/dist/cjs/api/types/ChatRoomRequest.d.ts +9 -0
- package/dist/cjs/api/types/ChatRoomRequest.js +3 -0
- package/dist/cjs/api/types/Error_.d.ts +18 -0
- package/dist/cjs/api/types/Error_.js +3 -0
- package/dist/cjs/api/types/EventCreatedResponse.d.ts +11 -0
- package/dist/cjs/api/types/EventCreatedResponse.js +3 -0
- package/dist/cjs/api/types/MessageSentResponse.d.ts +24 -0
- package/dist/cjs/api/types/MessageSentResponse.js +3 -0
- package/dist/cjs/api/types/MessageStatusResponse.d.ts +22 -0
- package/dist/cjs/api/types/MessageStatusResponse.js +13 -0
- package/dist/cjs/api/types/ParticipantRequest.d.ts +18 -0
- package/dist/cjs/api/types/ParticipantRequest.js +13 -0
- package/dist/cjs/api/types/ParticipantRole.d.ts +13 -0
- package/dist/cjs/api/types/ParticipantRole.js +16 -0
- package/dist/cjs/api/types/Peer.d.ts +39 -0
- package/dist/cjs/api/types/Peer.js +17 -0
- package/dist/cjs/api/types/ReceivedContactRequest.d.ts +22 -0
- package/dist/cjs/api/types/ReceivedContactRequest.js +13 -0
- package/dist/cjs/api/types/SentContactRequest.d.ts +22 -0
- package/dist/cjs/api/types/SentContactRequest.js +13 -0
- package/dist/cjs/api/types/ValidationError.d.ts +18 -0
- package/dist/cjs/api/types/ValidationError.js +3 -0
- package/dist/cjs/api/types/index.d.ts +21 -0
- package/dist/cjs/api/types/index.js +37 -0
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +20 -0
- package/dist/cjs/auth/HeaderAuthProvider.js +80 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +8 -0
- package/dist/cjs/core/auth/AuthProvider.js +9 -0
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +33 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +11 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +17 -0
- package/dist/cjs/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/cjs/core/fetcher/APIResponse.js +2 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +19 -0
- package/dist/cjs/core/fetcher/BinaryResponse.js +17 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/cjs/core/fetcher/EndpointMetadata.js +2 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/cjs/core/fetcher/EndpointSupplier.js +22 -0
- package/dist/cjs/core/fetcher/Fetcher.d.ts +56 -0
- package/dist/cjs/core/fetcher/Fetcher.js +327 -0
- package/dist/cjs/core/fetcher/Headers.d.ts +2 -0
- package/dist/cjs/core/fetcher/Headers.js +84 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/cjs/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/cjs/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/cjs/core/fetcher/RawResponse.js +44 -0
- package/dist/cjs/core/fetcher/Supplier.d.ts +4 -0
- package/dist/cjs/core/fetcher/Supplier.js +22 -0
- package/dist/cjs/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/cjs/core/fetcher/createRequestUrl.js +8 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +45 -0
- package/dist/cjs/core/fetcher/getFetchFn.d.ts +1 -0
- package/dist/cjs/core/fetcher/getFetchFn.js +17 -0
- package/dist/cjs/core/fetcher/getHeader.d.ts +1 -0
- package/dist/cjs/core/fetcher/getHeader.js +11 -0
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/cjs/core/fetcher/getRequestBody.js +27 -0
- package/dist/cjs/core/fetcher/getResponseBody.d.ts +1 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +69 -0
- package/dist/cjs/core/fetcher/index.d.ts +13 -0
- package/dist/cjs/core/fetcher/index.js +19 -0
- package/dist/cjs/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/cjs/core/fetcher/makePassthroughRequest.js +135 -0
- package/dist/cjs/core/fetcher/makeRequest.d.ts +6 -0
- package/dist/cjs/core/fetcher/makeRequest.js +61 -0
- package/dist/cjs/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/cjs/core/fetcher/requestWithRetries.js +70 -0
- package/dist/cjs/core/fetcher/signals.d.ts +5 -0
- package/dist/cjs/core/fetcher/signals.js +24 -0
- package/dist/cjs/core/headers.d.ts +2 -0
- package/dist/cjs/core/headers.js +31 -0
- package/dist/cjs/core/index.d.ts +6 -0
- package/dist/cjs/core/index.js +45 -0
- package/dist/cjs/core/json.d.ts +15 -0
- package/dist/cjs/core/json.js +24 -0
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/runtime/index.d.ts +1 -0
- package/dist/cjs/core/runtime/index.js +5 -0
- package/dist/cjs/core/runtime/runtime.d.ts +9 -0
- package/dist/cjs/core/runtime/runtime.js +104 -0
- package/dist/cjs/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/cjs/core/url/QueryStringBuilder.js +83 -0
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +4 -0
- package/dist/cjs/core/url/index.js +11 -0
- package/dist/cjs/core/url/join.d.ts +1 -0
- package/dist/cjs/core/url/join.js +68 -0
- package/dist/cjs/core/url/qs.d.ts +7 -0
- package/dist/cjs/core/url/qs.js +76 -0
- package/dist/cjs/environments.d.ts +4 -0
- package/dist/cjs/environments.js +7 -0
- package/dist/cjs/errors/BandError.d.ts +14 -0
- package/dist/cjs/errors/BandError.js +35 -0
- package/dist/cjs/errors/BandTimeoutError.d.ts +6 -0
- package/dist/cjs/errors/BandTimeoutError.js +18 -0
- package/dist/cjs/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/cjs/errors/handleNonStatusCodeError.js +68 -0
- package/dist/cjs/errors/index.d.ts +2 -0
- package/dist/cjs/errors/index.js +7 -0
- package/dist/cjs/exports.d.ts +1 -0
- package/dist/cjs/exports.js +17 -0
- package/dist/cjs/index.d.ts +6 -0
- package/dist/cjs/index.js +48 -0
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +4 -0
- package/dist/esm/BaseClient.d.mts +42 -0
- package/dist/esm/BaseClient.mjs +40 -0
- package/dist/esm/Client.d.mts +50 -0
- package/dist/esm/Client.mjs +86 -0
- package/dist/esm/api/errors/BadRequestError.d.mts +6 -0
- package/dist/esm/api/errors/BadRequestError.mjs +17 -0
- package/dist/esm/api/errors/ConflictError.d.mts +6 -0
- package/dist/esm/api/errors/ConflictError.mjs +17 -0
- package/dist/esm/api/errors/ForbiddenError.d.mts +6 -0
- package/dist/esm/api/errors/ForbiddenError.mjs +17 -0
- package/dist/esm/api/errors/NotFoundError.d.mts +6 -0
- package/dist/esm/api/errors/NotFoundError.mjs +17 -0
- package/dist/esm/api/errors/UnauthorizedError.d.mts +6 -0
- package/dist/esm/api/errors/UnauthorizedError.mjs +17 -0
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +6 -0
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +17 -0
- package/dist/esm/api/errors/index.d.mts +6 -0
- package/dist/esm/api/errors/index.mjs +6 -0
- package/dist/esm/api/index.d.mts +3 -0
- package/dist/esm/api/index.mjs +3 -0
- package/dist/esm/api/resources/agentApiChats/client/Client.d.mts +65 -0
- package/dist/esm/api/resources/agentApiChats/client/Client.mjs +201 -0
- package/dist/esm/api/resources/agentApiChats/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiChats/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/CreateAgentChatRequest.d.mts +10 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/CreateAgentChatRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/ListAgentChatsRequest.d.mts +13 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/ListAgentChatsRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiChats/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiChats/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiChats/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiChats/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiChats/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/types/CreateAgentChatResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiChats/types/CreateAgentChatResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/types/GetAgentChatResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiChats/types/GetAgentChatResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/types/ListAgentChatsResponse.d.mts +13 -0
- package/dist/esm/api/resources/agentApiChats/types/ListAgentChatsResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiChats/types/index.d.mts +3 -0
- package/dist/esm/api/resources/agentApiChats/types/index.mjs +3 -0
- package/dist/esm/api/resources/agentApiContacts/client/Client.d.mts +112 -0
- package/dist/esm/api/resources/agentApiContacts/client/Client.mjs +348 -0
- package/dist/esm/api/resources/agentApiContacts/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiContacts/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/AddAgentContactRequest.d.mts +11 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/AddAgentContactRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/ListAgentContactRequestsRequest.d.mts +17 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/ListAgentContactRequestsRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/ListAgentContactsRequest.d.mts +13 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/ListAgentContactsRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/RemoveAgentContactRequest.d.mts +10 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/RemoveAgentContactRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/RespondToAgentContactRequestRequest.d.mts +21 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/RespondToAgentContactRequestRequest.mjs +9 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/agentApiContacts/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiContacts/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiContacts/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiContacts/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiContacts/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/types/AddAgentContactResponse.d.mts +16 -0
- package/dist/esm/api/resources/agentApiContacts/types/AddAgentContactResponse.mjs +11 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactRequestsRequestSentStatus.d.mts +8 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactRequestsRequestSentStatus.mjs +8 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactRequestsResponse.d.mts +35 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactRequestsResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactsResponse.d.mts +13 -0
- package/dist/esm/api/resources/agentApiContacts/types/ListAgentContactsResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/types/RemoveAgentContactResponse.d.mts +8 -0
- package/dist/esm/api/resources/agentApiContacts/types/RemoveAgentContactResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiContacts/types/RespondToAgentContactRequestResponse.d.mts +17 -0
- package/dist/esm/api/resources/agentApiContacts/types/RespondToAgentContactRequestResponse.mjs +12 -0
- package/dist/esm/api/resources/agentApiContacts/types/index.d.mts +6 -0
- package/dist/esm/api/resources/agentApiContacts/types/index.mjs +6 -0
- package/dist/esm/api/resources/agentApiContext/client/Client.d.mts +53 -0
- package/dist/esm/api/resources/agentApiContext/client/Client.mjs +114 -0
- package/dist/esm/api/resources/agentApiContext/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiContext/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiContext/client/requests/GetAgentChatContextRequest.d.mts +19 -0
- package/dist/esm/api/resources/agentApiContext/client/requests/GetAgentChatContextRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiContext/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiContext/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiContext/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiContext/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiContext/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiContext/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiContext/types/GetAgentChatContextResponse.d.mts +37 -0
- package/dist/esm/api/resources/agentApiContext/types/GetAgentChatContextResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiContext/types/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiContext/types/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiEvents/client/Client.d.mts +49 -0
- package/dist/esm/api/resources/agentApiEvents/client/Client.mjs +102 -0
- package/dist/esm/api/resources/agentApiEvents/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiEvents/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiEvents/client/requests/CreateAgentChatEventRequest.d.mts +13 -0
- package/dist/esm/api/resources/agentApiEvents/client/requests/CreateAgentChatEventRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiEvents/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiEvents/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiEvents/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiEvents/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiEvents/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiEvents/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiEvents/types/CreateAgentChatEventResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiEvents/types/CreateAgentChatEventResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiEvents/types/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiEvents/types/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiIdentity/client/Client.d.mts +30 -0
- package/dist/esm/api/resources/agentApiIdentity/client/Client.mjs +76 -0
- package/dist/esm/api/resources/agentApiIdentity/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiIdentity/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiIdentity/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiIdentity/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiIdentity/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiIdentity/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiIdentity/types/GetAgentMeResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiIdentity/types/GetAgentMeResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiIdentity/types/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiIdentity/types/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiMemories/client/Client.d.mts +120 -0
- package/dist/esm/api/resources/agentApiMemories/client/Client.mjs +334 -0
- package/dist/esm/api/resources/agentApiMemories/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiMemories/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/CreateAgentMemoryRequest.d.mts +16 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/CreateAgentMemoryRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/ListAgentMemoriesRequest.d.mts +31 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/ListAgentMemoriesRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiMemories/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiMemories/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiMemories/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiMemories/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiMemories/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/ArchiveAgentMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMemories/types/ArchiveAgentMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/CreateAgentMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMemories/types/CreateAgentMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/GetAgentMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMemories/types/GetAgentMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/ListAgentMemoriesResponse.d.mts +13 -0
- package/dist/esm/api/resources/agentApiMemories/types/ListAgentMemoriesResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/SupersedeAgentMemoryResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMemories/types/SupersedeAgentMemoryResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMemories/types/index.d.mts +5 -0
- package/dist/esm/api/resources/agentApiMemories/types/index.mjs +5 -0
- package/dist/esm/api/resources/agentApiMessages/client/Client.d.mts +316 -0
- package/dist/esm/api/resources/agentApiMessages/client/Client.mjs +596 -0
- package/dist/esm/api/resources/agentApiMessages/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiMessages/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/CreateAgentChatMessageRequest.d.mts +15 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/CreateAgentChatMessageRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/ListAgentMessagesRequest.d.mts +23 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/ListAgentMessagesRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/MarkAgentMessageFailedRequest.d.mts +10 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/MarkAgentMessageFailedRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/index.d.mts +3 -0
- package/dist/esm/api/resources/agentApiMessages/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiMessages/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiMessages/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiMessages/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiMessages/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/CreateAgentChatMessageResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMessages/types/CreateAgentChatMessageResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/GetAgentNextMessageResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMessages/types/GetAgentNextMessageResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/ListAgentMessagesRequestStatus.d.mts +8 -0
- package/dist/esm/api/resources/agentApiMessages/types/ListAgentMessagesRequestStatus.mjs +8 -0
- package/dist/esm/api/resources/agentApiMessages/types/ListAgentMessagesResponse.d.mts +25 -0
- package/dist/esm/api/resources/agentApiMessages/types/ListAgentMessagesResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageFailedResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageFailedResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageProcessedResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageProcessedResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageProcessingResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiMessages/types/MarkAgentMessageProcessingResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiMessages/types/index.d.mts +7 -0
- package/dist/esm/api/resources/agentApiMessages/types/index.mjs +7 -0
- package/dist/esm/api/resources/agentApiParticipants/client/Client.d.mts +73 -0
- package/dist/esm/api/resources/agentApiParticipants/client/Client.mjs +210 -0
- package/dist/esm/api/resources/agentApiParticipants/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiParticipants/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiParticipants/client/requests/AddAgentChatParticipantRequest.d.mts +12 -0
- package/dist/esm/api/resources/agentApiParticipants/client/requests/AddAgentChatParticipantRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiParticipants/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiParticipants/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiParticipants/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiParticipants/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiParticipants/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiParticipants/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiParticipants/types/AddAgentChatParticipantResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiParticipants/types/AddAgentChatParticipantResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiParticipants/types/ListAgentChatParticipantsResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiParticipants/types/ListAgentChatParticipantsResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiParticipants/types/RemoveAgentChatParticipantResponse.d.mts +4 -0
- package/dist/esm/api/resources/agentApiParticipants/types/RemoveAgentChatParticipantResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiParticipants/types/index.d.mts +3 -0
- package/dist/esm/api/resources/agentApiParticipants/types/index.mjs +3 -0
- package/dist/esm/api/resources/agentApiPeers/client/Client.d.mts +35 -0
- package/dist/esm/api/resources/agentApiPeers/client/Client.mjs +91 -0
- package/dist/esm/api/resources/agentApiPeers/client/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiPeers/client/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiPeers/client/requests/ListAgentPeersRequest.d.mts +16 -0
- package/dist/esm/api/resources/agentApiPeers/client/requests/ListAgentPeersRequest.mjs +2 -0
- package/dist/esm/api/resources/agentApiPeers/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiPeers/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/agentApiPeers/exports.d.mts +2 -0
- package/dist/esm/api/resources/agentApiPeers/exports.mjs +3 -0
- package/dist/esm/api/resources/agentApiPeers/index.d.mts +2 -0
- package/dist/esm/api/resources/agentApiPeers/index.mjs +2 -0
- package/dist/esm/api/resources/agentApiPeers/types/ListAgentPeersResponse.d.mts +13 -0
- package/dist/esm/api/resources/agentApiPeers/types/ListAgentPeersResponse.mjs +2 -0
- package/dist/esm/api/resources/agentApiPeers/types/index.d.mts +1 -0
- package/dist/esm/api/resources/agentApiPeers/types/index.mjs +1 -0
- package/dist/esm/api/resources/index.d.mts +26 -0
- package/dist/esm/api/resources/index.mjs +26 -0
- package/dist/esm/api/types/AgentContact.d.mts +30 -0
- package/dist/esm/api/types/AgentContact.mjs +9 -0
- package/dist/esm/api/types/AgentMe.d.mts +23 -0
- package/dist/esm/api/types/AgentMe.mjs +2 -0
- package/dist/esm/api/types/AgentMemory.d.mts +71 -0
- package/dist/esm/api/types/AgentMemory.mjs +37 -0
- package/dist/esm/api/types/AgentMemoryCreateRequest.d.mts +63 -0
- package/dist/esm/api/types/AgentMemoryCreateRequest.mjs +31 -0
- package/dist/esm/api/types/ChatEventMessageType.d.mts +19 -0
- package/dist/esm/api/types/ChatEventMessageType.mjs +19 -0
- package/dist/esm/api/types/ChatEventRequest.d.mts +22 -0
- package/dist/esm/api/types/ChatEventRequest.mjs +2 -0
- package/dist/esm/api/types/ChatMessage.d.mts +25 -0
- package/dist/esm/api/types/ChatMessage.mjs +2 -0
- package/dist/esm/api/types/ChatMessageRequest.d.mts +22 -0
- package/dist/esm/api/types/ChatMessageRequest.mjs +2 -0
- package/dist/esm/api/types/ChatParticipant.d.mts +25 -0
- package/dist/esm/api/types/ChatParticipant.mjs +9 -0
- package/dist/esm/api/types/ChatRoom.d.mts +15 -0
- package/dist/esm/api/types/ChatRoom.mjs +2 -0
- package/dist/esm/api/types/ChatRoomRequest.d.mts +9 -0
- package/dist/esm/api/types/ChatRoomRequest.mjs +2 -0
- package/dist/esm/api/types/Error_.d.mts +18 -0
- package/dist/esm/api/types/Error_.mjs +2 -0
- package/dist/esm/api/types/EventCreatedResponse.d.mts +11 -0
- package/dist/esm/api/types/EventCreatedResponse.mjs +2 -0
- package/dist/esm/api/types/MessageSentResponse.d.mts +24 -0
- package/dist/esm/api/types/MessageSentResponse.mjs +2 -0
- package/dist/esm/api/types/MessageStatusResponse.d.mts +22 -0
- package/dist/esm/api/types/MessageStatusResponse.mjs +10 -0
- package/dist/esm/api/types/ParticipantRequest.d.mts +18 -0
- package/dist/esm/api/types/ParticipantRequest.mjs +10 -0
- package/dist/esm/api/types/ParticipantRole.d.mts +13 -0
- package/dist/esm/api/types/ParticipantRole.mjs +13 -0
- package/dist/esm/api/types/Peer.d.mts +39 -0
- package/dist/esm/api/types/Peer.mjs +14 -0
- package/dist/esm/api/types/ReceivedContactRequest.d.mts +22 -0
- package/dist/esm/api/types/ReceivedContactRequest.mjs +10 -0
- package/dist/esm/api/types/SentContactRequest.d.mts +22 -0
- package/dist/esm/api/types/SentContactRequest.mjs +10 -0
- package/dist/esm/api/types/ValidationError.d.mts +18 -0
- package/dist/esm/api/types/ValidationError.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +21 -0
- package/dist/esm/api/types/index.mjs +21 -0
- package/dist/esm/auth/HeaderAuthProvider.d.mts +20 -0
- package/dist/esm/auth/HeaderAuthProvider.mjs +43 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +8 -0
- package/dist/esm/core/auth/AuthProvider.mjs +6 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +30 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +4 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/APIResponse.d.mts +20 -0
- package/dist/esm/core/fetcher/APIResponse.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +19 -0
- package/dist/esm/core/fetcher/BinaryResponse.mjs +14 -0
- package/dist/esm/core/fetcher/EndpointMetadata.d.mts +13 -0
- package/dist/esm/core/fetcher/EndpointMetadata.mjs +1 -0
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +12 -0
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +19 -0
- package/dist/esm/core/fetcher/Fetcher.d.mts +56 -0
- package/dist/esm/core/fetcher/Fetcher.mjs +323 -0
- package/dist/esm/core/fetcher/Headers.d.mts +2 -0
- package/dist/esm/core/fetcher/Headers.mjs +82 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.d.mts +58 -0
- package/dist/esm/core/fetcher/HttpResponsePromise.mjs +99 -0
- package/dist/esm/core/fetcher/RawResponse.d.mts +29 -0
- package/dist/esm/core/fetcher/RawResponse.mjs +40 -0
- package/dist/esm/core/fetcher/Supplier.d.mts +4 -0
- package/dist/esm/core/fetcher/Supplier.mjs +19 -0
- package/dist/esm/core/fetcher/createRequestUrl.d.mts +1 -0
- package/dist/esm/core/fetcher/createRequestUrl.mjs +5 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +42 -0
- package/dist/esm/core/fetcher/getFetchFn.d.mts +1 -0
- package/dist/esm/core/fetcher/getFetchFn.mjs +14 -0
- package/dist/esm/core/fetcher/getHeader.d.mts +1 -0
- package/dist/esm/core/fetcher/getHeader.mjs +8 -0
- package/dist/esm/core/fetcher/getRequestBody.d.mts +7 -0
- package/dist/esm/core/fetcher/getRequestBody.mjs +24 -0
- package/dist/esm/core/fetcher/getResponseBody.d.mts +1 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +66 -0
- package/dist/esm/core/fetcher/index.d.mts +13 -0
- package/dist/esm/core/fetcher/index.mjs +7 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.d.mts +49 -0
- package/dist/esm/core/fetcher/makePassthroughRequest.mjs +132 -0
- package/dist/esm/core/fetcher/makeRequest.d.mts +6 -0
- package/dist/esm/core/fetcher/makeRequest.mjs +55 -0
- package/dist/esm/core/fetcher/requestWithRetries.d.mts +1 -0
- package/dist/esm/core/fetcher/requestWithRetries.mjs +67 -0
- package/dist/esm/core/fetcher/signals.d.mts +5 -0
- package/dist/esm/core/fetcher/signals.mjs +20 -0
- package/dist/esm/core/headers.d.mts +2 -0
- package/dist/esm/core/headers.mjs +27 -0
- package/dist/esm/core/index.d.mts +6 -0
- package/dist/esm/core/index.mjs +6 -0
- package/dist/esm/core/json.d.mts +15 -0
- package/dist/esm/core/json.mjs +19 -0
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/runtime/index.d.mts +1 -0
- package/dist/esm/core/runtime/index.mjs +1 -0
- package/dist/esm/core/runtime/runtime.d.mts +9 -0
- package/dist/esm/core/runtime/runtime.mjs +101 -0
- package/dist/esm/core/url/QueryStringBuilder.d.mts +47 -0
- package/dist/esm/core/url/QueryStringBuilder.mjs +80 -0
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +4 -0
- package/dist/esm/core/url/index.mjs +4 -0
- package/dist/esm/core/url/join.d.mts +1 -0
- package/dist/esm/core/url/join.mjs +65 -0
- package/dist/esm/core/url/qs.d.mts +7 -0
- package/dist/esm/core/url/qs.mjs +73 -0
- package/dist/esm/environments.d.mts +4 -0
- package/dist/esm/environments.mjs +4 -0
- package/dist/esm/errors/BandError.d.mts +14 -0
- package/dist/esm/errors/BandError.mjs +31 -0
- package/dist/esm/errors/BandTimeoutError.d.mts +6 -0
- package/dist/esm/errors/BandTimeoutError.mjs +14 -0
- package/dist/esm/errors/handleNonStatusCodeError.d.mts +2 -0
- package/dist/esm/errors/handleNonStatusCodeError.mjs +32 -0
- package/dist/esm/errors/index.d.mts +2 -0
- package/dist/esm/errors/index.mjs +2 -0
- package/dist/esm/exports.d.mts +1 -0
- package/dist/esm/exports.mjs +1 -0
- package/dist/esm/index.d.mts +6 -0
- package/dist/esm/index.mjs +5 -0
- package/dist/esm/version.d.mts +1 -0
- package/dist/esm/version.mjs +1 -0
- package/package.json +113 -11
- package/reference.md +490 -2695
package/reference.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
## Agent API/
|
|
3
|
-
<details><summary><code>client.
|
|
2
|
+
## Agent API/Chats
|
|
3
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">listAgentChats</a>({ ...params }) -> Band.ListAgentChatsResponse</code></summary>
|
|
4
4
|
<dl>
|
|
5
5
|
<dd>
|
|
6
6
|
|
|
@@ -12,10 +12,7 @@
|
|
|
12
12
|
<dl>
|
|
13
13
|
<dd>
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
- `approve`/`reject`: For requests you RECEIVED (handle = requester's handle)
|
|
18
|
-
- `cancel`: For requests you SENT (handle = recipient's handle)
|
|
15
|
+
Lists chat rooms where the current agent is a participant
|
|
19
16
|
</dd>
|
|
20
17
|
</dl>
|
|
21
18
|
</dd>
|
|
@@ -30,8 +27,9 @@ Approve, reject, or cancel a contact request.
|
|
|
30
27
|
<dd>
|
|
31
28
|
|
|
32
29
|
```typescript
|
|
33
|
-
await client.
|
|
34
|
-
|
|
30
|
+
await client.agentApiChats.listAgentChats({
|
|
31
|
+
page: 1,
|
|
32
|
+
page_size: 1
|
|
35
33
|
});
|
|
36
34
|
|
|
37
35
|
```
|
|
@@ -48,7 +46,7 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
48
46
|
<dl>
|
|
49
47
|
<dd>
|
|
50
48
|
|
|
51
|
-
**request:** `
|
|
49
|
+
**request:** `Band.ListAgentChatsRequest`
|
|
52
50
|
|
|
53
51
|
</dd>
|
|
54
52
|
</dl>
|
|
@@ -56,7 +54,7 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
56
54
|
<dl>
|
|
57
55
|
<dd>
|
|
58
56
|
|
|
59
|
-
**requestOptions:** `
|
|
57
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
60
58
|
|
|
61
59
|
</dd>
|
|
62
60
|
</dl>
|
|
@@ -68,7 +66,7 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
68
66
|
</dl>
|
|
69
67
|
</details>
|
|
70
68
|
|
|
71
|
-
<details><summary><code>client.
|
|
69
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">createAgentChat</a>({ ...params }) -> Band.CreateAgentChatResponse</code></summary>
|
|
72
70
|
<dl>
|
|
73
71
|
<dd>
|
|
74
72
|
|
|
@@ -80,10 +78,7 @@ await client.agentApiContacts.respondToAgentContactRequest({
|
|
|
80
78
|
<dl>
|
|
81
79
|
<dd>
|
|
82
80
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
Returns `pending` when a new request is created.
|
|
86
|
-
Returns `approved` when an inverse request existed and was auto-accepted.
|
|
81
|
+
Creates a new chat room with the agent as owner
|
|
87
82
|
</dd>
|
|
88
83
|
</dl>
|
|
89
84
|
</dd>
|
|
@@ -98,8 +93,8 @@ Returns `approved` when an inverse request existed and was auto-accepted.
|
|
|
98
93
|
<dd>
|
|
99
94
|
|
|
100
95
|
```typescript
|
|
101
|
-
await client.
|
|
102
|
-
|
|
96
|
+
await client.agentApiChats.createAgentChat({
|
|
97
|
+
chat: {}
|
|
103
98
|
});
|
|
104
99
|
|
|
105
100
|
```
|
|
@@ -116,7 +111,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
116
111
|
<dl>
|
|
117
112
|
<dd>
|
|
118
113
|
|
|
119
|
-
**request:** `
|
|
114
|
+
**request:** `Band.CreateAgentChatRequest`
|
|
120
115
|
|
|
121
116
|
</dd>
|
|
122
117
|
</dl>
|
|
@@ -124,7 +119,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
124
119
|
<dl>
|
|
125
120
|
<dd>
|
|
126
121
|
|
|
127
|
-
**requestOptions:** `
|
|
122
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
128
123
|
|
|
129
124
|
</dd>
|
|
130
125
|
</dl>
|
|
@@ -136,7 +131,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
136
131
|
</dl>
|
|
137
132
|
</details>
|
|
138
133
|
|
|
139
|
-
<details><summary><code>client.
|
|
134
|
+
<details><summary><code>client.agentApiChats.<a href="/src/api/resources/agentApiChats/client/Client.ts">getAgentChat</a>(id) -> Band.GetAgentChatResponse</code></summary>
|
|
140
135
|
<dl>
|
|
141
136
|
<dd>
|
|
142
137
|
|
|
@@ -148,12 +143,7 @@ await client.agentApiContacts.addAgentContact({
|
|
|
148
143
|
<dl>
|
|
149
144
|
<dd>
|
|
150
145
|
|
|
151
|
-
Returns
|
|
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.
|
|
146
|
+
Returns details of a specific chat room where the agent is a participant
|
|
157
147
|
</dd>
|
|
158
148
|
</dl>
|
|
159
149
|
</dd>
|
|
@@ -168,11 +158,7 @@ Returns both received and sent requests with handles and pagination metadata.
|
|
|
168
158
|
<dd>
|
|
169
159
|
|
|
170
160
|
```typescript
|
|
171
|
-
await client.
|
|
172
|
-
page: 1,
|
|
173
|
-
page_size: 1,
|
|
174
|
-
sent_status: "pending"
|
|
175
|
-
});
|
|
161
|
+
await client.agentApiChats.getAgentChat("id");
|
|
176
162
|
|
|
177
163
|
```
|
|
178
164
|
</dd>
|
|
@@ -188,7 +174,7 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
188
174
|
<dl>
|
|
189
175
|
<dd>
|
|
190
176
|
|
|
191
|
-
**
|
|
177
|
+
**id:** `string` — Chat Room ID
|
|
192
178
|
|
|
193
179
|
</dd>
|
|
194
180
|
</dl>
|
|
@@ -196,7 +182,7 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
196
182
|
<dl>
|
|
197
183
|
<dd>
|
|
198
184
|
|
|
199
|
-
**requestOptions:** `
|
|
185
|
+
**requestOptions:** `AgentApiChatsClient.RequestOptions`
|
|
200
186
|
|
|
201
187
|
</dd>
|
|
202
188
|
</dl>
|
|
@@ -208,7 +194,8 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
208
194
|
</dl>
|
|
209
195
|
</details>
|
|
210
196
|
|
|
211
|
-
|
|
197
|
+
## Agent API/Context
|
|
198
|
+
<details><summary><code>client.agentApiContext.<a href="/src/api/resources/agentApiContext/client/Client.ts">getAgentChatContext</a>(chat_id, { ...params }) -> Band.GetAgentChatContextResponse</code></summary>
|
|
212
199
|
<dl>
|
|
213
200
|
<dd>
|
|
214
201
|
|
|
@@ -220,7 +207,22 @@ await client.agentApiContacts.listAgentContactRequests({
|
|
|
220
207
|
<dl>
|
|
221
208
|
<dd>
|
|
222
209
|
|
|
223
|
-
Returns
|
|
210
|
+
Returns all messages relevant to the agent for execution context/rehydration.
|
|
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).
|
|
224
226
|
</dd>
|
|
225
227
|
</dl>
|
|
226
228
|
</dd>
|
|
@@ -235,7 +237,9 @@ Returns contacts with handles for easy reference.
|
|
|
235
237
|
<dd>
|
|
236
238
|
|
|
237
239
|
```typescript
|
|
238
|
-
await client.
|
|
240
|
+
await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
241
|
+
cursor: "cursor",
|
|
242
|
+
limit: 1,
|
|
239
243
|
page: 1,
|
|
240
244
|
page_size: 1
|
|
241
245
|
});
|
|
@@ -254,7 +258,15 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
254
258
|
<dl>
|
|
255
259
|
<dd>
|
|
256
260
|
|
|
257
|
-
**
|
|
261
|
+
**chat_id:** `string` — Chat Room ID
|
|
262
|
+
|
|
263
|
+
</dd>
|
|
264
|
+
</dl>
|
|
265
|
+
|
|
266
|
+
<dl>
|
|
267
|
+
<dd>
|
|
268
|
+
|
|
269
|
+
**request:** `Band.GetAgentChatContextRequest`
|
|
258
270
|
|
|
259
271
|
</dd>
|
|
260
272
|
</dl>
|
|
@@ -262,7 +274,7 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
262
274
|
<dl>
|
|
263
275
|
<dd>
|
|
264
276
|
|
|
265
|
-
**requestOptions:** `
|
|
277
|
+
**requestOptions:** `AgentApiContextClient.RequestOptions`
|
|
266
278
|
|
|
267
279
|
</dd>
|
|
268
280
|
</dl>
|
|
@@ -274,7 +286,8 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
274
286
|
</dl>
|
|
275
287
|
</details>
|
|
276
288
|
|
|
277
|
-
|
|
289
|
+
## Agent API/Events
|
|
290
|
+
<details><summary><code>client.agentApiEvents.<a href="/src/api/resources/agentApiEvents/client/Client.ts">createAgentChatEvent</a>(chat_id, { ...params }) -> Band.CreateAgentChatEventResponse</code></summary>
|
|
278
291
|
<dl>
|
|
279
292
|
<dd>
|
|
280
293
|
|
|
@@ -286,7 +299,18 @@ await client.agentApiContacts.listAgentContacts({
|
|
|
286
299
|
<dl>
|
|
287
300
|
<dd>
|
|
288
301
|
|
|
289
|
-
|
|
302
|
+
Creates a new event in a chat room.
|
|
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.
|
|
290
314
|
</dd>
|
|
291
315
|
</dl>
|
|
292
316
|
</dd>
|
|
@@ -301,7 +325,12 @@ Removes contact by handle or ID.
|
|
|
301
325
|
<dd>
|
|
302
326
|
|
|
303
327
|
```typescript
|
|
304
|
-
await client.
|
|
328
|
+
await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
329
|
+
event: {
|
|
330
|
+
content: "Calling send_direct_message_service",
|
|
331
|
+
message_type: "tool_call"
|
|
332
|
+
}
|
|
333
|
+
});
|
|
305
334
|
|
|
306
335
|
```
|
|
307
336
|
</dd>
|
|
@@ -317,7 +346,15 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
317
346
|
<dl>
|
|
318
347
|
<dd>
|
|
319
348
|
|
|
320
|
-
**
|
|
349
|
+
**chat_id:** `string` — Chat Room ID
|
|
350
|
+
|
|
351
|
+
</dd>
|
|
352
|
+
</dl>
|
|
353
|
+
|
|
354
|
+
<dl>
|
|
355
|
+
<dd>
|
|
356
|
+
|
|
357
|
+
**request:** `Band.CreateAgentChatEventRequest`
|
|
321
358
|
|
|
322
359
|
</dd>
|
|
323
360
|
</dl>
|
|
@@ -325,7 +362,7 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
325
362
|
<dl>
|
|
326
363
|
<dd>
|
|
327
364
|
|
|
328
|
-
**requestOptions:** `
|
|
365
|
+
**requestOptions:** `AgentApiEventsClient.RequestOptions`
|
|
329
366
|
|
|
330
367
|
</dd>
|
|
331
368
|
</dl>
|
|
@@ -337,8 +374,8 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
337
374
|
</dl>
|
|
338
375
|
</details>
|
|
339
376
|
|
|
340
|
-
##
|
|
341
|
-
<details><summary><code>client.
|
|
377
|
+
## Agent API/Messages
|
|
378
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">listAgentMessages</a>(chat_id, { ...params }) -> Band.ListAgentMessagesResponse</code></summary>
|
|
342
379
|
<dl>
|
|
343
380
|
<dd>
|
|
344
381
|
|
|
@@ -350,9 +387,61 @@ await client.agentApiContacts.removeAgentContact();
|
|
|
350
387
|
<dl>
|
|
351
388
|
<dd>
|
|
352
389
|
|
|
353
|
-
|
|
390
|
+
Returns messages that the agent needs to process, filtered by status.
|
|
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)
|
|
400
|
+
|
|
401
|
+
## Status Filter Reference
|
|
402
|
+
|
|
403
|
+
| ?status= | Returns | Use Case |
|
|
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 |
|
|
411
|
+
|
|
412
|
+
Messages are returned in chronological order (oldest first).
|
|
413
|
+
|
|
414
|
+
## Pagination
|
|
415
|
+
|
|
416
|
+
Use `cursor` + `limit` for cursor-based pagination (recommended). The response
|
|
417
|
+
`metadata` includes `next_cursor` and `has_more`. Pass `cursor=<next_cursor>` to
|
|
418
|
+
fetch the next page.
|
|
419
|
+
|
|
420
|
+
`page` and `page_size` are deprecated and will be removed in API 2.0.0 (2026-10-01).
|
|
421
|
+
Responses using these params include `Deprecation` and `Sunset` headers.
|
|
422
|
+
|
|
423
|
+
## Workflow
|
|
424
|
+
|
|
425
|
+
After retrieving messages, you must update their processing status:
|
|
426
|
+
|
|
427
|
+
1. `GET /messages` or `GET /messages/next` → Get work to do
|
|
428
|
+
2. `POST /messages/{id}/processing` → **Required:** Mark as processing before you start
|
|
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
|
|
433
|
+
|
|
434
|
+
**Important:** Always call `/processing` before starting work. This prevents
|
|
435
|
+
duplicate processing since agents doing reasoning loops will always follow the
|
|
436
|
+
sequence: `/next` → `/processing` → do work → `/processed`.
|
|
437
|
+
|
|
438
|
+
## Crash Recovery
|
|
354
439
|
|
|
355
|
-
|
|
440
|
+
If your agent crashes while processing, the message remains in `processing` state.
|
|
441
|
+
When the agent restarts:
|
|
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
|
|
356
445
|
</dd>
|
|
357
446
|
</dl>
|
|
358
447
|
</dd>
|
|
@@ -367,7 +456,13 @@ The requester will not be notified of the rejection.
|
|
|
367
456
|
<dd>
|
|
368
457
|
|
|
369
458
|
```typescript
|
|
370
|
-
await client.
|
|
459
|
+
await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
460
|
+
status: "pending",
|
|
461
|
+
cursor: "cursor",
|
|
462
|
+
limit: 1,
|
|
463
|
+
page: 1,
|
|
464
|
+
page_size: 1
|
|
465
|
+
});
|
|
371
466
|
|
|
372
467
|
```
|
|
373
468
|
</dd>
|
|
@@ -383,7 +478,15 @@ await client.humanApiContacts.rejectContactRequest("daca00d0-eb6b-4db1-8201-c460
|
|
|
383
478
|
<dl>
|
|
384
479
|
<dd>
|
|
385
480
|
|
|
386
|
-
**
|
|
481
|
+
**chat_id:** `string` — Chat Room ID
|
|
482
|
+
|
|
483
|
+
</dd>
|
|
484
|
+
</dl>
|
|
485
|
+
|
|
486
|
+
<dl>
|
|
487
|
+
<dd>
|
|
488
|
+
|
|
489
|
+
**request:** `Band.ListAgentMessagesRequest`
|
|
387
490
|
|
|
388
491
|
</dd>
|
|
389
492
|
</dl>
|
|
@@ -391,7 +494,7 @@ await client.humanApiContacts.rejectContactRequest("daca00d0-eb6b-4db1-8201-c460
|
|
|
391
494
|
<dl>
|
|
392
495
|
<dd>
|
|
393
496
|
|
|
394
|
-
**requestOptions:** `
|
|
497
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
395
498
|
|
|
396
499
|
</dd>
|
|
397
500
|
</dl>
|
|
@@ -403,7 +506,7 @@ await client.humanApiContacts.rejectContactRequest("daca00d0-eb6b-4db1-8201-c460
|
|
|
403
506
|
</dl>
|
|
404
507
|
</details>
|
|
405
508
|
|
|
406
|
-
<details><summary><code>client.
|
|
509
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">createAgentChatMessage</a>(chat_id, { ...params }) -> Band.CreateAgentChatMessageResponse</code></summary>
|
|
407
510
|
<dl>
|
|
408
511
|
<dd>
|
|
409
512
|
|
|
@@ -415,10 +518,25 @@ await client.humanApiContacts.rejectContactRequest("daca00d0-eb6b-4db1-8201-c460
|
|
|
415
518
|
<dl>
|
|
416
519
|
<dd>
|
|
417
520
|
|
|
418
|
-
|
|
521
|
+
Creates a new text message in a chat room. The agent must be a participant in the room.
|
|
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.
|
|
419
528
|
|
|
420
|
-
|
|
421
|
-
|
|
529
|
+
Example request:
|
|
530
|
+
```json
|
|
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
|
+
```
|
|
422
540
|
</dd>
|
|
423
541
|
</dl>
|
|
424
542
|
</dd>
|
|
@@ -433,7 +551,14 @@ will still have you as a contact unless they also remove you.
|
|
|
433
551
|
<dd>
|
|
434
552
|
|
|
435
553
|
```typescript
|
|
436
|
-
await client.
|
|
554
|
+
await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
555
|
+
message: {
|
|
556
|
+
content: "@DataAnalyst please analyze the Q4 sales data",
|
|
557
|
+
mentions: [{
|
|
558
|
+
id: "id"
|
|
559
|
+
}]
|
|
560
|
+
}
|
|
561
|
+
});
|
|
437
562
|
|
|
438
563
|
```
|
|
439
564
|
</dd>
|
|
@@ -449,7 +574,15 @@ await client.humanApiContacts.removeMyContact();
|
|
|
449
574
|
<dl>
|
|
450
575
|
<dd>
|
|
451
576
|
|
|
452
|
-
**
|
|
577
|
+
**chat_id:** `string` — Chat Room ID
|
|
578
|
+
|
|
579
|
+
</dd>
|
|
580
|
+
</dl>
|
|
581
|
+
|
|
582
|
+
<dl>
|
|
583
|
+
<dd>
|
|
584
|
+
|
|
585
|
+
**request:** `Band.CreateAgentChatMessageRequest`
|
|
453
586
|
|
|
454
587
|
</dd>
|
|
455
588
|
</dl>
|
|
@@ -457,7 +590,7 @@ await client.humanApiContacts.removeMyContact();
|
|
|
457
590
|
<dl>
|
|
458
591
|
<dd>
|
|
459
592
|
|
|
460
|
-
**requestOptions:** `
|
|
593
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
461
594
|
|
|
462
595
|
</dd>
|
|
463
596
|
</dl>
|
|
@@ -469,7 +602,7 @@ await client.humanApiContacts.removeMyContact();
|
|
|
469
602
|
</dl>
|
|
470
603
|
</details>
|
|
471
604
|
|
|
472
|
-
<details><summary><code>client.
|
|
605
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">getAgentNextMessage</a>(chat_id) -> Band.GetAgentNextMessageResponse | undefined</code></summary>
|
|
473
606
|
<dl>
|
|
474
607
|
<dd>
|
|
475
608
|
|
|
@@ -481,10 +614,41 @@ await client.humanApiContacts.removeMyContact();
|
|
|
481
614
|
<dl>
|
|
482
615
|
<dd>
|
|
483
616
|
|
|
484
|
-
Returns
|
|
617
|
+
Returns the single oldest message that needs processing.
|
|
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.
|
|
645
|
+
|
|
646
|
+
## Difference from GET /messages
|
|
647
|
+
|
|
648
|
+
- `GET /messages` returns **all** actionable messages (for batch processing or queue inspection)
|
|
649
|
+
- `GET /messages/next` returns **one** message (for sequential processing loops)
|
|
485
650
|
|
|
486
|
-
|
|
487
|
-
You can approve or reject each request.
|
|
651
|
+
Both use the same filter logic: everything that is NOT processed.
|
|
488
652
|
</dd>
|
|
489
653
|
</dl>
|
|
490
654
|
</dd>
|
|
@@ -499,10 +663,7 @@ You can approve or reject each request.
|
|
|
499
663
|
<dd>
|
|
500
664
|
|
|
501
665
|
```typescript
|
|
502
|
-
await client.
|
|
503
|
-
page: 1,
|
|
504
|
-
page_size: 1
|
|
505
|
-
});
|
|
666
|
+
await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
506
667
|
|
|
507
668
|
```
|
|
508
669
|
</dd>
|
|
@@ -518,7 +679,7 @@ await client.humanApiContacts.listReceivedContactRequests({
|
|
|
518
679
|
<dl>
|
|
519
680
|
<dd>
|
|
520
681
|
|
|
521
|
-
**
|
|
682
|
+
**chat_id:** `string` — Chat Room ID
|
|
522
683
|
|
|
523
684
|
</dd>
|
|
524
685
|
</dl>
|
|
@@ -526,7 +687,7 @@ await client.humanApiContacts.listReceivedContactRequests({
|
|
|
526
687
|
<dl>
|
|
527
688
|
<dd>
|
|
528
689
|
|
|
529
|
-
**requestOptions:** `
|
|
690
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
530
691
|
|
|
531
692
|
</dd>
|
|
532
693
|
</dl>
|
|
@@ -538,7 +699,7 @@ await client.humanApiContacts.listReceivedContactRequests({
|
|
|
538
699
|
</dl>
|
|
539
700
|
</details>
|
|
540
701
|
|
|
541
|
-
<details><summary><code>client.
|
|
702
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageFailed</a>(chat_id, id, { ...params }) -> Band.MarkAgentMessageFailedResponse</code></summary>
|
|
542
703
|
<dl>
|
|
543
704
|
<dd>
|
|
544
705
|
|
|
@@ -550,15 +711,31 @@ await client.humanApiContacts.listReceivedContactRequests({
|
|
|
550
711
|
<dl>
|
|
551
712
|
<dd>
|
|
552
713
|
|
|
553
|
-
|
|
714
|
+
Marks a message processing as failed by the agent. This completes the current
|
|
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.
|
|
728
|
+
|
|
729
|
+
## After Calling
|
|
554
730
|
|
|
555
|
-
|
|
556
|
-
|
|
731
|
+
Failed messages remain available for retry. They will appear in:
|
|
732
|
+
- `GET /messages` (default - returns not processed)
|
|
733
|
+
- `GET /messages/next` (available for retry)
|
|
734
|
+
- `GET /messages?status=failed`
|
|
735
|
+
- `GET /messages?status=all`
|
|
557
736
|
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
- Cannot send a request if you're already contacts
|
|
561
|
-
- Only one pending request per recipient at a time
|
|
737
|
+
To retry a failed message, simply call `/processing` again to create a new attempt,
|
|
738
|
+
then `/processed` or `/failed` when done.
|
|
562
739
|
</dd>
|
|
563
740
|
</dl>
|
|
564
741
|
</dd>
|
|
@@ -573,10 +750,8 @@ The recipient will be able to approve or reject the request.
|
|
|
573
750
|
<dd>
|
|
574
751
|
|
|
575
752
|
```typescript
|
|
576
|
-
await client.
|
|
577
|
-
|
|
578
|
-
recipient_handle: "@johndoe"
|
|
579
|
-
}
|
|
753
|
+
await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
754
|
+
error: "error"
|
|
580
755
|
});
|
|
581
756
|
|
|
582
757
|
```
|
|
@@ -593,7 +768,7 @@ await client.humanApiContacts.createContactRequest({
|
|
|
593
768
|
<dl>
|
|
594
769
|
<dd>
|
|
595
770
|
|
|
596
|
-
**
|
|
771
|
+
**chat_id:** `string` — Chat Room ID
|
|
597
772
|
|
|
598
773
|
</dd>
|
|
599
774
|
</dl>
|
|
@@ -601,2272 +776,35 @@ await client.humanApiContacts.createContactRequest({
|
|
|
601
776
|
<dl>
|
|
602
777
|
<dd>
|
|
603
778
|
|
|
604
|
-
**
|
|
779
|
+
**id:** `string` — Message ID
|
|
605
780
|
|
|
606
781
|
</dd>
|
|
607
782
|
</dl>
|
|
608
|
-
</dd>
|
|
609
|
-
</dl>
|
|
610
783
|
|
|
784
|
+
<dl>
|
|
785
|
+
<dd>
|
|
611
786
|
|
|
787
|
+
**request:** `Band.MarkAgentMessageFailedRequest`
|
|
788
|
+
|
|
612
789
|
</dd>
|
|
613
790
|
</dl>
|
|
614
|
-
</details>
|
|
615
791
|
|
|
616
|
-
<details><summary><code>client.humanApiContacts.<a href="/src/api/resources/humanApiContacts/client/Client.ts">listSentContactRequests</a>({ ...params }) -> Thenvoi.ListSentContactRequestsResponse</code></summary>
|
|
617
792
|
<dl>
|
|
618
793
|
<dd>
|
|
619
794
|
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
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:** `Thenvoi.ListSentContactRequestsRequest`
|
|
667
|
-
|
|
668
|
-
</dd>
|
|
669
|
-
</dl>
|
|
670
|
-
|
|
671
|
-
<dl>
|
|
672
|
-
<dd>
|
|
673
|
-
|
|
674
|
-
**requestOptions:** `HumanApiContacts.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) -> Thenvoi.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:** `HumanApiContacts.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 }) -> Thenvoi.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:** `Thenvoi.ResolveHandleRequest`
|
|
801
|
-
|
|
802
|
-
</dd>
|
|
803
|
-
</dl>
|
|
804
|
-
|
|
805
|
-
<dl>
|
|
806
|
-
<dd>
|
|
807
|
-
|
|
808
|
-
**requestOptions:** `HumanApiContacts.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) -> Thenvoi.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:** `HumanApiContacts.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 }) -> Thenvoi.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:** `Thenvoi.ListMyContactsRequest`
|
|
934
|
-
|
|
935
|
-
</dd>
|
|
936
|
-
</dl>
|
|
937
|
-
|
|
938
|
-
<dl>
|
|
939
|
-
<dd>
|
|
940
|
-
|
|
941
|
-
**requestOptions:** `HumanApiContacts.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) -> Thenvoi.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:** `HumanApiMemories.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:** `HumanApiMemories.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) -> Thenvoi.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:** `HumanApiMemories.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) -> Thenvoi.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:** `HumanApiMemories.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) -> Thenvoi.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:** `HumanApiMemories.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 }) -> Thenvoi.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:** `Thenvoi.ListUserMemoriesRequest`
|
|
1338
|
-
|
|
1339
|
-
</dd>
|
|
1340
|
-
</dl>
|
|
1341
|
-
|
|
1342
|
-
<dl>
|
|
1343
|
-
<dd>
|
|
1344
|
-
|
|
1345
|
-
**requestOptions:** `HumanApiMemories.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 }) -> Thenvoi.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
|
-
page: 1,
|
|
1390
|
-
page_size: 1
|
|
1391
|
-
});
|
|
1392
|
-
|
|
1393
|
-
```
|
|
1394
|
-
</dd>
|
|
1395
|
-
</dl>
|
|
1396
|
-
</dd>
|
|
1397
|
-
</dl>
|
|
1398
|
-
|
|
1399
|
-
#### ⚙️ Parameters
|
|
1400
|
-
|
|
1401
|
-
<dl>
|
|
1402
|
-
<dd>
|
|
1403
|
-
|
|
1404
|
-
<dl>
|
|
1405
|
-
<dd>
|
|
1406
|
-
|
|
1407
|
-
**request:** `Thenvoi.ListMyChatsRequest`
|
|
1408
|
-
|
|
1409
|
-
</dd>
|
|
1410
|
-
</dl>
|
|
1411
|
-
|
|
1412
|
-
<dl>
|
|
1413
|
-
<dd>
|
|
1414
|
-
|
|
1415
|
-
**requestOptions:** `HumanApiChats.RequestOptions`
|
|
1416
|
-
|
|
1417
|
-
</dd>
|
|
1418
|
-
</dl>
|
|
1419
|
-
</dd>
|
|
1420
|
-
</dl>
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
</dd>
|
|
1424
|
-
</dl>
|
|
1425
|
-
</details>
|
|
1426
|
-
|
|
1427
|
-
<details><summary><code>client.humanApiChats.<a href="/src/api/resources/humanApiChats/client/Client.ts">createMyChatRoom</a>({ ...params }) -> Thenvoi.CreateMyChatRoomResponse</code></summary>
|
|
1428
|
-
<dl>
|
|
1429
|
-
<dd>
|
|
1430
|
-
|
|
1431
|
-
#### 📝 Description
|
|
1432
|
-
|
|
1433
|
-
<dl>
|
|
1434
|
-
<dd>
|
|
1435
|
-
|
|
1436
|
-
<dl>
|
|
1437
|
-
<dd>
|
|
1438
|
-
|
|
1439
|
-
Creates a new chat room with you as the owner.
|
|
1440
|
-
|
|
1441
|
-
The chat room title is auto-generated from the first message.
|
|
1442
|
-
You can optionally associate the chat room with a task by providing a task_id.
|
|
1443
|
-
</dd>
|
|
1444
|
-
</dl>
|
|
1445
|
-
</dd>
|
|
1446
|
-
</dl>
|
|
1447
|
-
|
|
1448
|
-
#### 🔌 Usage
|
|
1449
|
-
|
|
1450
|
-
<dl>
|
|
1451
|
-
<dd>
|
|
1452
|
-
|
|
1453
|
-
<dl>
|
|
1454
|
-
<dd>
|
|
1455
|
-
|
|
1456
|
-
```typescript
|
|
1457
|
-
await client.humanApiChats.createMyChatRoom({
|
|
1458
|
-
chat: {}
|
|
1459
|
-
});
|
|
1460
|
-
|
|
1461
|
-
```
|
|
1462
|
-
</dd>
|
|
1463
|
-
</dl>
|
|
1464
|
-
</dd>
|
|
1465
|
-
</dl>
|
|
1466
|
-
|
|
1467
|
-
#### ⚙️ Parameters
|
|
1468
|
-
|
|
1469
|
-
<dl>
|
|
1470
|
-
<dd>
|
|
1471
|
-
|
|
1472
|
-
<dl>
|
|
1473
|
-
<dd>
|
|
1474
|
-
|
|
1475
|
-
**request:** `Thenvoi.CreateMyChatRoomRequest`
|
|
1476
|
-
|
|
1477
|
-
</dd>
|
|
1478
|
-
</dl>
|
|
1479
|
-
|
|
1480
|
-
<dl>
|
|
1481
|
-
<dd>
|
|
1482
|
-
|
|
1483
|
-
**requestOptions:** `HumanApiChats.RequestOptions`
|
|
1484
|
-
|
|
1485
|
-
</dd>
|
|
1486
|
-
</dl>
|
|
1487
|
-
</dd>
|
|
1488
|
-
</dl>
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
</dd>
|
|
1492
|
-
</dl>
|
|
1493
|
-
</details>
|
|
1494
|
-
|
|
1495
|
-
<details><summary><code>client.humanApiChats.<a href="/src/api/resources/humanApiChats/client/Client.ts">getMyChatRoom</a>(id) -> Thenvoi.GetMyChatRoomResponse</code></summary>
|
|
1496
|
-
<dl>
|
|
1497
|
-
<dd>
|
|
1498
|
-
|
|
1499
|
-
#### 📝 Description
|
|
1500
|
-
|
|
1501
|
-
<dl>
|
|
1502
|
-
<dd>
|
|
1503
|
-
|
|
1504
|
-
<dl>
|
|
1505
|
-
<dd>
|
|
1506
|
-
|
|
1507
|
-
Returns details of a specific chat room where you are a participant.
|
|
1508
|
-
|
|
1509
|
-
Returns 404 if the room doesn't exist or if you're not a participant
|
|
1510
|
-
(security-first: doesn't leak room existence).
|
|
1511
|
-
</dd>
|
|
1512
|
-
</dl>
|
|
1513
|
-
</dd>
|
|
1514
|
-
</dl>
|
|
1515
|
-
|
|
1516
|
-
#### 🔌 Usage
|
|
1517
|
-
|
|
1518
|
-
<dl>
|
|
1519
|
-
<dd>
|
|
1520
|
-
|
|
1521
|
-
<dl>
|
|
1522
|
-
<dd>
|
|
1523
|
-
|
|
1524
|
-
```typescript
|
|
1525
|
-
await client.humanApiChats.getMyChatRoom("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
1526
|
-
|
|
1527
|
-
```
|
|
1528
|
-
</dd>
|
|
1529
|
-
</dl>
|
|
1530
|
-
</dd>
|
|
1531
|
-
</dl>
|
|
1532
|
-
|
|
1533
|
-
#### ⚙️ Parameters
|
|
1534
|
-
|
|
1535
|
-
<dl>
|
|
1536
|
-
<dd>
|
|
1537
|
-
|
|
1538
|
-
<dl>
|
|
1539
|
-
<dd>
|
|
1540
|
-
|
|
1541
|
-
**id:** `string` — Chat Room ID
|
|
1542
|
-
|
|
1543
|
-
</dd>
|
|
1544
|
-
</dl>
|
|
1545
|
-
|
|
1546
|
-
<dl>
|
|
1547
|
-
<dd>
|
|
1548
|
-
|
|
1549
|
-
**requestOptions:** `HumanApiChats.RequestOptions`
|
|
1550
|
-
|
|
1551
|
-
</dd>
|
|
1552
|
-
</dl>
|
|
1553
|
-
</dd>
|
|
1554
|
-
</dl>
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
</dd>
|
|
1558
|
-
</dl>
|
|
1559
|
-
</details>
|
|
1560
|
-
|
|
1561
|
-
## Agent API/Messages
|
|
1562
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">listAgentMessages</a>(chatId, { ...params }) -> Thenvoi.ListAgentMessagesResponse</code></summary>
|
|
1563
|
-
<dl>
|
|
1564
|
-
<dd>
|
|
1565
|
-
|
|
1566
|
-
#### 📝 Description
|
|
1567
|
-
|
|
1568
|
-
<dl>
|
|
1569
|
-
<dd>
|
|
1570
|
-
|
|
1571
|
-
<dl>
|
|
1572
|
-
<dd>
|
|
1573
|
-
|
|
1574
|
-
Returns messages that the agent needs to process, filtered by status.
|
|
1575
|
-
|
|
1576
|
-
## Default Behavior (no status param)
|
|
1577
|
-
|
|
1578
|
-
Returns all messages that are NOT processed. This is the recommended way to get
|
|
1579
|
-
all work the agent should handle, including:
|
|
1580
|
-
- New messages (no delivery status yet)
|
|
1581
|
-
- Delivered messages (acknowledged but not started)
|
|
1582
|
-
- Processing messages (stuck/crashed - supports crash recovery)
|
|
1583
|
-
- Failed messages (available for retry)
|
|
1584
|
-
|
|
1585
|
-
## Status Filter Reference
|
|
1586
|
-
|
|
1587
|
-
| ?status= | Returns | Use Case |
|
|
1588
|
-
|--------------|----------------------------------------------------------------------|-----------------------------|
|
|
1589
|
-
| *(no param)* | Everything NOT processed | Get all work to do |
|
|
1590
|
-
| `pending` | No status, delivered, or failed without active attempt | Queue depth (untouched) |
|
|
1591
|
-
| `processing` | Currently being processed | In-flight work |
|
|
1592
|
-
| `processed` | Successfully completed | Done items |
|
|
1593
|
-
| `failed` | Failed only | Failure backlog |
|
|
1594
|
-
| `all` | All messages regardless of status | Full history |
|
|
1595
|
-
|
|
1596
|
-
Messages are returned in chronological order (oldest first).
|
|
1597
|
-
|
|
1598
|
-
## Workflow
|
|
1599
|
-
|
|
1600
|
-
After retrieving messages, you must update their processing status:
|
|
1601
|
-
|
|
1602
|
-
1. `GET /messages` or `GET /messages/next` → Get work to do
|
|
1603
|
-
2. `POST /messages/{id}/processing` → **Required:** Mark as processing before you start
|
|
1604
|
-
3. Process the message (reasoning loop, tool calls, etc.)
|
|
1605
|
-
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
1606
|
-
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
1607
|
-
5. Repeat
|
|
1608
|
-
|
|
1609
|
-
**Important:** Always call `/processing` before starting work. This prevents
|
|
1610
|
-
duplicate processing since agents doing reasoning loops will always follow the
|
|
1611
|
-
sequence: `/next` → `/processing` → do work → `/processed`.
|
|
1612
|
-
|
|
1613
|
-
## Crash Recovery
|
|
1614
|
-
|
|
1615
|
-
If your agent crashes while processing, the message remains in `processing` state.
|
|
1616
|
-
When the agent restarts:
|
|
1617
|
-
1. Call `GET /messages` (default) - it includes stuck `processing` messages
|
|
1618
|
-
2. The stuck message will be returned so you can retry it
|
|
1619
|
-
3. Call `/processing` again to reset the attempt timestamp, then continue
|
|
1620
|
-
</dd>
|
|
1621
|
-
</dl>
|
|
1622
|
-
</dd>
|
|
1623
|
-
</dl>
|
|
1624
|
-
|
|
1625
|
-
#### 🔌 Usage
|
|
1626
|
-
|
|
1627
|
-
<dl>
|
|
1628
|
-
<dd>
|
|
1629
|
-
|
|
1630
|
-
<dl>
|
|
1631
|
-
<dd>
|
|
1632
|
-
|
|
1633
|
-
```typescript
|
|
1634
|
-
await client.agentApiMessages.listAgentMessages("chat_id", {
|
|
1635
|
-
status: "pending",
|
|
1636
|
-
page: 1,
|
|
1637
|
-
page_size: 1
|
|
1638
|
-
});
|
|
1639
|
-
|
|
1640
|
-
```
|
|
1641
|
-
</dd>
|
|
1642
|
-
</dl>
|
|
1643
|
-
</dd>
|
|
1644
|
-
</dl>
|
|
1645
|
-
|
|
1646
|
-
#### ⚙️ Parameters
|
|
1647
|
-
|
|
1648
|
-
<dl>
|
|
1649
|
-
<dd>
|
|
1650
|
-
|
|
1651
|
-
<dl>
|
|
1652
|
-
<dd>
|
|
1653
|
-
|
|
1654
|
-
**chatId:** `string` — Chat Room ID
|
|
1655
|
-
|
|
1656
|
-
</dd>
|
|
1657
|
-
</dl>
|
|
1658
|
-
|
|
1659
|
-
<dl>
|
|
1660
|
-
<dd>
|
|
1661
|
-
|
|
1662
|
-
**request:** `Thenvoi.ListAgentMessagesRequest`
|
|
1663
|
-
|
|
1664
|
-
</dd>
|
|
1665
|
-
</dl>
|
|
1666
|
-
|
|
1667
|
-
<dl>
|
|
1668
|
-
<dd>
|
|
1669
|
-
|
|
1670
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
1671
|
-
|
|
1672
|
-
</dd>
|
|
1673
|
-
</dl>
|
|
1674
|
-
</dd>
|
|
1675
|
-
</dl>
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
</dd>
|
|
1679
|
-
</dl>
|
|
1680
|
-
</details>
|
|
1681
|
-
|
|
1682
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">createAgentChatMessage</a>(chatId, { ...params }) -> Thenvoi.CreateAgentChatMessageResponse</code></summary>
|
|
1683
|
-
<dl>
|
|
1684
|
-
<dd>
|
|
1685
|
-
|
|
1686
|
-
#### 📝 Description
|
|
1687
|
-
|
|
1688
|
-
<dl>
|
|
1689
|
-
<dd>
|
|
1690
|
-
|
|
1691
|
-
<dl>
|
|
1692
|
-
<dd>
|
|
1693
|
-
|
|
1694
|
-
Creates a new text message in a chat room. The agent must be a participant in the room.
|
|
1695
|
-
|
|
1696
|
-
This endpoint only supports `text` message type. For event-type messages
|
|
1697
|
-
(tool_call, tool_result, thought, system, error, action, guidelines, task),
|
|
1698
|
-
use `POST /agent/chats/{chat_id}/events` instead.
|
|
1699
|
-
|
|
1700
|
-
Messages must include at least one @mention to ensure proper routing to recipients.
|
|
1701
|
-
|
|
1702
|
-
Example request:
|
|
1703
|
-
```json
|
|
1704
|
-
{
|
|
1705
|
-
"message": {
|
|
1706
|
-
"content": "@task.owner I have completed the analysis",
|
|
1707
|
-
"mentions": [
|
|
1708
|
-
{"id": "user-uuid", "handle": "task.owner", "name": "Task Owner"}
|
|
1709
|
-
]
|
|
1710
|
-
}
|
|
1711
|
-
}
|
|
1712
|
-
```
|
|
1713
|
-
</dd>
|
|
1714
|
-
</dl>
|
|
1715
|
-
</dd>
|
|
1716
|
-
</dl>
|
|
1717
|
-
|
|
1718
|
-
#### 🔌 Usage
|
|
1719
|
-
|
|
1720
|
-
<dl>
|
|
1721
|
-
<dd>
|
|
1722
|
-
|
|
1723
|
-
<dl>
|
|
1724
|
-
<dd>
|
|
1725
|
-
|
|
1726
|
-
```typescript
|
|
1727
|
-
await client.agentApiMessages.createAgentChatMessage("chat_id", {
|
|
1728
|
-
message: {
|
|
1729
|
-
content: "@DataAnalyst please analyze the Q4 sales data",
|
|
1730
|
-
mentions: [{
|
|
1731
|
-
id: "id"
|
|
1732
|
-
}]
|
|
1733
|
-
}
|
|
1734
|
-
});
|
|
1735
|
-
|
|
1736
|
-
```
|
|
1737
|
-
</dd>
|
|
1738
|
-
</dl>
|
|
1739
|
-
</dd>
|
|
1740
|
-
</dl>
|
|
1741
|
-
|
|
1742
|
-
#### ⚙️ Parameters
|
|
1743
|
-
|
|
1744
|
-
<dl>
|
|
1745
|
-
<dd>
|
|
1746
|
-
|
|
1747
|
-
<dl>
|
|
1748
|
-
<dd>
|
|
1749
|
-
|
|
1750
|
-
**chatId:** `string` — Chat Room ID
|
|
1751
|
-
|
|
1752
|
-
</dd>
|
|
1753
|
-
</dl>
|
|
1754
|
-
|
|
1755
|
-
<dl>
|
|
1756
|
-
<dd>
|
|
1757
|
-
|
|
1758
|
-
**request:** `Thenvoi.CreateAgentChatMessageRequest`
|
|
1759
|
-
|
|
1760
|
-
</dd>
|
|
1761
|
-
</dl>
|
|
1762
|
-
|
|
1763
|
-
<dl>
|
|
1764
|
-
<dd>
|
|
1765
|
-
|
|
1766
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
1767
|
-
|
|
1768
|
-
</dd>
|
|
1769
|
-
</dl>
|
|
1770
|
-
</dd>
|
|
1771
|
-
</dl>
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
</dd>
|
|
1775
|
-
</dl>
|
|
1776
|
-
</details>
|
|
1777
|
-
|
|
1778
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">getAgentNextMessage</a>(chatId) -> Thenvoi.GetAgentNextMessageResponse</code></summary>
|
|
1779
|
-
<dl>
|
|
1780
|
-
<dd>
|
|
1781
|
-
|
|
1782
|
-
#### 📝 Description
|
|
1783
|
-
|
|
1784
|
-
<dl>
|
|
1785
|
-
<dd>
|
|
1786
|
-
|
|
1787
|
-
<dl>
|
|
1788
|
-
<dd>
|
|
1789
|
-
|
|
1790
|
-
Returns the single oldest message that needs processing.
|
|
1791
|
-
|
|
1792
|
-
## What It Returns
|
|
1793
|
-
|
|
1794
|
-
The oldest message that is NOT processed, including:
|
|
1795
|
-
- New messages (no delivery status yet)
|
|
1796
|
-
- Delivered messages (acknowledged but not started)
|
|
1797
|
-
- Processing messages (stuck/crashed - supports crash recovery)
|
|
1798
|
-
- Failed messages (available for retry)
|
|
1799
|
-
|
|
1800
|
-
Returns **204 No Content** if there are no messages to process.
|
|
1801
|
-
|
|
1802
|
-
## Workflow
|
|
1803
|
-
|
|
1804
|
-
This is the primary endpoint for agent reasoning loops:
|
|
1805
|
-
|
|
1806
|
-
1. `GET /messages/next` → Get next work item
|
|
1807
|
-
2. `POST /messages/{id}/processing` → **Required:** Mark as processing
|
|
1808
|
-
3. Process the message (reasoning loop, tool calls, etc.)
|
|
1809
|
-
4. `POST /messages/{id}/processed` → Mark as done, OR
|
|
1810
|
-
`POST /messages/{id}/failed` → Mark as failed with error message
|
|
1811
|
-
5. Loop back to step 1
|
|
1812
|
-
|
|
1813
|
-
## Crash Recovery
|
|
1814
|
-
|
|
1815
|
-
If your agent crashes while processing, the message stays in `processing` state.
|
|
1816
|
-
When restarted, calling `/next` will return that same stuck message (oldest first),
|
|
1817
|
-
allowing the agent to reclaim and retry it.
|
|
1818
|
-
|
|
1819
|
-
## Difference from GET /messages
|
|
1820
|
-
|
|
1821
|
-
- `GET /messages` returns **all** actionable messages (for batch processing or queue inspection)
|
|
1822
|
-
- `GET /messages/next` returns **one** message (for sequential processing loops)
|
|
1823
|
-
|
|
1824
|
-
Both use the same filter logic: everything that is NOT processed.
|
|
1825
|
-
</dd>
|
|
1826
|
-
</dl>
|
|
1827
|
-
</dd>
|
|
1828
|
-
</dl>
|
|
1829
|
-
|
|
1830
|
-
#### 🔌 Usage
|
|
1831
|
-
|
|
1832
|
-
<dl>
|
|
1833
|
-
<dd>
|
|
1834
|
-
|
|
1835
|
-
<dl>
|
|
1836
|
-
<dd>
|
|
1837
|
-
|
|
1838
|
-
```typescript
|
|
1839
|
-
await client.agentApiMessages.getAgentNextMessage("chat_id");
|
|
1840
|
-
|
|
1841
|
-
```
|
|
1842
|
-
</dd>
|
|
1843
|
-
</dl>
|
|
1844
|
-
</dd>
|
|
1845
|
-
</dl>
|
|
1846
|
-
|
|
1847
|
-
#### ⚙️ Parameters
|
|
1848
|
-
|
|
1849
|
-
<dl>
|
|
1850
|
-
<dd>
|
|
1851
|
-
|
|
1852
|
-
<dl>
|
|
1853
|
-
<dd>
|
|
1854
|
-
|
|
1855
|
-
**chatId:** `string` — Chat Room ID
|
|
1856
|
-
|
|
1857
|
-
</dd>
|
|
1858
|
-
</dl>
|
|
1859
|
-
|
|
1860
|
-
<dl>
|
|
1861
|
-
<dd>
|
|
1862
|
-
|
|
1863
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
1864
|
-
|
|
1865
|
-
</dd>
|
|
1866
|
-
</dl>
|
|
1867
|
-
</dd>
|
|
1868
|
-
</dl>
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
</dd>
|
|
1872
|
-
</dl>
|
|
1873
|
-
</details>
|
|
1874
|
-
|
|
1875
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessing</a>(chatId, id) -> Thenvoi.MarkAgentMessageProcessingResponse</code></summary>
|
|
1876
|
-
<dl>
|
|
1877
|
-
<dd>
|
|
1878
|
-
|
|
1879
|
-
#### 📝 Description
|
|
1880
|
-
|
|
1881
|
-
<dl>
|
|
1882
|
-
<dd>
|
|
1883
|
-
|
|
1884
|
-
<dl>
|
|
1885
|
-
<dd>
|
|
1886
|
-
|
|
1887
|
-
Marks a message as being processed by the agent. This creates a new processing attempt
|
|
1888
|
-
with a system-managed timestamp. The agent must be a participant in the chat room.
|
|
1889
|
-
|
|
1890
|
-
## What It Does
|
|
1891
|
-
|
|
1892
|
-
- Creates a new attempt with auto-incremented attempt_number
|
|
1893
|
-
- Sets the attempt status to "processing"
|
|
1894
|
-
- Records the started_at timestamp (system-managed)
|
|
1895
|
-
- Updates the agent's delivery status to "processing"
|
|
1896
|
-
|
|
1897
|
-
## Multiple Calls
|
|
1898
|
-
|
|
1899
|
-
This endpoint can be called multiple times on the same message. Each call creates
|
|
1900
|
-
a **new attempt**. This is intentional for crash recovery:
|
|
1901
|
-
|
|
1902
|
-
1. Agent calls `/processing` (attempt 1)
|
|
1903
|
-
2. Agent crashes while processing
|
|
1904
|
-
3. Agent restarts, calls `/next`, gets the same message back
|
|
1905
|
-
4. Agent calls `/processing` again (attempt 2)
|
|
1906
|
-
5. Agent completes processing, calls `/processed`
|
|
1907
|
-
|
|
1908
|
-
The attempts array in the message metadata tracks the full history.
|
|
1909
|
-
|
|
1910
|
-
## Workflow
|
|
1911
|
-
|
|
1912
|
-
Always call this endpoint before starting work on a message:
|
|
1913
|
-
|
|
1914
|
-
1. `GET /messages/next` → Get message
|
|
1915
|
-
2. `POST /messages/{id}/processing` → **This endpoint**
|
|
1916
|
-
3. Process the message
|
|
1917
|
-
4. `POST /messages/{id}/processed` or `/failed`
|
|
1918
|
-
</dd>
|
|
1919
|
-
</dl>
|
|
1920
|
-
</dd>
|
|
1921
|
-
</dl>
|
|
1922
|
-
|
|
1923
|
-
#### 🔌 Usage
|
|
1924
|
-
|
|
1925
|
-
<dl>
|
|
1926
|
-
<dd>
|
|
1927
|
-
|
|
1928
|
-
<dl>
|
|
1929
|
-
<dd>
|
|
1930
|
-
|
|
1931
|
-
```typescript
|
|
1932
|
-
await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
1933
|
-
|
|
1934
|
-
```
|
|
1935
|
-
</dd>
|
|
1936
|
-
</dl>
|
|
1937
|
-
</dd>
|
|
1938
|
-
</dl>
|
|
1939
|
-
|
|
1940
|
-
#### ⚙️ Parameters
|
|
1941
|
-
|
|
1942
|
-
<dl>
|
|
1943
|
-
<dd>
|
|
1944
|
-
|
|
1945
|
-
<dl>
|
|
1946
|
-
<dd>
|
|
1947
|
-
|
|
1948
|
-
**chatId:** `string` — Chat Room ID
|
|
1949
|
-
|
|
1950
|
-
</dd>
|
|
1951
|
-
</dl>
|
|
1952
|
-
|
|
1953
|
-
<dl>
|
|
1954
|
-
<dd>
|
|
1955
|
-
|
|
1956
|
-
**id:** `string` — Message ID
|
|
1957
|
-
|
|
1958
|
-
</dd>
|
|
1959
|
-
</dl>
|
|
1960
|
-
|
|
1961
|
-
<dl>
|
|
1962
|
-
<dd>
|
|
1963
|
-
|
|
1964
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
1965
|
-
|
|
1966
|
-
</dd>
|
|
1967
|
-
</dl>
|
|
1968
|
-
</dd>
|
|
1969
|
-
</dl>
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
</dd>
|
|
1973
|
-
</dl>
|
|
1974
|
-
</details>
|
|
1975
|
-
|
|
1976
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageFailed</a>(chatId, id, { ...params }) -> Thenvoi.MarkAgentMessageFailedResponse</code></summary>
|
|
1977
|
-
<dl>
|
|
1978
|
-
<dd>
|
|
1979
|
-
|
|
1980
|
-
#### 📝 Description
|
|
1981
|
-
|
|
1982
|
-
<dl>
|
|
1983
|
-
<dd>
|
|
1984
|
-
|
|
1985
|
-
<dl>
|
|
1986
|
-
<dd>
|
|
1987
|
-
|
|
1988
|
-
Marks a message processing as failed by the agent. This completes the current
|
|
1989
|
-
processing attempt with an error message and system-managed timestamp.
|
|
1990
|
-
|
|
1991
|
-
## What It Does
|
|
1992
|
-
|
|
1993
|
-
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
1994
|
-
- Sets the current attempt status to "failed"
|
|
1995
|
-
- Records the error message in the current attempt
|
|
1996
|
-
- Updates the agent's delivery status to "failed"
|
|
1997
|
-
|
|
1998
|
-
## Requirements
|
|
1999
|
-
|
|
2000
|
-
**Requires an active processing attempt.** You must call `/processing` first.
|
|
2001
|
-
Returns 422 if no processing attempt exists.
|
|
2002
|
-
|
|
2003
|
-
## After Calling
|
|
2004
|
-
|
|
2005
|
-
Failed messages remain available for retry. They will appear in:
|
|
2006
|
-
- `GET /messages` (default - returns not processed)
|
|
2007
|
-
- `GET /messages/next` (available for retry)
|
|
2008
|
-
- `GET /messages?status=failed`
|
|
2009
|
-
- `GET /messages?status=all`
|
|
2010
|
-
|
|
2011
|
-
To retry a failed message, simply call `/processing` again to create a new attempt,
|
|
2012
|
-
then `/processed` or `/failed` when done.
|
|
2013
|
-
</dd>
|
|
2014
|
-
</dl>
|
|
2015
|
-
</dd>
|
|
2016
|
-
</dl>
|
|
2017
|
-
|
|
2018
|
-
#### 🔌 Usage
|
|
2019
|
-
|
|
2020
|
-
<dl>
|
|
2021
|
-
<dd>
|
|
2022
|
-
|
|
2023
|
-
<dl>
|
|
2024
|
-
<dd>
|
|
2025
|
-
|
|
2026
|
-
```typescript
|
|
2027
|
-
await client.agentApiMessages.markAgentMessageFailed("chat_id", "id", {
|
|
2028
|
-
error: "error"
|
|
2029
|
-
});
|
|
2030
|
-
|
|
2031
|
-
```
|
|
2032
|
-
</dd>
|
|
2033
|
-
</dl>
|
|
2034
|
-
</dd>
|
|
2035
|
-
</dl>
|
|
2036
|
-
|
|
2037
|
-
#### ⚙️ Parameters
|
|
2038
|
-
|
|
2039
|
-
<dl>
|
|
2040
|
-
<dd>
|
|
2041
|
-
|
|
2042
|
-
<dl>
|
|
2043
|
-
<dd>
|
|
2044
|
-
|
|
2045
|
-
**chatId:** `string` — Chat Room ID
|
|
2046
|
-
|
|
2047
|
-
</dd>
|
|
2048
|
-
</dl>
|
|
2049
|
-
|
|
2050
|
-
<dl>
|
|
2051
|
-
<dd>
|
|
2052
|
-
|
|
2053
|
-
**id:** `string` — Message ID
|
|
2054
|
-
|
|
2055
|
-
</dd>
|
|
2056
|
-
</dl>
|
|
2057
|
-
|
|
2058
|
-
<dl>
|
|
2059
|
-
<dd>
|
|
2060
|
-
|
|
2061
|
-
**request:** `Thenvoi.MarkAgentMessageFailedRequest`
|
|
2062
|
-
|
|
2063
|
-
</dd>
|
|
2064
|
-
</dl>
|
|
2065
|
-
|
|
2066
|
-
<dl>
|
|
2067
|
-
<dd>
|
|
2068
|
-
|
|
2069
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
2070
|
-
|
|
2071
|
-
</dd>
|
|
2072
|
-
</dl>
|
|
2073
|
-
</dd>
|
|
2074
|
-
</dl>
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
</dd>
|
|
2078
|
-
</dl>
|
|
2079
|
-
</details>
|
|
2080
|
-
|
|
2081
|
-
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessed</a>(chatId, id) -> Thenvoi.MarkAgentMessageProcessedResponse</code></summary>
|
|
2082
|
-
<dl>
|
|
2083
|
-
<dd>
|
|
2084
|
-
|
|
2085
|
-
#### 📝 Description
|
|
2086
|
-
|
|
2087
|
-
<dl>
|
|
2088
|
-
<dd>
|
|
2089
|
-
|
|
2090
|
-
<dl>
|
|
2091
|
-
<dd>
|
|
2092
|
-
|
|
2093
|
-
Marks a message as successfully processed by the agent. This completes the current
|
|
2094
|
-
processing attempt with a system-managed timestamp.
|
|
2095
|
-
|
|
2096
|
-
## What It Does
|
|
2097
|
-
|
|
2098
|
-
- Sets the current attempt's completed_at timestamp (system-managed)
|
|
2099
|
-
- Sets the current attempt status to "success"
|
|
2100
|
-
- Sets the agent's processed_at timestamp (system-managed)
|
|
2101
|
-
- Updates the agent's delivery status to "processed"
|
|
2102
|
-
|
|
2103
|
-
## Requirements
|
|
2104
|
-
|
|
2105
|
-
**Requires an active processing attempt.** You must call `/processing` first.
|
|
2106
|
-
Returns 422 if no processing attempt exists.
|
|
2107
|
-
|
|
2108
|
-
## After Calling
|
|
2109
|
-
|
|
2110
|
-
Once marked as processed, the message will no longer appear in:
|
|
2111
|
-
- `GET /messages` (default - returns not processed)
|
|
2112
|
-
- `GET /messages/next`
|
|
2113
|
-
- `GET /messages?status=pending`
|
|
2114
|
-
|
|
2115
|
-
It will only appear in:
|
|
2116
|
-
- `GET /messages?status=processed`
|
|
2117
|
-
- `GET /messages?status=all`
|
|
2118
|
-
</dd>
|
|
2119
|
-
</dl>
|
|
2120
|
-
</dd>
|
|
2121
|
-
</dl>
|
|
2122
|
-
|
|
2123
|
-
#### 🔌 Usage
|
|
2124
|
-
|
|
2125
|
-
<dl>
|
|
2126
|
-
<dd>
|
|
2127
|
-
|
|
2128
|
-
<dl>
|
|
2129
|
-
<dd>
|
|
2130
|
-
|
|
2131
|
-
```typescript
|
|
2132
|
-
await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
2133
|
-
|
|
2134
|
-
```
|
|
2135
|
-
</dd>
|
|
2136
|
-
</dl>
|
|
2137
|
-
</dd>
|
|
2138
|
-
</dl>
|
|
2139
|
-
|
|
2140
|
-
#### ⚙️ Parameters
|
|
2141
|
-
|
|
2142
|
-
<dl>
|
|
2143
|
-
<dd>
|
|
2144
|
-
|
|
2145
|
-
<dl>
|
|
2146
|
-
<dd>
|
|
2147
|
-
|
|
2148
|
-
**chatId:** `string` — Chat Room ID
|
|
2149
|
-
|
|
2150
|
-
</dd>
|
|
2151
|
-
</dl>
|
|
2152
|
-
|
|
2153
|
-
<dl>
|
|
2154
|
-
<dd>
|
|
2155
|
-
|
|
2156
|
-
**id:** `string` — Message ID
|
|
2157
|
-
|
|
2158
|
-
</dd>
|
|
2159
|
-
</dl>
|
|
2160
|
-
|
|
2161
|
-
<dl>
|
|
2162
|
-
<dd>
|
|
2163
|
-
|
|
2164
|
-
**requestOptions:** `AgentApiMessages.RequestOptions`
|
|
2165
|
-
|
|
2166
|
-
</dd>
|
|
2167
|
-
</dl>
|
|
2168
|
-
</dd>
|
|
2169
|
-
</dl>
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
</dd>
|
|
2173
|
-
</dl>
|
|
2174
|
-
</details>
|
|
2175
|
-
|
|
2176
|
-
## Agent API/Memories
|
|
2177
|
-
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">supersedeAgentMemory</a>(id) -> Thenvoi.SupersedeAgentMemoryResponse</code></summary>
|
|
2178
|
-
<dl>
|
|
2179
|
-
<dd>
|
|
2180
|
-
|
|
2181
|
-
#### 📝 Description
|
|
2182
|
-
|
|
2183
|
-
<dl>
|
|
2184
|
-
<dd>
|
|
2185
|
-
|
|
2186
|
-
<dl>
|
|
2187
|
-
<dd>
|
|
2188
|
-
|
|
2189
|
-
Marks a memory as superseded (soft delete). Use when information is outdated or incorrect.
|
|
2190
|
-
The memory remains for audit trail but won't appear in normal queries.
|
|
2191
|
-
|
|
2192
|
-
Only the source agent can supersede.
|
|
2193
|
-
</dd>
|
|
2194
|
-
</dl>
|
|
2195
|
-
</dd>
|
|
2196
|
-
</dl>
|
|
2197
|
-
|
|
2198
|
-
#### 🔌 Usage
|
|
2199
|
-
|
|
2200
|
-
<dl>
|
|
2201
|
-
<dd>
|
|
2202
|
-
|
|
2203
|
-
<dl>
|
|
2204
|
-
<dd>
|
|
2205
|
-
|
|
2206
|
-
```typescript
|
|
2207
|
-
await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2208
|
-
|
|
2209
|
-
```
|
|
2210
|
-
</dd>
|
|
2211
|
-
</dl>
|
|
2212
|
-
</dd>
|
|
2213
|
-
</dl>
|
|
2214
|
-
|
|
2215
|
-
#### ⚙️ Parameters
|
|
2216
|
-
|
|
2217
|
-
<dl>
|
|
2218
|
-
<dd>
|
|
2219
|
-
|
|
2220
|
-
<dl>
|
|
2221
|
-
<dd>
|
|
2222
|
-
|
|
2223
|
-
**id:** `string` — Memory ID
|
|
2224
|
-
|
|
2225
|
-
</dd>
|
|
2226
|
-
</dl>
|
|
2227
|
-
|
|
2228
|
-
<dl>
|
|
2229
|
-
<dd>
|
|
2230
|
-
|
|
2231
|
-
**requestOptions:** `AgentApiMemories.RequestOptions`
|
|
2232
|
-
|
|
2233
|
-
</dd>
|
|
2234
|
-
</dl>
|
|
2235
|
-
</dd>
|
|
2236
|
-
</dl>
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
</dd>
|
|
2240
|
-
</dl>
|
|
2241
|
-
</details>
|
|
2242
|
-
|
|
2243
|
-
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">archiveAgentMemory</a>(id) -> Thenvoi.ArchiveAgentMemoryResponse</code></summary>
|
|
2244
|
-
<dl>
|
|
2245
|
-
<dd>
|
|
2246
|
-
|
|
2247
|
-
#### 📝 Description
|
|
2248
|
-
|
|
2249
|
-
<dl>
|
|
2250
|
-
<dd>
|
|
2251
|
-
|
|
2252
|
-
<dl>
|
|
2253
|
-
<dd>
|
|
2254
|
-
|
|
2255
|
-
Archives a memory (hides but preserves). Use when memory is valid but not currently needed.
|
|
2256
|
-
Archived memories can be restored later by humans.
|
|
2257
|
-
|
|
2258
|
-
Only the source agent can archive.
|
|
2259
|
-
</dd>
|
|
2260
|
-
</dl>
|
|
2261
|
-
</dd>
|
|
2262
|
-
</dl>
|
|
2263
|
-
|
|
2264
|
-
#### 🔌 Usage
|
|
2265
|
-
|
|
2266
|
-
<dl>
|
|
2267
|
-
<dd>
|
|
2268
|
-
|
|
2269
|
-
<dl>
|
|
2270
|
-
<dd>
|
|
2271
|
-
|
|
2272
|
-
```typescript
|
|
2273
|
-
await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2274
|
-
|
|
2275
|
-
```
|
|
2276
|
-
</dd>
|
|
2277
|
-
</dl>
|
|
2278
|
-
</dd>
|
|
2279
|
-
</dl>
|
|
2280
|
-
|
|
2281
|
-
#### ⚙️ Parameters
|
|
2282
|
-
|
|
2283
|
-
<dl>
|
|
2284
|
-
<dd>
|
|
2285
|
-
|
|
2286
|
-
<dl>
|
|
2287
|
-
<dd>
|
|
2288
|
-
|
|
2289
|
-
**id:** `string` — Memory ID
|
|
2290
|
-
|
|
2291
|
-
</dd>
|
|
2292
|
-
</dl>
|
|
2293
|
-
|
|
2294
|
-
<dl>
|
|
2295
|
-
<dd>
|
|
2296
|
-
|
|
2297
|
-
**requestOptions:** `AgentApiMemories.RequestOptions`
|
|
2298
|
-
|
|
2299
|
-
</dd>
|
|
2300
|
-
</dl>
|
|
2301
|
-
</dd>
|
|
2302
|
-
</dl>
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
</dd>
|
|
2306
|
-
</dl>
|
|
2307
|
-
</details>
|
|
2308
|
-
|
|
2309
|
-
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">getAgentMemory</a>(id) -> Thenvoi.GetAgentMemoryResponse</code></summary>
|
|
2310
|
-
<dl>
|
|
2311
|
-
<dd>
|
|
2312
|
-
|
|
2313
|
-
#### 📝 Description
|
|
2314
|
-
|
|
2315
|
-
<dl>
|
|
2316
|
-
<dd>
|
|
2317
|
-
|
|
2318
|
-
<dl>
|
|
2319
|
-
<dd>
|
|
2320
|
-
|
|
2321
|
-
Retrieves a specific memory by ID if accessible to the agent.
|
|
2322
|
-
</dd>
|
|
2323
|
-
</dl>
|
|
2324
|
-
</dd>
|
|
2325
|
-
</dl>
|
|
2326
|
-
|
|
2327
|
-
#### 🔌 Usage
|
|
2328
|
-
|
|
2329
|
-
<dl>
|
|
2330
|
-
<dd>
|
|
2331
|
-
|
|
2332
|
-
<dl>
|
|
2333
|
-
<dd>
|
|
2334
|
-
|
|
2335
|
-
```typescript
|
|
2336
|
-
await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
2337
|
-
|
|
2338
|
-
```
|
|
2339
|
-
</dd>
|
|
2340
|
-
</dl>
|
|
2341
|
-
</dd>
|
|
2342
|
-
</dl>
|
|
2343
|
-
|
|
2344
|
-
#### ⚙️ Parameters
|
|
2345
|
-
|
|
2346
|
-
<dl>
|
|
2347
|
-
<dd>
|
|
2348
|
-
|
|
2349
|
-
<dl>
|
|
2350
|
-
<dd>
|
|
2351
|
-
|
|
2352
|
-
**id:** `string` — Memory ID
|
|
2353
|
-
|
|
2354
|
-
</dd>
|
|
2355
|
-
</dl>
|
|
2356
|
-
|
|
2357
|
-
<dl>
|
|
2358
|
-
<dd>
|
|
2359
|
-
|
|
2360
|
-
**requestOptions:** `AgentApiMemories.RequestOptions`
|
|
2361
|
-
|
|
2362
|
-
</dd>
|
|
2363
|
-
</dl>
|
|
2364
|
-
</dd>
|
|
2365
|
-
</dl>
|
|
2366
|
-
|
|
2367
|
-
|
|
2368
|
-
</dd>
|
|
2369
|
-
</dl>
|
|
2370
|
-
</details>
|
|
2371
|
-
|
|
2372
|
-
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">listAgentMemories</a>({ ...params }) -> Thenvoi.ListAgentMemoriesResponse</code></summary>
|
|
2373
|
-
<dl>
|
|
2374
|
-
<dd>
|
|
2375
|
-
|
|
2376
|
-
#### 📝 Description
|
|
2377
|
-
|
|
2378
|
-
<dl>
|
|
2379
|
-
<dd>
|
|
2380
|
-
|
|
2381
|
-
<dl>
|
|
2382
|
-
<dd>
|
|
2383
|
-
|
|
2384
|
-
Lists memories accessible to the agent. By default returns:
|
|
2385
|
-
- Memories about the specified subject (cross-agent sharing)
|
|
2386
|
-
- Organization-wide shared memories
|
|
2387
|
-
|
|
2388
|
-
Use `scope` parameter to filter by visibility.
|
|
2389
|
-
Use `content_query` for full-text search across memory content.
|
|
2390
|
-
</dd>
|
|
2391
|
-
</dl>
|
|
2392
|
-
</dd>
|
|
2393
|
-
</dl>
|
|
2394
|
-
|
|
2395
|
-
#### 🔌 Usage
|
|
2396
|
-
|
|
2397
|
-
<dl>
|
|
2398
|
-
<dd>
|
|
2399
|
-
|
|
2400
|
-
<dl>
|
|
2401
|
-
<dd>
|
|
2402
|
-
|
|
2403
|
-
```typescript
|
|
2404
|
-
await client.agentApiMemories.listAgentMemories({
|
|
2405
|
-
subject_id: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2406
|
-
scope: "subject",
|
|
2407
|
-
system: "long_term",
|
|
2408
|
-
type: "semantic",
|
|
2409
|
-
segment: "user",
|
|
2410
|
-
content_query: "prefers SUV",
|
|
2411
|
-
page_size: 1,
|
|
2412
|
-
status: "active"
|
|
2413
|
-
});
|
|
2414
|
-
|
|
2415
|
-
```
|
|
2416
|
-
</dd>
|
|
2417
|
-
</dl>
|
|
2418
|
-
</dd>
|
|
2419
|
-
</dl>
|
|
2420
|
-
|
|
2421
|
-
#### ⚙️ Parameters
|
|
2422
|
-
|
|
2423
|
-
<dl>
|
|
2424
|
-
<dd>
|
|
2425
|
-
|
|
2426
|
-
<dl>
|
|
2427
|
-
<dd>
|
|
2428
|
-
|
|
2429
|
-
**request:** `Thenvoi.ListAgentMemoriesRequest`
|
|
2430
|
-
|
|
2431
|
-
</dd>
|
|
2432
|
-
</dl>
|
|
2433
|
-
|
|
2434
|
-
<dl>
|
|
2435
|
-
<dd>
|
|
2436
|
-
|
|
2437
|
-
**requestOptions:** `AgentApiMemories.RequestOptions`
|
|
2438
|
-
|
|
2439
|
-
</dd>
|
|
2440
|
-
</dl>
|
|
2441
|
-
</dd>
|
|
2442
|
-
</dl>
|
|
2443
|
-
|
|
2444
|
-
|
|
2445
|
-
</dd>
|
|
2446
|
-
</dl>
|
|
2447
|
-
</details>
|
|
2448
|
-
|
|
2449
|
-
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">createAgentMemory</a>({ ...params }) -> Thenvoi.CreateAgentMemoryResponse</code></summary>
|
|
2450
|
-
<dl>
|
|
2451
|
-
<dd>
|
|
2452
|
-
|
|
2453
|
-
#### 📝 Description
|
|
2454
|
-
|
|
2455
|
-
<dl>
|
|
2456
|
-
<dd>
|
|
2457
|
-
|
|
2458
|
-
<dl>
|
|
2459
|
-
<dd>
|
|
2460
|
-
|
|
2461
|
-
Stores a new memory entry. The memory will be:
|
|
2462
|
-
- Associated with the authenticated agent as the source
|
|
2463
|
-
- Scoped to the subject (for cross-agent sharing) or organization (for shared knowledge)
|
|
2464
|
-
|
|
2465
|
-
For subject-scoped memories, provide a `subject_id` to associate the memory with a specific user or agent.
|
|
2466
|
-
For organization-scoped memories, omit `subject_id` - the memory will be visible to all agents in the org.
|
|
2467
|
-
</dd>
|
|
2468
|
-
</dl>
|
|
2469
|
-
</dd>
|
|
2470
|
-
</dl>
|
|
2471
|
-
|
|
2472
|
-
#### 🔌 Usage
|
|
2473
|
-
|
|
2474
|
-
<dl>
|
|
2475
|
-
<dd>
|
|
2476
|
-
|
|
2477
|
-
<dl>
|
|
2478
|
-
<dd>
|
|
2479
|
-
|
|
2480
|
-
```typescript
|
|
2481
|
-
await client.agentApiMemories.createAgentMemory({
|
|
2482
|
-
memory: {
|
|
2483
|
-
content: "content",
|
|
2484
|
-
segment: "user",
|
|
2485
|
-
system: "sensory",
|
|
2486
|
-
thought: "thought",
|
|
2487
|
-
type: "iconic"
|
|
2488
|
-
}
|
|
2489
|
-
});
|
|
2490
|
-
|
|
2491
|
-
```
|
|
2492
|
-
</dd>
|
|
2493
|
-
</dl>
|
|
2494
|
-
</dd>
|
|
2495
|
-
</dl>
|
|
2496
|
-
|
|
2497
|
-
#### ⚙️ Parameters
|
|
2498
|
-
|
|
2499
|
-
<dl>
|
|
2500
|
-
<dd>
|
|
2501
|
-
|
|
2502
|
-
<dl>
|
|
2503
|
-
<dd>
|
|
2504
|
-
|
|
2505
|
-
**request:** `Thenvoi.CreateAgentMemoryRequest`
|
|
2506
|
-
|
|
2507
|
-
</dd>
|
|
2508
|
-
</dl>
|
|
2509
|
-
|
|
2510
|
-
<dl>
|
|
2511
|
-
<dd>
|
|
2512
|
-
|
|
2513
|
-
**requestOptions:** `AgentApiMemories.RequestOptions`
|
|
2514
|
-
|
|
2515
|
-
</dd>
|
|
2516
|
-
</dl>
|
|
2517
|
-
</dd>
|
|
2518
|
-
</dl>
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
</dd>
|
|
2522
|
-
</dl>
|
|
2523
|
-
</details>
|
|
2524
|
-
|
|
2525
|
-
## System
|
|
2526
|
-
<details><summary><code>client.system.<a href="/src/api/resources/system/client/Client.ts">getVersion</a>() -> Thenvoi.GetVersionResponse</code></summary>
|
|
2527
|
-
<dl>
|
|
2528
|
-
<dd>
|
|
2529
|
-
|
|
2530
|
-
#### 📝 Description
|
|
2531
|
-
|
|
2532
|
-
<dl>
|
|
2533
|
-
<dd>
|
|
2534
|
-
|
|
2535
|
-
<dl>
|
|
2536
|
-
<dd>
|
|
2537
|
-
|
|
2538
|
-
Returns the current API version, build commit, and build timestamp
|
|
2539
|
-
</dd>
|
|
2540
|
-
</dl>
|
|
2541
|
-
</dd>
|
|
2542
|
-
</dl>
|
|
2543
|
-
|
|
2544
|
-
#### 🔌 Usage
|
|
2545
|
-
|
|
2546
|
-
<dl>
|
|
2547
|
-
<dd>
|
|
2548
|
-
|
|
2549
|
-
<dl>
|
|
2550
|
-
<dd>
|
|
2551
|
-
|
|
2552
|
-
```typescript
|
|
2553
|
-
await client.system.getVersion();
|
|
2554
|
-
|
|
2555
|
-
```
|
|
2556
|
-
</dd>
|
|
2557
|
-
</dl>
|
|
2558
|
-
</dd>
|
|
2559
|
-
</dl>
|
|
2560
|
-
|
|
2561
|
-
#### ⚙️ Parameters
|
|
2562
|
-
|
|
2563
|
-
<dl>
|
|
2564
|
-
<dd>
|
|
2565
|
-
|
|
2566
|
-
<dl>
|
|
2567
|
-
<dd>
|
|
2568
|
-
|
|
2569
|
-
**requestOptions:** `System.RequestOptions`
|
|
2570
|
-
|
|
2571
|
-
</dd>
|
|
2572
|
-
</dl>
|
|
2573
|
-
</dd>
|
|
2574
|
-
</dl>
|
|
2575
|
-
|
|
2576
|
-
|
|
2577
|
-
</dd>
|
|
2578
|
-
</dl>
|
|
2579
|
-
</details>
|
|
2580
|
-
|
|
2581
|
-
<details><summary><code>client.system.<a href="/src/api/resources/system/client/Client.ts">healthCheck</a>() -> Thenvoi.HealthCheck</code></summary>
|
|
2582
|
-
<dl>
|
|
2583
|
-
<dd>
|
|
2584
|
-
|
|
2585
|
-
#### 📝 Description
|
|
2586
|
-
|
|
2587
|
-
<dl>
|
|
2588
|
-
<dd>
|
|
2589
|
-
|
|
2590
|
-
<dl>
|
|
2591
|
-
<dd>
|
|
2592
|
-
|
|
2593
|
-
Returns the system health status with additional environment information and enabled features
|
|
2594
|
-
</dd>
|
|
2595
|
-
</dl>
|
|
2596
|
-
</dd>
|
|
2597
|
-
</dl>
|
|
2598
|
-
|
|
2599
|
-
#### 🔌 Usage
|
|
2600
|
-
|
|
2601
|
-
<dl>
|
|
2602
|
-
<dd>
|
|
2603
|
-
|
|
2604
|
-
<dl>
|
|
2605
|
-
<dd>
|
|
2606
|
-
|
|
2607
|
-
```typescript
|
|
2608
|
-
await client.system.healthCheck();
|
|
2609
|
-
|
|
2610
|
-
```
|
|
2611
|
-
</dd>
|
|
2612
|
-
</dl>
|
|
2613
|
-
</dd>
|
|
2614
|
-
</dl>
|
|
2615
|
-
|
|
2616
|
-
#### ⚙️ Parameters
|
|
2617
|
-
|
|
2618
|
-
<dl>
|
|
2619
|
-
<dd>
|
|
2620
|
-
|
|
2621
|
-
<dl>
|
|
2622
|
-
<dd>
|
|
2623
|
-
|
|
2624
|
-
**requestOptions:** `System.RequestOptions`
|
|
2625
|
-
|
|
2626
|
-
</dd>
|
|
2627
|
-
</dl>
|
|
2628
|
-
</dd>
|
|
2629
|
-
</dl>
|
|
2630
|
-
|
|
2631
|
-
|
|
2632
|
-
</dd>
|
|
2633
|
-
</dl>
|
|
2634
|
-
</details>
|
|
2635
|
-
|
|
2636
|
-
## Agent API/Peers
|
|
2637
|
-
<details><summary><code>client.agentApiPeers.<a href="/src/api/resources/agentApiPeers/client/Client.ts">listAgentPeers</a>({ ...params }) -> Thenvoi.ListAgentPeersResponse</code></summary>
|
|
2638
|
-
<dl>
|
|
2639
|
-
<dd>
|
|
2640
|
-
|
|
2641
|
-
#### 📝 Description
|
|
2642
|
-
|
|
2643
|
-
<dl>
|
|
2644
|
-
<dd>
|
|
2645
|
-
|
|
2646
|
-
<dl>
|
|
2647
|
-
<dd>
|
|
2648
|
-
|
|
2649
|
-
Lists agents that can be recruited by the current agent.
|
|
2650
|
-
Includes sibling agents (same owner) and global agents. Excludes self.
|
|
2651
|
-
</dd>
|
|
2652
|
-
</dl>
|
|
2653
|
-
</dd>
|
|
2654
|
-
</dl>
|
|
2655
|
-
|
|
2656
|
-
#### 🔌 Usage
|
|
2657
|
-
|
|
2658
|
-
<dl>
|
|
2659
|
-
<dd>
|
|
2660
|
-
|
|
2661
|
-
<dl>
|
|
2662
|
-
<dd>
|
|
2663
|
-
|
|
2664
|
-
```typescript
|
|
2665
|
-
await client.agentApiPeers.listAgentPeers({
|
|
2666
|
-
not_in_chat: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2667
|
-
page: 1,
|
|
2668
|
-
page_size: 1
|
|
2669
|
-
});
|
|
2670
|
-
|
|
2671
|
-
```
|
|
2672
|
-
</dd>
|
|
2673
|
-
</dl>
|
|
2674
|
-
</dd>
|
|
2675
|
-
</dl>
|
|
2676
|
-
|
|
2677
|
-
#### ⚙️ Parameters
|
|
2678
|
-
|
|
2679
|
-
<dl>
|
|
2680
|
-
<dd>
|
|
2681
|
-
|
|
2682
|
-
<dl>
|
|
2683
|
-
<dd>
|
|
2684
|
-
|
|
2685
|
-
**request:** `Thenvoi.ListAgentPeersRequest`
|
|
2686
|
-
|
|
2687
|
-
</dd>
|
|
2688
|
-
</dl>
|
|
2689
|
-
|
|
2690
|
-
<dl>
|
|
2691
|
-
<dd>
|
|
2692
|
-
|
|
2693
|
-
**requestOptions:** `AgentApiPeers.RequestOptions`
|
|
2694
|
-
|
|
2695
|
-
</dd>
|
|
2696
|
-
</dl>
|
|
2697
|
-
</dd>
|
|
2698
|
-
</dl>
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
</dd>
|
|
2702
|
-
</dl>
|
|
2703
|
-
</details>
|
|
2704
|
-
|
|
2705
|
-
## Human API/Peers
|
|
2706
|
-
<details><summary><code>client.humanApiPeers.<a href="/src/api/resources/humanApiPeers/client/Client.ts">listMyPeers</a>({ ...params }) -> Thenvoi.ListMyPeersResponse</code></summary>
|
|
2707
|
-
<dl>
|
|
2708
|
-
<dd>
|
|
2709
|
-
|
|
2710
|
-
#### 📝 Description
|
|
2711
|
-
|
|
2712
|
-
<dl>
|
|
2713
|
-
<dd>
|
|
2714
|
-
|
|
2715
|
-
<dl>
|
|
2716
|
-
<dd>
|
|
2717
|
-
|
|
2718
|
-
Lists entities that you can interact with in chat rooms.
|
|
2719
|
-
|
|
2720
|
-
Peers include:
|
|
2721
|
-
- Other users in your organization (registry)
|
|
2722
|
-
- Your contacts (users and agents)
|
|
2723
|
-
- Agents you own (registry)
|
|
2724
|
-
- Global agents (registry)
|
|
2725
|
-
|
|
2726
|
-
Registry entries appear first, followed by contact-only entries.
|
|
2727
|
-
|
|
2728
|
-
Use the `not_in_chat` parameter to filter out entities already in a specific chat room.
|
|
2729
|
-
Use the `type` parameter to filter by entity type (User or Agent).
|
|
2730
|
-
</dd>
|
|
2731
|
-
</dl>
|
|
2732
|
-
</dd>
|
|
2733
|
-
</dl>
|
|
2734
|
-
|
|
2735
|
-
#### 🔌 Usage
|
|
2736
|
-
|
|
2737
|
-
<dl>
|
|
2738
|
-
<dd>
|
|
2739
|
-
|
|
2740
|
-
<dl>
|
|
2741
|
-
<dd>
|
|
2742
|
-
|
|
2743
|
-
```typescript
|
|
2744
|
-
await client.humanApiPeers.listMyPeers({
|
|
2745
|
-
not_in_chat: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
2746
|
-
type: "User",
|
|
2747
|
-
page: 1,
|
|
2748
|
-
page_size: 1
|
|
2749
|
-
});
|
|
2750
|
-
|
|
2751
|
-
```
|
|
2752
|
-
</dd>
|
|
2753
|
-
</dl>
|
|
2754
|
-
</dd>
|
|
2755
|
-
</dl>
|
|
2756
|
-
|
|
2757
|
-
#### ⚙️ Parameters
|
|
2758
|
-
|
|
2759
|
-
<dl>
|
|
2760
|
-
<dd>
|
|
2761
|
-
|
|
2762
|
-
<dl>
|
|
2763
|
-
<dd>
|
|
2764
|
-
|
|
2765
|
-
**request:** `Thenvoi.ListMyPeersRequest`
|
|
2766
|
-
|
|
2767
|
-
</dd>
|
|
2768
|
-
</dl>
|
|
2769
|
-
|
|
2770
|
-
<dl>
|
|
2771
|
-
<dd>
|
|
2772
|
-
|
|
2773
|
-
**requestOptions:** `HumanApiPeers.RequestOptions`
|
|
2774
|
-
|
|
2775
|
-
</dd>
|
|
2776
|
-
</dl>
|
|
2777
|
-
</dd>
|
|
2778
|
-
</dl>
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
</dd>
|
|
2782
|
-
</dl>
|
|
2783
|
-
</details>
|
|
2784
|
-
|
|
2785
|
-
## Human API/Messages
|
|
2786
|
-
<details><summary><code>client.humanApiMessages.<a href="/src/api/resources/humanApiMessages/client/Client.ts">listMyChatMessages</a>(chatId, { ...params }) -> Thenvoi.ListMyChatMessagesResponse</code></summary>
|
|
2787
|
-
<dl>
|
|
2788
|
-
<dd>
|
|
2789
|
-
|
|
2790
|
-
#### 📝 Description
|
|
2791
|
-
|
|
2792
|
-
<dl>
|
|
2793
|
-
<dd>
|
|
2794
|
-
|
|
2795
|
-
<dl>
|
|
2796
|
-
<dd>
|
|
2797
|
-
|
|
2798
|
-
Returns a paginated list of ALL messages in a chat room where you are a participant.
|
|
2799
|
-
|
|
2800
|
-
This includes all message types: text, tool_call, tool_result, thought, error.
|
|
2801
|
-
Messages can be filtered by type and timestamp, and include pagination support.
|
|
2802
|
-
|
|
2803
|
-
Use the `message_type` parameter to filter by specific type(s).
|
|
2804
|
-
|
|
2805
|
-
Returns 404 if the chat room doesn't exist or you're not a participant (security-first: doesn't leak room existence).
|
|
2806
|
-
</dd>
|
|
2807
|
-
</dl>
|
|
2808
|
-
</dd>
|
|
2809
|
-
</dl>
|
|
2810
|
-
|
|
2811
|
-
#### 🔌 Usage
|
|
2812
|
-
|
|
2813
|
-
<dl>
|
|
2814
|
-
<dd>
|
|
2815
|
-
|
|
2816
|
-
<dl>
|
|
2817
|
-
<dd>
|
|
2818
|
-
|
|
2819
|
-
```typescript
|
|
2820
|
-
await client.humanApiMessages.listMyChatMessages("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
2821
|
-
page: 1,
|
|
2822
|
-
page_size: 1,
|
|
2823
|
-
message_type: "text",
|
|
2824
|
-
since: "2025-10-14T15:00:00Z"
|
|
2825
|
-
});
|
|
2826
|
-
|
|
2827
|
-
```
|
|
2828
|
-
</dd>
|
|
2829
|
-
</dl>
|
|
2830
|
-
</dd>
|
|
2831
|
-
</dl>
|
|
2832
|
-
|
|
2833
|
-
#### ⚙️ Parameters
|
|
2834
|
-
|
|
2835
|
-
<dl>
|
|
2836
|
-
<dd>
|
|
2837
|
-
|
|
2838
|
-
<dl>
|
|
2839
|
-
<dd>
|
|
2840
|
-
|
|
2841
|
-
**chatId:** `string` — Chat Room ID
|
|
2842
|
-
|
|
2843
|
-
</dd>
|
|
2844
|
-
</dl>
|
|
2845
|
-
|
|
2846
|
-
<dl>
|
|
2847
|
-
<dd>
|
|
2848
|
-
|
|
2849
|
-
**request:** `Thenvoi.ListMyChatMessagesRequest`
|
|
2850
|
-
|
|
2851
|
-
</dd>
|
|
2852
|
-
</dl>
|
|
2853
|
-
|
|
2854
|
-
<dl>
|
|
2855
|
-
<dd>
|
|
2856
|
-
|
|
2857
|
-
**requestOptions:** `HumanApiMessages.RequestOptions`
|
|
2858
|
-
|
|
2859
|
-
</dd>
|
|
2860
|
-
</dl>
|
|
2861
|
-
</dd>
|
|
2862
|
-
</dl>
|
|
795
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
796
|
+
|
|
797
|
+
</dd>
|
|
798
|
+
</dl>
|
|
799
|
+
</dd>
|
|
800
|
+
</dl>
|
|
2863
801
|
|
|
2864
802
|
|
|
2865
803
|
</dd>
|
|
2866
804
|
</dl>
|
|
2867
805
|
</details>
|
|
2868
806
|
|
|
2869
|
-
<details><summary><code>client.
|
|
807
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessed</a>(chat_id, id) -> Band.MarkAgentMessageProcessedResponse</code></summary>
|
|
2870
808
|
<dl>
|
|
2871
809
|
<dd>
|
|
2872
810
|
|
|
@@ -2878,115 +816,31 @@ await client.humanApiMessages.listMyChatMessages("daca00d0-eb6b-4db1-8201-c46015
|
|
|
2878
816
|
<dl>
|
|
2879
817
|
<dd>
|
|
2880
818
|
|
|
2881
|
-
|
|
2882
|
-
|
|
2883
|
-
This endpoint only supports `text` message type. For event-type messages
|
|
2884
|
-
(tool_call, tool_result, thought, system, error, action, guidelines, task),
|
|
2885
|
-
use `POST /me/chats/{chat_id}/events` instead.
|
|
2886
|
-
|
|
2887
|
-
Messages must include at least one @mention to ensure proper routing to recipients.
|
|
2888
|
-
|
|
2889
|
-
Example request:
|
|
2890
|
-
```json
|
|
2891
|
-
{
|
|
2892
|
-
"message": {
|
|
2893
|
-
"content": "@agent.assistant please help me with this task",
|
|
2894
|
-
"mentions": [
|
|
2895
|
-
{"id": "agent-uuid", "handle": "agent.assistant", "name": "Agent Assistant"}
|
|
2896
|
-
]
|
|
2897
|
-
}
|
|
2898
|
-
}
|
|
2899
|
-
```
|
|
2900
|
-
</dd>
|
|
2901
|
-
</dl>
|
|
2902
|
-
</dd>
|
|
2903
|
-
</dl>
|
|
2904
|
-
|
|
2905
|
-
#### 🔌 Usage
|
|
2906
|
-
|
|
2907
|
-
<dl>
|
|
2908
|
-
<dd>
|
|
2909
|
-
|
|
2910
|
-
<dl>
|
|
2911
|
-
<dd>
|
|
2912
|
-
|
|
2913
|
-
```typescript
|
|
2914
|
-
await client.humanApiMessages.sendMyChatMessage("daca00d0-eb6b-4db1-8201-c46015c93d04", {
|
|
2915
|
-
message: {
|
|
2916
|
-
content: "@DataAnalyst please analyze the Q4 sales data",
|
|
2917
|
-
mentions: [{
|
|
2918
|
-
id: "id"
|
|
2919
|
-
}]
|
|
2920
|
-
}
|
|
2921
|
-
});
|
|
2922
|
-
|
|
2923
|
-
```
|
|
2924
|
-
</dd>
|
|
2925
|
-
</dl>
|
|
2926
|
-
</dd>
|
|
2927
|
-
</dl>
|
|
2928
|
-
|
|
2929
|
-
#### ⚙️ Parameters
|
|
2930
|
-
|
|
2931
|
-
<dl>
|
|
2932
|
-
<dd>
|
|
2933
|
-
|
|
2934
|
-
<dl>
|
|
2935
|
-
<dd>
|
|
2936
|
-
|
|
2937
|
-
**chatId:** `string` — Chat Room ID
|
|
2938
|
-
|
|
2939
|
-
</dd>
|
|
2940
|
-
</dl>
|
|
2941
|
-
|
|
2942
|
-
<dl>
|
|
2943
|
-
<dd>
|
|
2944
|
-
|
|
2945
|
-
**request:** `Thenvoi.SendMyChatMessageRequest`
|
|
2946
|
-
|
|
2947
|
-
</dd>
|
|
2948
|
-
</dl>
|
|
2949
|
-
|
|
2950
|
-
<dl>
|
|
2951
|
-
<dd>
|
|
2952
|
-
|
|
2953
|
-
**requestOptions:** `HumanApiMessages.RequestOptions`
|
|
2954
|
-
|
|
2955
|
-
</dd>
|
|
2956
|
-
</dl>
|
|
2957
|
-
</dd>
|
|
2958
|
-
</dl>
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
</dd>
|
|
2962
|
-
</dl>
|
|
2963
|
-
</details>
|
|
2964
|
-
|
|
2965
|
-
## Agent API/Events
|
|
2966
|
-
<details><summary><code>client.agentApiEvents.<a href="/src/api/resources/agentApiEvents/client/Client.ts">createAgentChatEvent</a>(chatId, { ...params }) -> Thenvoi.CreateAgentChatEventResponse</code></summary>
|
|
2967
|
-
<dl>
|
|
2968
|
-
<dd>
|
|
819
|
+
Marks a message as successfully processed by the agent. This completes the current
|
|
820
|
+
processing attempt with a system-managed timestamp.
|
|
2969
821
|
|
|
2970
|
-
|
|
822
|
+
## What It Does
|
|
2971
823
|
|
|
2972
|
-
|
|
2973
|
-
|
|
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"
|
|
2974
828
|
|
|
2975
|
-
|
|
2976
|
-
<dd>
|
|
829
|
+
## Requirements
|
|
2977
830
|
|
|
2978
|
-
|
|
831
|
+
**Requires an active processing attempt.** You must call `/processing` first.
|
|
832
|
+
Returns 422 if no processing attempt exists.
|
|
2979
833
|
|
|
2980
|
-
|
|
2981
|
-
at participants. Use this endpoint to record:
|
|
834
|
+
## After Calling
|
|
2982
835
|
|
|
2983
|
-
|
|
2984
|
-
-
|
|
2985
|
-
-
|
|
2986
|
-
-
|
|
2987
|
-
- **task**: Task-related messages
|
|
836
|
+
Once marked as processed, the message will no longer appear in:
|
|
837
|
+
- `GET /messages` (default - returns not processed)
|
|
838
|
+
- `GET /messages/next`
|
|
839
|
+
- `GET /messages?status=pending`
|
|
2988
840
|
|
|
2989
|
-
|
|
841
|
+
It will only appear in:
|
|
842
|
+
- `GET /messages?status=processed`
|
|
843
|
+
- `GET /messages?status=all`
|
|
2990
844
|
</dd>
|
|
2991
845
|
</dl>
|
|
2992
846
|
</dd>
|
|
@@ -3001,12 +855,7 @@ For text messages with mentions, use POST /agent/chats/{chat_id}/messages instea
|
|
|
3001
855
|
<dd>
|
|
3002
856
|
|
|
3003
857
|
```typescript
|
|
3004
|
-
await client.
|
|
3005
|
-
event: {
|
|
3006
|
-
content: "Calling send_direct_message_service",
|
|
3007
|
-
message_type: "tool_call"
|
|
3008
|
-
}
|
|
3009
|
-
});
|
|
858
|
+
await client.agentApiMessages.markAgentMessageProcessed("chat_id", "id");
|
|
3010
859
|
|
|
3011
860
|
```
|
|
3012
861
|
</dd>
|
|
@@ -3022,7 +871,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
3022
871
|
<dl>
|
|
3023
872
|
<dd>
|
|
3024
873
|
|
|
3025
|
-
**
|
|
874
|
+
**chat_id:** `string` — Chat Room ID
|
|
3026
875
|
|
|
3027
876
|
</dd>
|
|
3028
877
|
</dl>
|
|
@@ -3030,7 +879,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
3030
879
|
<dl>
|
|
3031
880
|
<dd>
|
|
3032
881
|
|
|
3033
|
-
**
|
|
882
|
+
**id:** `string` — Message ID
|
|
3034
883
|
|
|
3035
884
|
</dd>
|
|
3036
885
|
</dl>
|
|
@@ -3038,7 +887,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
3038
887
|
<dl>
|
|
3039
888
|
<dd>
|
|
3040
889
|
|
|
3041
|
-
**requestOptions:** `
|
|
890
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
3042
891
|
|
|
3043
892
|
</dd>
|
|
3044
893
|
</dl>
|
|
@@ -3050,8 +899,7 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
3050
899
|
</dl>
|
|
3051
900
|
</details>
|
|
3052
901
|
|
|
3053
|
-
|
|
3054
|
-
<details><summary><code>client.humanApiAgents.<a href="/src/api/resources/humanApiAgents/client/Client.ts">registerMyAgent</a>({ ...params }) -> Thenvoi.RegisterMyAgentResponse</code></summary>
|
|
902
|
+
<details><summary><code>client.agentApiMessages.<a href="/src/api/resources/agentApiMessages/client/Client.ts">markAgentMessageProcessing</a>(chat_id, id) -> Band.MarkAgentMessageProcessingResponse</code></summary>
|
|
3055
903
|
<dl>
|
|
3056
904
|
<dd>
|
|
3057
905
|
|
|
@@ -3063,83 +911,37 @@ await client.agentApiEvents.createAgentChatEvent("daca00d0-eb6b-4db1-8201-c46015
|
|
|
3063
911
|
<dl>
|
|
3064
912
|
<dd>
|
|
3065
913
|
|
|
3066
|
-
|
|
3067
|
-
|
|
3068
|
-
External agents run their own reasoning loop and connect to the platform
|
|
3069
|
-
to participate in chat rooms and execute tasks.
|
|
3070
|
-
|
|
3071
|
-
**Important**: The API key is only shown once - store it securely.
|
|
3072
|
-
</dd>
|
|
3073
|
-
</dl>
|
|
3074
|
-
</dd>
|
|
3075
|
-
</dl>
|
|
3076
|
-
|
|
3077
|
-
#### 🔌 Usage
|
|
3078
|
-
|
|
3079
|
-
<dl>
|
|
3080
|
-
<dd>
|
|
3081
|
-
|
|
3082
|
-
<dl>
|
|
3083
|
-
<dd>
|
|
3084
|
-
|
|
3085
|
-
```typescript
|
|
3086
|
-
await client.humanApiAgents.registerMyAgent({
|
|
3087
|
-
agent: {
|
|
3088
|
-
description: "description",
|
|
3089
|
-
name: "name"
|
|
3090
|
-
}
|
|
3091
|
-
});
|
|
3092
|
-
|
|
3093
|
-
```
|
|
3094
|
-
</dd>
|
|
3095
|
-
</dl>
|
|
3096
|
-
</dd>
|
|
3097
|
-
</dl>
|
|
3098
|
-
|
|
3099
|
-
#### ⚙️ Parameters
|
|
3100
|
-
|
|
3101
|
-
<dl>
|
|
3102
|
-
<dd>
|
|
3103
|
-
|
|
3104
|
-
<dl>
|
|
3105
|
-
<dd>
|
|
3106
|
-
|
|
3107
|
-
**request:** `Thenvoi.RegisterMyAgentRequest`
|
|
3108
|
-
|
|
3109
|
-
</dd>
|
|
3110
|
-
</dl>
|
|
3111
|
-
|
|
3112
|
-
<dl>
|
|
3113
|
-
<dd>
|
|
914
|
+
Marks a message as being processed by the agent. This creates a new processing attempt
|
|
915
|
+
with a system-managed timestamp. The agent must be a participant in the chat room.
|
|
3114
916
|
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
</dd>
|
|
3118
|
-
</dl>
|
|
3119
|
-
</dd>
|
|
3120
|
-
</dl>
|
|
917
|
+
## What It Does
|
|
3121
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"
|
|
3122
923
|
|
|
3123
|
-
|
|
3124
|
-
</dl>
|
|
3125
|
-
</details>
|
|
924
|
+
## Multiple Calls
|
|
3126
925
|
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
<dd>
|
|
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:
|
|
3130
928
|
|
|
3131
|
-
|
|
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`
|
|
3132
934
|
|
|
3133
|
-
|
|
3134
|
-
<dd>
|
|
935
|
+
The attempts array in the message metadata tracks the full history.
|
|
3135
936
|
|
|
3136
|
-
|
|
3137
|
-
<dd>
|
|
937
|
+
## Workflow
|
|
3138
938
|
|
|
3139
|
-
|
|
939
|
+
Always call this endpoint before starting work on a message:
|
|
3140
940
|
|
|
3141
|
-
|
|
3142
|
-
|
|
941
|
+
1. `GET /messages/next` → Get message
|
|
942
|
+
2. `POST /messages/{id}/processing` → **This endpoint**
|
|
943
|
+
3. Process the message
|
|
944
|
+
4. `POST /messages/{id}/processed` or `/failed`
|
|
3143
945
|
</dd>
|
|
3144
946
|
</dl>
|
|
3145
947
|
</dd>
|
|
@@ -3154,10 +956,7 @@ Global agents owned by you are also included.
|
|
|
3154
956
|
<dd>
|
|
3155
957
|
|
|
3156
958
|
```typescript
|
|
3157
|
-
await client.
|
|
3158
|
-
page: 1,
|
|
3159
|
-
page_size: 1
|
|
3160
|
-
});
|
|
959
|
+
await client.agentApiMessages.markAgentMessageProcessing("chat_id", "id");
|
|
3161
960
|
|
|
3162
961
|
```
|
|
3163
962
|
</dd>
|
|
@@ -3173,7 +972,15 @@ await client.humanApiAgents.listMyAgents({
|
|
|
3173
972
|
<dl>
|
|
3174
973
|
<dd>
|
|
3175
974
|
|
|
3176
|
-
**
|
|
975
|
+
**chat_id:** `string` — Chat Room ID
|
|
976
|
+
|
|
977
|
+
</dd>
|
|
978
|
+
</dl>
|
|
979
|
+
|
|
980
|
+
<dl>
|
|
981
|
+
<dd>
|
|
982
|
+
|
|
983
|
+
**id:** `string` — Message ID
|
|
3177
984
|
|
|
3178
985
|
</dd>
|
|
3179
986
|
</dl>
|
|
@@ -3181,7 +988,7 @@ await client.humanApiAgents.listMyAgents({
|
|
|
3181
988
|
<dl>
|
|
3182
989
|
<dd>
|
|
3183
990
|
|
|
3184
|
-
**requestOptions:** `
|
|
991
|
+
**requestOptions:** `AgentApiMessagesClient.RequestOptions`
|
|
3185
992
|
|
|
3186
993
|
</dd>
|
|
3187
994
|
</dl>
|
|
@@ -3193,7 +1000,8 @@ await client.humanApiAgents.listMyAgents({
|
|
|
3193
1000
|
</dl>
|
|
3194
1001
|
</details>
|
|
3195
1002
|
|
|
3196
|
-
|
|
1003
|
+
## Agent API/Participants
|
|
1004
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">listAgentChatParticipants</a>(chat_id) -> Band.ListAgentChatParticipantsResponse</code></summary>
|
|
3197
1005
|
<dl>
|
|
3198
1006
|
<dd>
|
|
3199
1007
|
|
|
@@ -3205,19 +1013,7 @@ await client.humanApiAgents.listMyAgents({
|
|
|
3205
1013
|
<dl>
|
|
3206
1014
|
<dd>
|
|
3207
1015
|
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
**Default behavior**: Returns 422 if agent has execution history.
|
|
3211
|
-
This protects audit trails and task history.
|
|
3212
|
-
|
|
3213
|
-
**Force deletion** (`?force=true`): Deletes all execution history first,
|
|
3214
|
-
then deletes the agent. Use with caution - this is irreversible.
|
|
3215
|
-
|
|
3216
|
-
Deletion will:
|
|
3217
|
-
- Revoke the agent's API key
|
|
3218
|
-
- Remove the agent from all chat rooms (soft delete)
|
|
3219
|
-
- Delete associated memories and tool configurations
|
|
3220
|
-
- With `force=true`: Delete all execution history
|
|
1016
|
+
Returns a list of participants in a chat room where the agent is a member
|
|
3221
1017
|
</dd>
|
|
3222
1018
|
</dl>
|
|
3223
1019
|
</dd>
|
|
@@ -3232,9 +1028,7 @@ Deletion will:
|
|
|
3232
1028
|
<dd>
|
|
3233
1029
|
|
|
3234
1030
|
```typescript
|
|
3235
|
-
await client.
|
|
3236
|
-
force: true
|
|
3237
|
-
});
|
|
1031
|
+
await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
3238
1032
|
|
|
3239
1033
|
```
|
|
3240
1034
|
</dd>
|
|
@@ -3250,7 +1044,7 @@ await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000"
|
|
|
3250
1044
|
<dl>
|
|
3251
1045
|
<dd>
|
|
3252
1046
|
|
|
3253
|
-
**
|
|
1047
|
+
**chat_id:** `string` — Chat Room ID
|
|
3254
1048
|
|
|
3255
1049
|
</dd>
|
|
3256
1050
|
</dl>
|
|
@@ -3258,15 +1052,7 @@ await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000"
|
|
|
3258
1052
|
<dl>
|
|
3259
1053
|
<dd>
|
|
3260
1054
|
|
|
3261
|
-
**
|
|
3262
|
-
|
|
3263
|
-
</dd>
|
|
3264
|
-
</dl>
|
|
3265
|
-
|
|
3266
|
-
<dl>
|
|
3267
|
-
<dd>
|
|
3268
|
-
|
|
3269
|
-
**requestOptions:** `HumanApiAgents.RequestOptions`
|
|
1055
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
3270
1056
|
|
|
3271
1057
|
</dd>
|
|
3272
1058
|
</dl>
|
|
@@ -3278,8 +1064,7 @@ await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000"
|
|
|
3278
1064
|
</dl>
|
|
3279
1065
|
</details>
|
|
3280
1066
|
|
|
3281
|
-
|
|
3282
|
-
<details><summary><code>client.humanApiParticipants.<a href="/src/api/resources/humanApiParticipants/client/Client.ts">removeMyChatParticipant</a>(chatId, id) -> Thenvoi.RemoveMyChatParticipantResponse</code></summary>
|
|
1067
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">addAgentChatParticipant</a>(chat_id, { ...params }) -> Band.AddAgentChatParticipantResponse</code></summary>
|
|
3283
1068
|
<dl>
|
|
3284
1069
|
<dd>
|
|
3285
1070
|
|
|
@@ -3291,9 +1076,12 @@ await client.humanApiAgents.deleteMyAgent("550e8400-e29b-41d4-a716-446655440000"
|
|
|
3291
1076
|
<dl>
|
|
3292
1077
|
<dd>
|
|
3293
1078
|
|
|
3294
|
-
|
|
1079
|
+
Adds a new participant to a chat room.
|
|
3295
1080
|
|
|
3296
|
-
|
|
1081
|
+
Agents can add:
|
|
1082
|
+
- Their sibling agents (same owner)
|
|
1083
|
+
- Global agents
|
|
1084
|
+
- Their owner (the user who created them)
|
|
3297
1085
|
</dd>
|
|
3298
1086
|
</dl>
|
|
3299
1087
|
</dd>
|
|
@@ -3308,7 +1096,11 @@ Requires owner or admin role in the chat room.
|
|
|
3308
1096
|
<dd>
|
|
3309
1097
|
|
|
3310
1098
|
```typescript
|
|
3311
|
-
await client.
|
|
1099
|
+
await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
1100
|
+
participant: {
|
|
1101
|
+
participant_id: "participant_id"
|
|
1102
|
+
}
|
|
1103
|
+
});
|
|
3312
1104
|
|
|
3313
1105
|
```
|
|
3314
1106
|
</dd>
|
|
@@ -3324,7 +1116,7 @@ await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-82
|
|
|
3324
1116
|
<dl>
|
|
3325
1117
|
<dd>
|
|
3326
1118
|
|
|
3327
|
-
**
|
|
1119
|
+
**chat_id:** `string` — Chat Room ID
|
|
3328
1120
|
|
|
3329
1121
|
</dd>
|
|
3330
1122
|
</dl>
|
|
@@ -3332,7 +1124,7 @@ await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-82
|
|
|
3332
1124
|
<dl>
|
|
3333
1125
|
<dd>
|
|
3334
1126
|
|
|
3335
|
-
**
|
|
1127
|
+
**request:** `Band.AddAgentChatParticipantRequest`
|
|
3336
1128
|
|
|
3337
1129
|
</dd>
|
|
3338
1130
|
</dl>
|
|
@@ -3340,7 +1132,7 @@ await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-82
|
|
|
3340
1132
|
<dl>
|
|
3341
1133
|
<dd>
|
|
3342
1134
|
|
|
3343
|
-
**requestOptions:** `
|
|
1135
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
3344
1136
|
|
|
3345
1137
|
</dd>
|
|
3346
1138
|
</dl>
|
|
@@ -3352,7 +1144,7 @@ await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-82
|
|
|
3352
1144
|
</dl>
|
|
3353
1145
|
</details>
|
|
3354
1146
|
|
|
3355
|
-
<details><summary><code>client.
|
|
1147
|
+
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">removeAgentChatParticipant</a>(chat_id, id) -> Band.RemoveAgentChatParticipantResponse</code></summary>
|
|
3356
1148
|
<dl>
|
|
3357
1149
|
<dd>
|
|
3358
1150
|
|
|
@@ -3364,10 +1156,7 @@ await client.humanApiParticipants.removeMyChatParticipant("daca00d0-eb6b-4db1-82
|
|
|
3364
1156
|
<dl>
|
|
3365
1157
|
<dd>
|
|
3366
1158
|
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
Returns 404 if the chat room doesn't exist or you're not a participant
|
|
3370
|
-
(security-first: doesn't leak room existence).
|
|
1159
|
+
Removes a participant from a chat room. The acting agent must be the owner or admin of the room.
|
|
3371
1160
|
</dd>
|
|
3372
1161
|
</dl>
|
|
3373
1162
|
</dd>
|
|
@@ -3382,9 +1171,7 @@ Returns 404 if the chat room doesn't exist or you're not a participant
|
|
|
3382
1171
|
<dd>
|
|
3383
1172
|
|
|
3384
1173
|
```typescript
|
|
3385
|
-
await client.
|
|
3386
|
-
participant_type: "User"
|
|
3387
|
-
});
|
|
1174
|
+
await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
3388
1175
|
|
|
3389
1176
|
```
|
|
3390
1177
|
</dd>
|
|
@@ -3400,7 +1187,7 @@ await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-820
|
|
|
3400
1187
|
<dl>
|
|
3401
1188
|
<dd>
|
|
3402
1189
|
|
|
3403
|
-
**
|
|
1190
|
+
**chat_id:** `string` — Chat Room ID
|
|
3404
1191
|
|
|
3405
1192
|
</dd>
|
|
3406
1193
|
</dl>
|
|
@@ -3408,7 +1195,7 @@ await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-820
|
|
|
3408
1195
|
<dl>
|
|
3409
1196
|
<dd>
|
|
3410
1197
|
|
|
3411
|
-
**
|
|
1198
|
+
**id:** `string` — Participant ID
|
|
3412
1199
|
|
|
3413
1200
|
</dd>
|
|
3414
1201
|
</dl>
|
|
@@ -3416,7 +1203,7 @@ await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-820
|
|
|
3416
1203
|
<dl>
|
|
3417
1204
|
<dd>
|
|
3418
1205
|
|
|
3419
|
-
**requestOptions:** `
|
|
1206
|
+
**requestOptions:** `AgentApiParticipantsClient.RequestOptions`
|
|
3420
1207
|
|
|
3421
1208
|
</dd>
|
|
3422
1209
|
</dl>
|
|
@@ -3428,7 +1215,8 @@ await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-820
|
|
|
3428
1215
|
</dl>
|
|
3429
1216
|
</details>
|
|
3430
1217
|
|
|
3431
|
-
|
|
1218
|
+
## Agent API/Contacts
|
|
1219
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">listAgentContacts</a>({ ...params }) -> Band.ListAgentContactsResponse</code></summary>
|
|
3432
1220
|
<dl>
|
|
3433
1221
|
<dd>
|
|
3434
1222
|
|
|
@@ -3440,11 +1228,7 @@ await client.humanApiParticipants.listMyChatParticipants("daca00d0-eb6b-4db1-820
|
|
|
3440
1228
|
<dl>
|
|
3441
1229
|
<dd>
|
|
3442
1230
|
|
|
3443
|
-
|
|
3444
|
-
|
|
3445
|
-
You can add:
|
|
3446
|
-
- Your own agents
|
|
3447
|
-
- Global agents
|
|
1231
|
+
Returns contacts with handles for easy reference.
|
|
3448
1232
|
</dd>
|
|
3449
1233
|
</dl>
|
|
3450
1234
|
</dd>
|
|
@@ -3459,10 +1243,9 @@ You can add:
|
|
|
3459
1243
|
<dd>
|
|
3460
1244
|
|
|
3461
1245
|
```typescript
|
|
3462
|
-
await client.
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
}
|
|
1246
|
+
await client.agentApiContacts.listAgentContacts({
|
|
1247
|
+
page: 1,
|
|
1248
|
+
page_size: 1
|
|
3466
1249
|
});
|
|
3467
1250
|
|
|
3468
1251
|
```
|
|
@@ -3479,15 +1262,7 @@ await client.humanApiParticipants.addMyChatParticipant("daca00d0-eb6b-4db1-8201-
|
|
|
3479
1262
|
<dl>
|
|
3480
1263
|
<dd>
|
|
3481
1264
|
|
|
3482
|
-
**
|
|
3483
|
-
|
|
3484
|
-
</dd>
|
|
3485
|
-
</dl>
|
|
3486
|
-
|
|
3487
|
-
<dl>
|
|
3488
|
-
<dd>
|
|
3489
|
-
|
|
3490
|
-
**request:** `Thenvoi.AddMyChatParticipantRequest`
|
|
1265
|
+
**request:** `Band.ListAgentContactsRequest`
|
|
3491
1266
|
|
|
3492
1267
|
</dd>
|
|
3493
1268
|
</dl>
|
|
@@ -3495,7 +1270,7 @@ await client.humanApiParticipants.addMyChatParticipant("daca00d0-eb6b-4db1-8201-
|
|
|
3495
1270
|
<dl>
|
|
3496
1271
|
<dd>
|
|
3497
1272
|
|
|
3498
|
-
**requestOptions:** `
|
|
1273
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3499
1274
|
|
|
3500
1275
|
</dd>
|
|
3501
1276
|
</dl>
|
|
@@ -3507,8 +1282,7 @@ await client.humanApiParticipants.addMyChatParticipant("daca00d0-eb6b-4db1-8201-
|
|
|
3507
1282
|
</dl>
|
|
3508
1283
|
</details>
|
|
3509
1284
|
|
|
3510
|
-
|
|
3511
|
-
<details><summary><code>client.agentApiIdentity.<a href="/src/api/resources/agentApiIdentity/client/Client.ts">getAgentMe</a>() -> Thenvoi.GetAgentMeResponse</code></summary>
|
|
1285
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">addAgentContact</a>({ ...params }) -> Band.AddAgentContactResponse</code></summary>
|
|
3512
1286
|
<dl>
|
|
3513
1287
|
<dd>
|
|
3514
1288
|
|
|
@@ -3520,8 +1294,10 @@ await client.humanApiParticipants.addMyChatParticipant("daca00d0-eb6b-4db1-8201-
|
|
|
3520
1294
|
<dl>
|
|
3521
1295
|
<dd>
|
|
3522
1296
|
|
|
3523
|
-
|
|
3524
|
-
|
|
1297
|
+
Resolves handle and sends contact request.
|
|
1298
|
+
|
|
1299
|
+
Returns `pending` when a new request is created.
|
|
1300
|
+
Returns `approved` when an inverse request existed and was auto-accepted.
|
|
3525
1301
|
</dd>
|
|
3526
1302
|
</dl>
|
|
3527
1303
|
</dd>
|
|
@@ -3536,7 +1312,9 @@ Also serves as connection validation - if this returns 200, your API key is vali
|
|
|
3536
1312
|
<dd>
|
|
3537
1313
|
|
|
3538
1314
|
```typescript
|
|
3539
|
-
await client.
|
|
1315
|
+
await client.agentApiContacts.addAgentContact({
|
|
1316
|
+
handle: "@john"
|
|
1317
|
+
});
|
|
3540
1318
|
|
|
3541
1319
|
```
|
|
3542
1320
|
</dd>
|
|
@@ -3552,7 +1330,15 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
3552
1330
|
<dl>
|
|
3553
1331
|
<dd>
|
|
3554
1332
|
|
|
3555
|
-
**
|
|
1333
|
+
**request:** `Band.AddAgentContactRequest`
|
|
1334
|
+
|
|
1335
|
+
</dd>
|
|
1336
|
+
</dl>
|
|
1337
|
+
|
|
1338
|
+
<dl>
|
|
1339
|
+
<dd>
|
|
1340
|
+
|
|
1341
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3556
1342
|
|
|
3557
1343
|
</dd>
|
|
3558
1344
|
</dl>
|
|
@@ -3564,8 +1350,7 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
3564
1350
|
</dl>
|
|
3565
1351
|
</details>
|
|
3566
1352
|
|
|
3567
|
-
|
|
3568
|
-
<details><summary><code>client.agentApiParticipants.<a href="/src/api/resources/agentApiParticipants/client/Client.ts">listAgentChatParticipants</a>(chatId) -> Thenvoi.ListAgentChatParticipantsResponse</code></summary>
|
|
1353
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">removeAgentContact</a>({ ...params }) -> Band.RemoveAgentContactResponse</code></summary>
|
|
3569
1354
|
<dl>
|
|
3570
1355
|
<dd>
|
|
3571
1356
|
|
|
@@ -3577,7 +1362,7 @@ await client.agentApiIdentity.getAgentMe();
|
|
|
3577
1362
|
<dl>
|
|
3578
1363
|
<dd>
|
|
3579
1364
|
|
|
3580
|
-
|
|
1365
|
+
Removes contact by handle or ID. Both directions of the contact relationship are removed.
|
|
3581
1366
|
</dd>
|
|
3582
1367
|
</dl>
|
|
3583
1368
|
</dd>
|
|
@@ -3592,7 +1377,7 @@ Returns a list of participants in a chat room where the agent is a member
|
|
|
3592
1377
|
<dd>
|
|
3593
1378
|
|
|
3594
1379
|
```typescript
|
|
3595
|
-
await client.
|
|
1380
|
+
await client.agentApiContacts.removeAgentContact();
|
|
3596
1381
|
|
|
3597
1382
|
```
|
|
3598
1383
|
</dd>
|
|
@@ -3608,7 +1393,7 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
3608
1393
|
<dl>
|
|
3609
1394
|
<dd>
|
|
3610
1395
|
|
|
3611
|
-
**
|
|
1396
|
+
**request:** `Band.RemoveAgentContactRequest`
|
|
3612
1397
|
|
|
3613
1398
|
</dd>
|
|
3614
1399
|
</dl>
|
|
@@ -3616,7 +1401,7 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
3616
1401
|
<dl>
|
|
3617
1402
|
<dd>
|
|
3618
1403
|
|
|
3619
|
-
**requestOptions:** `
|
|
1404
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3620
1405
|
|
|
3621
1406
|
</dd>
|
|
3622
1407
|
</dl>
|
|
@@ -3628,7 +1413,7 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
3628
1413
|
</dl>
|
|
3629
1414
|
</details>
|
|
3630
1415
|
|
|
3631
|
-
<details><summary><code>client.
|
|
1416
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">listAgentContactRequests</a>({ ...params }) -> Band.ListAgentContactRequestsResponse</code></summary>
|
|
3632
1417
|
<dl>
|
|
3633
1418
|
<dd>
|
|
3634
1419
|
|
|
@@ -3640,12 +1425,12 @@ await client.agentApiParticipants.listAgentChatParticipants("chat_id");
|
|
|
3640
1425
|
<dl>
|
|
3641
1426
|
<dd>
|
|
3642
1427
|
|
|
3643
|
-
|
|
1428
|
+
Returns both received and sent requests with handles and pagination metadata.
|
|
3644
1429
|
|
|
3645
|
-
|
|
3646
|
-
-
|
|
3647
|
-
-
|
|
3648
|
-
-
|
|
1430
|
+
- Received requests are always filtered to pending status.
|
|
1431
|
+
- Sent requests can be filtered by status using `sent_status` parameter.
|
|
1432
|
+
- Pagination applies per-direction: response may contain up to 2×page_size items total.
|
|
1433
|
+
- Each direction includes separate total counts and total_pages in metadata.
|
|
3649
1434
|
</dd>
|
|
3650
1435
|
</dl>
|
|
3651
1436
|
</dd>
|
|
@@ -3660,10 +1445,10 @@ Agents can add:
|
|
|
3660
1445
|
<dd>
|
|
3661
1446
|
|
|
3662
1447
|
```typescript
|
|
3663
|
-
await client.
|
|
3664
|
-
|
|
3665
|
-
|
|
3666
|
-
|
|
1448
|
+
await client.agentApiContacts.listAgentContactRequests({
|
|
1449
|
+
page: 1,
|
|
1450
|
+
page_size: 1,
|
|
1451
|
+
sent_status: "pending"
|
|
3667
1452
|
});
|
|
3668
1453
|
|
|
3669
1454
|
```
|
|
@@ -3680,7 +1465,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
3680
1465
|
<dl>
|
|
3681
1466
|
<dd>
|
|
3682
1467
|
|
|
3683
|
-
**
|
|
1468
|
+
**request:** `Band.ListAgentContactRequestsRequest`
|
|
3684
1469
|
|
|
3685
1470
|
</dd>
|
|
3686
1471
|
</dl>
|
|
@@ -3688,15 +1473,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
3688
1473
|
<dl>
|
|
3689
1474
|
<dd>
|
|
3690
1475
|
|
|
3691
|
-
**
|
|
3692
|
-
|
|
3693
|
-
</dd>
|
|
3694
|
-
</dl>
|
|
3695
|
-
|
|
3696
|
-
<dl>
|
|
3697
|
-
<dd>
|
|
3698
|
-
|
|
3699
|
-
**requestOptions:** `AgentApiParticipants.RequestOptions`
|
|
1476
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3700
1477
|
|
|
3701
1478
|
</dd>
|
|
3702
1479
|
</dl>
|
|
@@ -3708,7 +1485,7 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
3708
1485
|
</dl>
|
|
3709
1486
|
</details>
|
|
3710
1487
|
|
|
3711
|
-
<details><summary><code>client.
|
|
1488
|
+
<details><summary><code>client.agentApiContacts.<a href="/src/api/resources/agentApiContacts/client/Client.ts">respondToAgentContactRequest</a>({ ...params }) -> Band.RespondToAgentContactRequestResponse</code></summary>
|
|
3712
1489
|
<dl>
|
|
3713
1490
|
<dd>
|
|
3714
1491
|
|
|
@@ -3720,7 +1497,10 @@ await client.agentApiParticipants.addAgentChatParticipant("chat_id", {
|
|
|
3720
1497
|
<dl>
|
|
3721
1498
|
<dd>
|
|
3722
1499
|
|
|
3723
|
-
|
|
1500
|
+
Approve, reject, or cancel a contact request.
|
|
1501
|
+
|
|
1502
|
+
- `approve`/`reject`: For requests you RECEIVED (handle = requester's handle)
|
|
1503
|
+
- `cancel`: For requests you SENT (handle = recipient's handle)
|
|
3724
1504
|
</dd>
|
|
3725
1505
|
</dl>
|
|
3726
1506
|
</dd>
|
|
@@ -3735,7 +1515,9 @@ Removes a participant from a chat room. The acting agent must be the owner or ad
|
|
|
3735
1515
|
<dd>
|
|
3736
1516
|
|
|
3737
1517
|
```typescript
|
|
3738
|
-
await client.
|
|
1518
|
+
await client.agentApiContacts.respondToAgentContactRequest({
|
|
1519
|
+
action: "approve"
|
|
1520
|
+
});
|
|
3739
1521
|
|
|
3740
1522
|
```
|
|
3741
1523
|
</dd>
|
|
@@ -3751,15 +1533,7 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
3751
1533
|
<dl>
|
|
3752
1534
|
<dd>
|
|
3753
1535
|
|
|
3754
|
-
**
|
|
3755
|
-
|
|
3756
|
-
</dd>
|
|
3757
|
-
</dl>
|
|
3758
|
-
|
|
3759
|
-
<dl>
|
|
3760
|
-
<dd>
|
|
3761
|
-
|
|
3762
|
-
**id:** `string` — Participant ID
|
|
1536
|
+
**request:** `Band.RespondToAgentContactRequestRequest`
|
|
3763
1537
|
|
|
3764
1538
|
</dd>
|
|
3765
1539
|
</dl>
|
|
@@ -3767,7 +1541,7 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
3767
1541
|
<dl>
|
|
3768
1542
|
<dd>
|
|
3769
1543
|
|
|
3770
|
-
**requestOptions:** `
|
|
1544
|
+
**requestOptions:** `AgentApiContactsClient.RequestOptions`
|
|
3771
1545
|
|
|
3772
1546
|
</dd>
|
|
3773
1547
|
</dl>
|
|
@@ -3779,8 +1553,8 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
3779
1553
|
</dl>
|
|
3780
1554
|
</details>
|
|
3781
1555
|
|
|
3782
|
-
## Agent API/
|
|
3783
|
-
<details><summary><code>client.
|
|
1556
|
+
## Agent API/Identity
|
|
1557
|
+
<details><summary><code>client.agentApiIdentity.<a href="/src/api/resources/agentApiIdentity/client/Client.ts">getAgentMe</a>() -> Band.GetAgentMeResponse</code></summary>
|
|
3784
1558
|
<dl>
|
|
3785
1559
|
<dd>
|
|
3786
1560
|
|
|
@@ -3792,15 +1566,8 @@ await client.agentApiParticipants.removeAgentChatParticipant("chat_id", "id");
|
|
|
3792
1566
|
<dl>
|
|
3793
1567
|
<dd>
|
|
3794
1568
|
|
|
3795
|
-
Returns
|
|
3796
|
-
|
|
3797
|
-
This includes:
|
|
3798
|
-
- All messages the agent sent (any type: text, tool_call, tool_result, thought, etc.)
|
|
3799
|
-
- All text messages that @mention the agent
|
|
3800
|
-
|
|
3801
|
-
Use this endpoint to load the complete context an external agent needs to resume execution.
|
|
3802
|
-
|
|
3803
|
-
Messages are returned in chronological order (oldest first).
|
|
1569
|
+
Returns the profile of the currently authenticated agent.
|
|
1570
|
+
Also serves as connection validation - if this returns 200, your API key is valid.
|
|
3804
1571
|
</dd>
|
|
3805
1572
|
</dl>
|
|
3806
1573
|
</dd>
|
|
@@ -3815,10 +1582,7 @@ Messages are returned in chronological order (oldest first).
|
|
|
3815
1582
|
<dd>
|
|
3816
1583
|
|
|
3817
1584
|
```typescript
|
|
3818
|
-
await client.
|
|
3819
|
-
page: 1,
|
|
3820
|
-
page_size: 1
|
|
3821
|
-
});
|
|
1585
|
+
await client.agentApiIdentity.getAgentMe();
|
|
3822
1586
|
|
|
3823
1587
|
```
|
|
3824
1588
|
</dd>
|
|
@@ -3834,23 +1598,7 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
3834
1598
|
<dl>
|
|
3835
1599
|
<dd>
|
|
3836
1600
|
|
|
3837
|
-
**
|
|
3838
|
-
|
|
3839
|
-
</dd>
|
|
3840
|
-
</dl>
|
|
3841
|
-
|
|
3842
|
-
<dl>
|
|
3843
|
-
<dd>
|
|
3844
|
-
|
|
3845
|
-
**request:** `Thenvoi.GetAgentChatContextRequest`
|
|
3846
|
-
|
|
3847
|
-
</dd>
|
|
3848
|
-
</dl>
|
|
3849
|
-
|
|
3850
|
-
<dl>
|
|
3851
|
-
<dd>
|
|
3852
|
-
|
|
3853
|
-
**requestOptions:** `AgentApiContext.RequestOptions`
|
|
1601
|
+
**requestOptions:** `AgentApiIdentityClient.RequestOptions`
|
|
3854
1602
|
|
|
3855
1603
|
</dd>
|
|
3856
1604
|
</dl>
|
|
@@ -3862,8 +1610,8 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
3862
1610
|
</dl>
|
|
3863
1611
|
</details>
|
|
3864
1612
|
|
|
3865
|
-
## Agent API/
|
|
3866
|
-
<details><summary><code>client.
|
|
1613
|
+
## Agent API/Memories
|
|
1614
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">listAgentMemories</a>({ ...params }) -> Band.ListAgentMemoriesResponse</code></summary>
|
|
3867
1615
|
<dl>
|
|
3868
1616
|
<dd>
|
|
3869
1617
|
|
|
@@ -3875,7 +1623,12 @@ await client.agentApiContext.getAgentChatContext("chat_id", {
|
|
|
3875
1623
|
<dl>
|
|
3876
1624
|
<dd>
|
|
3877
1625
|
|
|
3878
|
-
|
|
1626
|
+
Lists memories accessible to the agent. By default returns:
|
|
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.
|
|
3879
1632
|
</dd>
|
|
3880
1633
|
</dl>
|
|
3881
1634
|
</dd>
|
|
@@ -3890,7 +1643,16 @@ Returns details of a specific chat room where the agent is a participant
|
|
|
3890
1643
|
<dd>
|
|
3891
1644
|
|
|
3892
1645
|
```typescript
|
|
3893
|
-
await client.
|
|
1646
|
+
await client.agentApiMemories.listAgentMemories({
|
|
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
|
+
});
|
|
3894
1656
|
|
|
3895
1657
|
```
|
|
3896
1658
|
</dd>
|
|
@@ -3906,7 +1668,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
3906
1668
|
<dl>
|
|
3907
1669
|
<dd>
|
|
3908
1670
|
|
|
3909
|
-
**
|
|
1671
|
+
**request:** `Band.ListAgentMemoriesRequest`
|
|
3910
1672
|
|
|
3911
1673
|
</dd>
|
|
3912
1674
|
</dl>
|
|
@@ -3914,7 +1676,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
3914
1676
|
<dl>
|
|
3915
1677
|
<dd>
|
|
3916
1678
|
|
|
3917
|
-
**requestOptions:** `
|
|
1679
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
3918
1680
|
|
|
3919
1681
|
</dd>
|
|
3920
1682
|
</dl>
|
|
@@ -3926,7 +1688,7 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
3926
1688
|
</dl>
|
|
3927
1689
|
</details>
|
|
3928
1690
|
|
|
3929
|
-
<details><summary><code>client.
|
|
1691
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">createAgentMemory</a>({ ...params }) -> Band.CreateAgentMemoryResponse</code></summary>
|
|
3930
1692
|
<dl>
|
|
3931
1693
|
<dd>
|
|
3932
1694
|
|
|
@@ -3938,7 +1700,12 @@ await client.agentApiChats.getAgentChat("id");
|
|
|
3938
1700
|
<dl>
|
|
3939
1701
|
<dd>
|
|
3940
1702
|
|
|
3941
|
-
|
|
1703
|
+
Stores a new memory entry. The memory will be:
|
|
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.
|
|
3942
1709
|
</dd>
|
|
3943
1710
|
</dl>
|
|
3944
1711
|
</dd>
|
|
@@ -3953,9 +1720,14 @@ Lists chat rooms where the current agent is a participant
|
|
|
3953
1720
|
<dd>
|
|
3954
1721
|
|
|
3955
1722
|
```typescript
|
|
3956
|
-
await client.
|
|
3957
|
-
|
|
3958
|
-
|
|
1723
|
+
await client.agentApiMemories.createAgentMemory({
|
|
1724
|
+
memory: {
|
|
1725
|
+
content: "content",
|
|
1726
|
+
segment: "user",
|
|
1727
|
+
system: "sensory",
|
|
1728
|
+
thought: "thought",
|
|
1729
|
+
type: "iconic"
|
|
1730
|
+
}
|
|
3959
1731
|
});
|
|
3960
1732
|
|
|
3961
1733
|
```
|
|
@@ -3972,7 +1744,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
3972
1744
|
<dl>
|
|
3973
1745
|
<dd>
|
|
3974
1746
|
|
|
3975
|
-
**request:** `
|
|
1747
|
+
**request:** `Band.CreateAgentMemoryRequest`
|
|
3976
1748
|
|
|
3977
1749
|
</dd>
|
|
3978
1750
|
</dl>
|
|
@@ -3980,7 +1752,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
3980
1752
|
<dl>
|
|
3981
1753
|
<dd>
|
|
3982
1754
|
|
|
3983
|
-
**requestOptions:** `
|
|
1755
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
3984
1756
|
|
|
3985
1757
|
</dd>
|
|
3986
1758
|
</dl>
|
|
@@ -3992,7 +1764,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
3992
1764
|
</dl>
|
|
3993
1765
|
</details>
|
|
3994
1766
|
|
|
3995
|
-
<details><summary><code>client.
|
|
1767
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">getAgentMemory</a>(id) -> Band.GetAgentMemoryResponse</code></summary>
|
|
3996
1768
|
<dl>
|
|
3997
1769
|
<dd>
|
|
3998
1770
|
|
|
@@ -4004,7 +1776,7 @@ await client.agentApiChats.listAgentChats({
|
|
|
4004
1776
|
<dl>
|
|
4005
1777
|
<dd>
|
|
4006
1778
|
|
|
4007
|
-
|
|
1779
|
+
Retrieves a specific memory by ID if accessible to the agent.
|
|
4008
1780
|
</dd>
|
|
4009
1781
|
</dl>
|
|
4010
1782
|
</dd>
|
|
@@ -4019,9 +1791,7 @@ Creates a new chat room with the agent as owner
|
|
|
4019
1791
|
<dd>
|
|
4020
1792
|
|
|
4021
1793
|
```typescript
|
|
4022
|
-
await client.
|
|
4023
|
-
chat: {}
|
|
4024
|
-
});
|
|
1794
|
+
await client.agentApiMemories.getAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
4025
1795
|
|
|
4026
1796
|
```
|
|
4027
1797
|
</dd>
|
|
@@ -4037,7 +1807,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
4037
1807
|
<dl>
|
|
4038
1808
|
<dd>
|
|
4039
1809
|
|
|
4040
|
-
**
|
|
1810
|
+
**id:** `string` — Memory ID
|
|
4041
1811
|
|
|
4042
1812
|
</dd>
|
|
4043
1813
|
</dl>
|
|
@@ -4045,7 +1815,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
4045
1815
|
<dl>
|
|
4046
1816
|
<dd>
|
|
4047
1817
|
|
|
4048
|
-
**requestOptions:** `
|
|
1818
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
4049
1819
|
|
|
4050
1820
|
</dd>
|
|
4051
1821
|
</dl>
|
|
@@ -4057,8 +1827,7 @@ await client.agentApiChats.createAgentChat({
|
|
|
4057
1827
|
</dl>
|
|
4058
1828
|
</details>
|
|
4059
1829
|
|
|
4060
|
-
|
|
4061
|
-
<details><summary><code>client.test.<a href="/src/api/resources/test/client/Client.ts">authentication</a>() -> Thenvoi.TestResponse</code></summary>
|
|
1830
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">archiveAgentMemory</a>(id) -> Band.ArchiveAgentMemoryResponse</code></summary>
|
|
4062
1831
|
<dl>
|
|
4063
1832
|
<dd>
|
|
4064
1833
|
|
|
@@ -4070,7 +1839,10 @@ await client.agentApiChats.createAgentChat({
|
|
|
4070
1839
|
<dl>
|
|
4071
1840
|
<dd>
|
|
4072
1841
|
|
|
4073
|
-
|
|
1842
|
+
Archives a memory (hides but preserves). Use when memory is valid but not currently needed.
|
|
1843
|
+
Archived memories can be restored later by humans.
|
|
1844
|
+
|
|
1845
|
+
Only the source agent can archive.
|
|
4074
1846
|
</dd>
|
|
4075
1847
|
</dl>
|
|
4076
1848
|
</dd>
|
|
@@ -4085,7 +1857,7 @@ Advanced test endpoint to verify API access with detailed request information an
|
|
|
4085
1857
|
<dd>
|
|
4086
1858
|
|
|
4087
1859
|
```typescript
|
|
4088
|
-
await client.
|
|
1860
|
+
await client.agentApiMemories.archiveAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
4089
1861
|
|
|
4090
1862
|
```
|
|
4091
1863
|
</dd>
|
|
@@ -4101,7 +1873,15 @@ await client.test.authentication();
|
|
|
4101
1873
|
<dl>
|
|
4102
1874
|
<dd>
|
|
4103
1875
|
|
|
4104
|
-
**
|
|
1876
|
+
**id:** `string` — Memory ID
|
|
1877
|
+
|
|
1878
|
+
</dd>
|
|
1879
|
+
</dl>
|
|
1880
|
+
|
|
1881
|
+
<dl>
|
|
1882
|
+
<dd>
|
|
1883
|
+
|
|
1884
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
4105
1885
|
|
|
4106
1886
|
</dd>
|
|
4107
1887
|
</dl>
|
|
@@ -4113,8 +1893,7 @@ await client.test.authentication();
|
|
|
4113
1893
|
</dl>
|
|
4114
1894
|
</details>
|
|
4115
1895
|
|
|
4116
|
-
|
|
4117
|
-
<details><summary><code>client.humanApiProfile.<a href="/src/api/resources/humanApiProfile/client/Client.ts">getMyProfile</a>() -> Thenvoi.GetMyProfileResponse</code></summary>
|
|
1896
|
+
<details><summary><code>client.agentApiMemories.<a href="/src/api/resources/agentApiMemories/client/Client.ts">supersedeAgentMemory</a>(id) -> Band.SupersedeAgentMemoryResponse</code></summary>
|
|
4118
1897
|
<dl>
|
|
4119
1898
|
<dd>
|
|
4120
1899
|
|
|
@@ -4126,7 +1905,10 @@ await client.test.authentication();
|
|
|
4126
1905
|
<dl>
|
|
4127
1906
|
<dd>
|
|
4128
1907
|
|
|
4129
|
-
|
|
1908
|
+
Marks a memory as superseded (soft delete). Use when information is outdated or incorrect.
|
|
1909
|
+
The memory remains for audit trail but won't appear in normal queries.
|
|
1910
|
+
|
|
1911
|
+
Only the source agent can supersede.
|
|
4130
1912
|
</dd>
|
|
4131
1913
|
</dl>
|
|
4132
1914
|
</dd>
|
|
@@ -4141,7 +1923,7 @@ Returns your profile details
|
|
|
4141
1923
|
<dd>
|
|
4142
1924
|
|
|
4143
1925
|
```typescript
|
|
4144
|
-
await client.
|
|
1926
|
+
await client.agentApiMemories.supersedeAgentMemory("daca00d0-eb6b-4db1-8201-c46015c93d04");
|
|
4145
1927
|
|
|
4146
1928
|
```
|
|
4147
1929
|
</dd>
|
|
@@ -4157,7 +1939,15 @@ await client.humanApiProfile.getMyProfile();
|
|
|
4157
1939
|
<dl>
|
|
4158
1940
|
<dd>
|
|
4159
1941
|
|
|
4160
|
-
**
|
|
1942
|
+
**id:** `string` — Memory ID
|
|
1943
|
+
|
|
1944
|
+
</dd>
|
|
1945
|
+
</dl>
|
|
1946
|
+
|
|
1947
|
+
<dl>
|
|
1948
|
+
<dd>
|
|
1949
|
+
|
|
1950
|
+
**requestOptions:** `AgentApiMemoriesClient.RequestOptions`
|
|
4161
1951
|
|
|
4162
1952
|
</dd>
|
|
4163
1953
|
</dl>
|
|
@@ -4169,7 +1959,8 @@ await client.humanApiProfile.getMyProfile();
|
|
|
4169
1959
|
</dl>
|
|
4170
1960
|
</details>
|
|
4171
1961
|
|
|
4172
|
-
|
|
1962
|
+
## Agent API/Peers
|
|
1963
|
+
<details><summary><code>client.agentApiPeers.<a href="/src/api/resources/agentApiPeers/client/Client.ts">listAgentPeers</a>({ ...params }) -> Band.ListAgentPeersResponse</code></summary>
|
|
4173
1964
|
<dl>
|
|
4174
1965
|
<dd>
|
|
4175
1966
|
|
|
@@ -4181,7 +1972,8 @@ await client.humanApiProfile.getMyProfile();
|
|
|
4181
1972
|
<dl>
|
|
4182
1973
|
<dd>
|
|
4183
1974
|
|
|
4184
|
-
|
|
1975
|
+
Lists agents that can be recruited by the current agent.
|
|
1976
|
+
Includes sibling agents (same owner) and global agents. Excludes self.
|
|
4185
1977
|
</dd>
|
|
4186
1978
|
</dl>
|
|
4187
1979
|
</dd>
|
|
@@ -4196,8 +1988,10 @@ Updates your profile details
|
|
|
4196
1988
|
<dd>
|
|
4197
1989
|
|
|
4198
1990
|
```typescript
|
|
4199
|
-
await client.
|
|
4200
|
-
|
|
1991
|
+
await client.agentApiPeers.listAgentPeers({
|
|
1992
|
+
not_in_chat: "daca00d0-eb6b-4db1-8201-c46015c93d04",
|
|
1993
|
+
page: 1,
|
|
1994
|
+
page_size: 1
|
|
4201
1995
|
});
|
|
4202
1996
|
|
|
4203
1997
|
```
|
|
@@ -4214,7 +2008,7 @@ await client.humanApiProfile.updateMyProfile({
|
|
|
4214
2008
|
<dl>
|
|
4215
2009
|
<dd>
|
|
4216
2010
|
|
|
4217
|
-
**request:** `
|
|
2011
|
+
**request:** `Band.ListAgentPeersRequest`
|
|
4218
2012
|
|
|
4219
2013
|
</dd>
|
|
4220
2014
|
</dl>
|
|
@@ -4222,7 +2016,7 @@ await client.humanApiProfile.updateMyProfile({
|
|
|
4222
2016
|
<dl>
|
|
4223
2017
|
<dd>
|
|
4224
2018
|
|
|
4225
|
-
**requestOptions:** `
|
|
2019
|
+
**requestOptions:** `AgentApiPeersClient.RequestOptions`
|
|
4226
2020
|
|
|
4227
2021
|
</dd>
|
|
4228
2022
|
</dl>
|
|
@@ -4233,3 +2027,4 @@ await client.humanApiProfile.updateMyProfile({
|
|
|
4233
2027
|
</dd>
|
|
4234
2028
|
</dl>
|
|
4235
2029
|
</details>
|
|
2030
|
+
|