API map ​
This reference covers 48 registered API service interfaces, 307 method signatures, and 344 product type entries (generic arities grouped) at the recorded source revision. It follows method arguments/results, serialized members, base records, and declared serialization-union variants. Framework primitives and containers are summarized in Integration.
Both AddApi and AddLocalApi expose services on an API host. AddLocalApi additionally makes a service local on other host roles. Backend registrations are outside this client-facing map. Conditional and privileged registrations are included and identified in the service reference.
The type graph contains cycles. A related-type link means the record uses, inherits, or can serialize that type; it is not a claim about call order. Signatures include compatibility methods still registered at this revision.
Services behind unlaunched features (the speech coach) are excluded, and webhooks are described in the webhooks guide instead of the service map. Services that are not documented by decision (preferences and binary settings, usage and review-prompt state, passkeys, and OAuth grants) are also excluded.
Services ​
| Interface | Purpose | Reference |
|---|---|---|
IAccounts | Read accounts, manage the caller's profile and sessions, and create API keys. | IAccounts |
IAliases | Resolve custom aliases to chat, place, and user identifiers. | IAliases |
IAppUpdates | Read the latest application update for a target platform. | IAppUpdates |
IAuthors | Resolve chat-local participants, profiles and permissions, and manage membership. | IAuthors |
IAvatars | Manage the caller's avatars and select the default avatar. | IAvatars |
ICaptcha | Validate reCAPTCHA tokens for a specified action. | ICaptcha |
IChatCallReactions | Read and send short-lived emoji reactions in a chat's call. | IChatCallReactions |
IChatImports | Start, consent to, perform, and end an owner-driven import of prepared history into a group chat or place. | IChatImports |
IChatPositions | Read and update the caller's per-chat read/view positions. | IChatPositions |
IChatThreads | Create threads, list and follow them, and read their statistics. | IChatThreads |
IChatTypingActivities | Read active typists and publish short-lived typing activity. | IChatTypingActivities |
IChatUsages | Read recent chat usage and register usage. | IChatUsages |
IChats | Read and manage chats, messages, pins, media indexes, and read statistics; stream text and voice messages. | IChats |
IContacts | List the caller's chats and places, manage contact entries, and block contacts. | IContacts |
IConversations | Read conversation summaries and request summarization again. | IConversations |
IDiagnostics | Administrator-only mesh and background-flow diagnostics. | IDiagnostics |
IEmailAuth | Request and validate email authentication and verification codes. | IEmailAuth |
IEmails | Preview and send email digests; availability depends on server policy. | IEmails |
IExternalContactHashes | Read and update a device address-book synchronization hash. | IExternalContactHashes |
IExternalContacts | Synchronize device address-book records in batches. | IExternalContacts |
IGifs | Search GIFs and retrieve trending GIFs. | IGifs |
IImageSuggestions | Generate, read, accept, and dismiss suggested pictures and backgrounds for chats and places. | IImageSuggestions |
IInvites | Create, list, redeem, and revoke invitation links. | IInvites |
ILiveAudioStreams | Read and publish live audio, stream transcripts, replay audio, and report playback. | ILiveAudioStreams |
ILiveSessions | Manage live participation, voice rules, hosts, muting, raised hands, conversations, and the ringing-call lifecycle. | ILiveSessions |
ILiveVideoStreams | Read and publish video streams, negotiate codecs, and report viewer demand and quality. | ILiveVideoStreams |
IMedia | Reserve media identifiers, generate images, inspect processing, and resolve uploaded content. | IMedia |
IMediaLinkPreviews | Read a link preview by identifier. | IMediaLinkPreviews |
IMentions | Find the current user's last mention in a chat. | IMentions |
IMobileSessions | Create and validate native-client sessions. | IMobileSessions |
INativeAuth | Complete native Google/Apple authentication and sign-out. | INativeAuth |
INotifications | Read and dismiss notifications, read notification history, register push devices, and notify chat participants. | INotifications |
IOwnVoices | Read the status of the caller's own cloned voice. | IOwnVoices |
IPhoneAuth | Request and validate phone authentication and verification codes. | IPhoneAuth |
IPhones | Parse phone numbers and apply account-country defaults. | IPhones |
IPlaces | Manage places, membership, roles, and the welcome chat. | IPlaces |
IReactions | Read reactions and summaries and react to a message. | IReactions |
IRoles | Read and update chat roles and list their members. | IRoles |
IRpcChecks | Path checks that reach a chosen RPC host (ping and payload download); used by clients to rank connection paths. | IRpcChecks |
ISearch | Search contacts and chat entries with typed query and result objects. | ISearch |
ISecureTokens | Create a short-lived protected token from a session. | ISecureTokens |
ISessionTemporals | Read and write temporary session-scoped strings. | ISessionTemporals |
ISharedLocations | Read, create, update, and stop chat location shares. | ISharedLocations |
ISystemProperties | Read server time and API compatibility; perform network probes and privileged maintenance. | ISystemProperties |
ITimeZones | List localized time zones and convert Windows IDs to IANA names. | ITimeZones |
ITranslations | Read translated messages and language tiles; list dubbing voices and previews; request missing translations. | ITranslations |
IUploads | Create resumable uploads, append bytes or streams, and convert uploads into media. | IUploads |
IUserPresences | Read presence and last check-in and report the caller's activity. | IUserPresences |
Data types ​
Chat ​
AliasKind, AliasTarget, Author, AuthorFull, AuthorReadPosition, AuthorRules, Authors_ChangeRole, Authors_Exclude, Authors_Invite, Authors_Join, Authors_Leave, Authors_PromoteToOwner, Authors_Restore, Authors_SetAvatar, CallEntry, CallOutcome, Chat, ChatContentKind, ChatContentPeriod, ChatContentSkeleton, ChatCopyState, ChatDiff, ChatEntry, ChatEntryAttachment, ChatEntryAudio, ChatEntryFlags, ChatEntryForwarded, ChatEntryLanguage, ChatEntryStreamInfo, ChatLanguageTile, ChatNews, ChatPermissions, ChatRangeTile, ChatThreads_Start, ChatThreads_ToggleThreadFollowStatus, ChatTile, ChatVoiceStream, Chat_CopyChat, Chat_CopyChatResult, Chat_PublishCopiedChat, Chats_Change, Chats_ForwardAttachment, Chats_ForwardEntries, Chats_GetOrCreateFromTemplate, Chats_RemoveEntries, Chats_RemoveEntry, Chats_RestoreEntries, Chats_RestoreEntry, Chats_SetPinned, Chats_UpsertEntry, Chats_WipeHistory, Conversation, Conversations_Summarize, DubVoice, FileItem, HistoryChangeKind, HistoryChangedEntry, ImageSlot, ImageSuggestions_AcceptForChat, ImageSuggestions_AcceptForPlace, ImageSuggestions_DismissForChat, ImageSuggestions_DismissForPlace, ImageSuggestions_GenerateForChat, ImageSuggestions_GenerateForPlace, LinkItem, MembersChangedEntry, Mention, MeshDiagInfo, MeshRpcRefDiagInfo, NodeDiagInfo, NotifyMembersEntry, Place, PlaceDiff, PlacePermissions, PlaceRules, Places_Change, Places_ChangeRole, Places_Exclude, Places_Invite, Places_Join, Places_Leave, Places_PromoteToOwner, Places_Restore, Reaction, ReactionSummary, Reactions_React, ReadPositionsStat, Role, RoleDiff, Roles_Change, RpcPeerDiagInfo, SharedLocation, SharedLocationDiff, SharedLocations_Change, SystemEntry, SystemRole, TextEntry, ThreadStat, TranscriptionChangedEntry, Translation, UITextKind, UnsupportedSystemEntry, VisualMediaItem, VoiceStreamPart.
Common ​
ApiCommand, AppKind, AudioCodecKind, AudioFormat, AudioFrame, CallPhase, CallReaction, CallRole, CallStatus, Change, CompatibilityLevel, ConversationStats, FlowDetails, FlowStatus, FlowSummary, FlowTypeStat, FlowsQuery, GeoPoint, HashString, LegacyLiveSessionState, LinearMap, LinearMapDiff, LiveAudioStreamInfo, LiveConversation, LiveSession, LiveSessionKind, LiveSessionMember, LiveSessionState, MaintenanceMode, MemberGroup, MuxedAudioFrame, MuxedAudioStreamEnd, MuxedAudioStreamItem, MuxedAudioStreamReset, MuxedAudioStreamStart, ParticipationKind, Range, RecordDiff, RingAck, SecureToken, SessionKind, SessionRules, SetDiff, SpeechPaceDistribution, SpeechPaceSegment, StringDiff, ThermalLevel, TranscriptDiff, TypingActivityKind, UserCall, VideoFormat, VideoFrame, VideoFrameBundle, VideoStreamInfo.
Contacts ​
Contact, ContactState, Contacts_Change, Contacts_SetIsBlocked, Contacts_Touch, ExternalContact, ExternalContactChange, ExternalContactFull, ExternalContactHashes_Change, ExternalContactsHash, ExternalContacts_BulkChange.
Identifiers ​
AliasId, AuthorId, CallId, ChatEntryId, ChatId, ChatImportId, ChatKind, ContactId, ContentId, ConversationId, Email, Emoji, ExternalContactId, Language, MediaId, MentionRef, NotificationId, NotificationKind, Phone, PlaceChatId, PlaceId, PrincipalId, RoleId, SharedLocationId, StreamId, StringIdentifier, ThreadChatId, TranslationId, UploadId, UserDeviceId, UserId.
Imports ​
ChatImportConsentSummary, ChatImportEntry, ChatImportEntryResult, ChatImportSession, ChatImports_CreateUpload, ChatImports_End, ChatImports_FinalizeUpload, ChatImports_ImportEntries, ChatImports_SetConsent, ChatImports_Start.
Invite ​
ChatInvite, Invite, InviteChatLinkPreview, Invites_Generate, Invites_Revoke, Invites_Use, PlaceInvite, UserInvite.
Media ​
GifItem, GifSearchResult, ImageStyle, ImageSuggestion, LinkPreview, LinkPreviewMode, Media, MediaFormat, MediaFrame, MediaKind, MediaProcessingStage, MediaProgress, MediaRef, Media_Generate, Media_ProcessUpload, Media_RemoveMedia, Media_ReserveMedia, Media_UpdateProgress, Size2D, Uploads_Append, Uploads_ConvertToMediaRef, Uploads_Create, Uploads_Remove, Uploads_StartProcessUpload, VideoSourceKind.
Notifications ​
AttentionNotification, CallNotification, ChatEntryNotification, ChatEntryRelatedNotification, ChatNotification, ConversationNotification, DeviceType, InvitationNotification, LegacyThreadNotification, MentionAlertStatus, MentionNotification, MessageNotification, Notification, NotificationAction, NotificationActionKind, NotificationHistoryItem, NotificationHistoryQuery, NotificationMessage, Notifications_DeregisterDevice, Notifications_Dismiss, Notifications_DismissAll, Notifications_NotifyMembers, Notifications_NotifyMentionedMembers, Notifications_RegisterDevice, ReactionNotification, ReplyNotification, ThreadNotification.
RPC checks ​
Search ​
ContactSearchQuery, EntrySearchQuery, FoundChatEntry, FoundContact, SearchMatch, SearchMatchPart, SearchResult, SearchScope.
Streaming ​
PlaybackQualityInfo, PlaybackQualityReason, PlaybackStreamInfo, PlaybackStreamPriority, ReceiveQuality, RecordingQualityInfo, RecordingQualityReason, RecordingQualityState, StreamDemandInfo, StreamDemandStats.
Users ​
Account, AccountFull, AccountStatus, Accounts_CancelRegister, Accounts_ConfirmRegister, Accounts_CreateApiKey, Accounts_DeactivateAllSessions, Accounts_DeactivateSession, Accounts_DeleteOwn, Accounts_SignOut, Accounts_Update, AppUpdateInfo, Avatar, AvatarDiff, AvatarFull, Avatars_Change, Avatars_SetDefault, ChatPosition, ChatPositionKind, ChatPositions_Set, ChatUsageListKind, ChatUsages_RegisterUsage, DigestPreview, DigestPreviewChat, EmailAuth_SendTotp, EmailAuth_ValidateTotp, EmailAuth_VerifyEmail, Emails_SendDigest, NativeAuth_SignInApple, NativeAuth_SignInGoogle, NativeAuth_SignOut, OwnVoiceStatus, PhoneAuth_SendCode, PhoneAuth_SendTotp, PhoneAuth_ValidateTotp, PhoneAuth_VerifyPhone, Presence, RecaptchaValidationResult, RpcEndpointReason, RpcEndpointReport, ServerApiInfo, SessionInfo, SessionInfoFull, SessionTemporals_Set, SystemProperties_InvalidateEverything, SystemProperties_PruneComputedGraph, TimeZone, TotpChannel, TotpPurpose, TotpSendResult, UserIdentity, UserPresences_CheckIn, UserVoiceStatus, VoiceMode, VoiceSampleFailure.
Scope and updates ​
This is a source-contract reference. It does not promise every operation is available to every account or enabled on every deployment. Authorization, feature gates, upload permissions, and platform capabilities still apply.
The map records a specific product commit so changes can be compared against matching module registrations and contract files. Each type and service links directly to that revision. Keep method signatures, command payloads, inherited fields, and union variants together when reviewing a change.