Skip to content
WarmHub
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Get Started
What is WarmHub?
Core Concepts
Principles & Patterns
Quickstart: CLI
Quickstart: MCP
Quickstart: SDK
Authentication
Getting Access
Personal Access Tokens
Data Modeling
Wrefs
Shapes
Things
Assertions
Collections
Workspaces
Commits
Commits
Operations
Commit History
Queries
Queries
HEAD Queries
Filtering and Lookup
Subscriptions
Subscriptions
Creating Subscriptions
Managing Subscriptions
Components
Components
Manifest Reference
Component Lifecycle
Authoring Components
Sprite Patterns
Testing Components
Agent Integration
Why Agent-Native?
MCP Server
MCP Tools Reference
Agent Context (wh prime)
CLI Reference
CLI Overview
Commands
Commit Create Deep-Dive
HTTP API
HTTP API Overview
Organizations & Repositories
Queries
Commits
Shapes
Subscriptions & Actions
Authentication
Credentials
Rate Limiting
SDK
SDK Overview
Client Surfaces
SDK Reference
index
Classes
CommitBuilder
WarmHubClient
WarmHubError
Interfaces
AddOp
AddOperation
CommitBuilderOptions
RequestEvent
ReviseOp
ReviseOperation
ValidationDiagnostic
ValidationResult
WarmHubClientOptions
Type Aliases
AboutOptions
AboutResult
AccessTokenProvider
ActionAttemptInfo
ActionLeaseAcquire
ActionLeaseOp
ActionListNotificationsOptions
ActionListRunsOptions
ActionLiveFeed
ActionLiveFeedOptions
ActionNotificationInfo
ActionRunInfo
ChangesetAcceptResult
ChangesetDetail
ChangesetListItem
ChangesetRef
ChangesetStatus
ChangesetValidation
CollectionAbout
CollectionTag
CommitBuilderClient
CommitOp
CommitResult
ComponentGetOptions
ComponentInfo
ComponentList
ComponentListOptions
ComponentView
CountOptions
CountResult
CredentialAuditEntry
CredentialDeleteResult
CredentialGrantResult
CredentialInfo
CredentialKeyMutationResult
CredentialRevokeResult
CredentialUngrantResult
CurrentUserInfo
ErrorKind
FilterOptions
FilterResult
FunctionLogMode
HeadResult
HistoryResult
IngestAppendInput
IngestAppendResult
IngestBeginInput
IngestBeginResult
IngestFinalizeInput
IngestFinalizeResult
IngestStatusInput
IngestStatusResult
LiveHandle
LiveSubscriptionLogOptions
LiveThingHeadOptions
LiveThingHistoryOptions
LiveWatchResult
LogOptions
LogResult
Operation
OrgInfo
OrgList
OrgListMembersOptions
OrgListOptions
OrgMemberInfo
OrgMemberList
OrgRef
OrgRole
Page
PageRequest
PingResult
RefsOptions
RefsResult
RenameResult
RepoConfigureStatsView
RepoInfo
RepoList
RepoListOptions
RepoListPageOptions
RepoListPageResult
RepoLocator
RepoRef
RepoStatsView
RepoWithStatsInfo
ResolveWrefResult
SearchOptions
SearchResult
Shape
ShapeChange
ShapeCreateOptions
ShapeFields
ShapeGetOptions
ShapeList
ShapeListOptions
ShapeRef
ShapeReviseOptions
SubscriptionBindCredentialsResult
SubscriptionCompatCreateInput
SubscriptionCompatUpdateInput
SubscriptionInfo
SubscriptionList
SubscriptionUnbindCredentialsResult
ThingDetail
ThingGet
ThingGetManyResult
ThingGetOptions
ThingHead
ThingHeadOptions
ThingHeadRequest
ThingHistory
ThingHistoryOptions
ThingItem
TokenInfo
TokenResult
WireScopeEntry
Workspace
WorkspaceDiscardView
WorkspaceList
WorkspaceListOptions
WorkspaceRebaseView
WorkspaceRefItem
WorkspaceRevertView
WorkspaceStatus
WorkspaceStatusView
WorkspaceValidation
Variables
DEFAULT_API_URL
DEFAULT_INGEST_CHUNK_SIZE
SDK_VERSION
Functions
isRetryable
isWarmHubError
normalizeWref
resolveFunctionLogMode
sanitizeErrorMessage
toWarmHubError
validateAgainstShape
advanced
Classes
AdvancedClient
Interfaces
AdvancedClientOptions
AdvancedPatternEvent
SubscribeOptions
Subscription
Select theme
Dark
Light
Auto
ComponentGetOptions
Copy as Markdown
ComponentGetOptions
=
object
Properties
Section titled “Properties”
workspaceName?
Section titled “workspaceName?”
optional
workspaceName?
:
string
