Sanity Library Reference Docs
Preparing search index...
@sanity/client
index
Module index
Namespaces
Context
Classes
ChannelError
ClientError
ConnectionFailedError
CorsOriginError
DisconnectError
MessageError
MessageParseError
ObservablePatch
ObservableSanityClient
ObservableTransaction
Patch
SanityClient
ServerError
Transaction
Interfaces
AgentActionTarget
AnimatedTransformOptions
ArchiveReleaseAction
ClientConfig
CollaborationCommentDocument
CollaborationCommentPortableTextBlock
CollaborationCommentRange
CollaborationCommentsClient
CollaborationCommentSelection
ConstantAgentActionParam
ContentSourceMap
ContentSourceMapDocument
ContentSourceMapDocumentBase
ContentSourceMapDocumentValueSource
ContentSourceMapLiteralSource
ContentSourceMapRemoteDocument
ContentSourceMapUnknownSource
ContentSourceMapValueMapping
CreateReleaseAction
CreateVariantDefinitionAction
CurrentSanityUser
DeleteReleaseAction
DeleteVariantAction
DeleteVariantDefinitionAction
DiscardVersionAction
EditReleaseAction
EditVariantAction
EditVariantDefinitionAction
ErrorProps
FilteredResponseQueryOptions
GenerateTarget
GenerateTargetInclude
GroqAgentActionParam
HttpError
InitializedClientConfig
InvokeFunctionEvent
InvokeFunctionOptions
InvokeFunctionRequest
ListenOptions
LiveClient
LiveEventGoAway
LiveEventMessage
LiveEventReconnect
LiveEventRestart
LiveEventWelcome
MediaLibraryAssetDocument
MediaLibraryAssetVersion
MediaLibraryPlaybackInfoOptions
MediaLibraryVideoPlaybackTransformations
ObservableCollaborationCommentsClient
ObservableUsersClient
PublishReleaseAction
PublishVariantAction
QueryParams
QueryParseError
RawQueryResponse
ReplaceVersionAction
RequestOptions
ResponseQueryOptions
ResumableListenOptions
SanityProject
SanityProjectionsByResource
SanityProjectMember
SanityQueries
SanityQueriesByResource
SanitySchemasByResource
SanityUser
ScheduleReleaseAction
ServerSentEvent
StegaConfig
StoryboardTransformOptions
ThumbnailTransformOptions
TransformTarget
TransformTargetInclude
TranslateTarget
TranslateTargetInclude
UnarchiveReleaseAction
UnfilteredResponseQueryOptions
UnfilteredResponseWithoutQuery
UnpublishVariantAction
UnpublishVersionAction
UnscheduleReleaseAction
UploadClientConfig
UploadProgressEvent
UploadResponseEvent
UsersClient
VideoPlaybackInfo
VideoPlaybackInfoItemPublic
VideoPlaybackInfoItemSigned
VideoPlaybackTokens
VideoRenditionInfoPublic
VideoRenditionInfoSigned
VideoSubtitleInfoPublic
VideoSubtitleInfoSigned
Type Aliases
_listen
Action
AgentActionParam
AgentActionParams
AgentActionPath
AgentActionPathSegment
AnimatedImageFormat
AssetMetadataType
ChannelErrorEvent
ClientParams
ClientPerspective
ClientReturn
ClientVariant
ClientVariantConditions
CollaborationCommentAnchor
CollaborationCommentCreate
CollaborationCommentFieldValue
CollaborationCommentMessage
CollaborationCommentReactionShortName
CollaborationCommentsListenOptions
CollaborationCommentsRequestOptions
CollaborationCommentStatus
CollaborationCommentsWriteOptions
CollaborationCommentTarget
CollaborationCommentUpdate
ContentSourceMapDocuments
ContentSourceMapMapping
ContentSourceMapMappings
ContentSourceMapPaths
ContentSourceMapSource
CreateAction
CreateVariantAction
CreateVersionAction
DatasetAclMode
DatasetCreateOptions
DatasetEditOptions
DatasetResponse
DatasetsResponse
DeleteAction
DiscardAction
DisconnectEvent
DocumentAgentActionParam
EditAction
EmbeddingsSettings
EmbeddingsSettingsBody
FieldAgentActionParam
FilterDefault
FitMode
GenerateInstruction
GenerateOperation
GenerateTargetDocument
IdentifiedSanityDocumentStub
ImageDescriptionOperation
ImportReleaseAction
InitializedStegaConfig
ListenEvent
ListenEventName
ListenParams
LiveEvent
Logger
MediaLibraryAssetInstanceIdentifier
Mutation
MutationEvent
ObservablePatchBuilder
OpenEvent
PatchBuilder
PatchDocument
PatchOperation
PatchTarget
PromptRequest
PublishAction
QueryOptions
QueryWithoutParams
RawQuerylessQueryResponse
ReconnectEvent
ReleaseAction
ReleaseCardinality
ReleaseId
ReleaseState
ReplaceDraftAction
Requester
RequestHandler
RequestHandlerOptions
ResetEvent
ResumableListenEventNames
SanityDocumentStub
StackablePerspective
StegaConfigRequiredKeys
StillImageFormat
SyncTag
TransformDocument
TransformOperation
TransformTargetDocument
TranslateDocument
UnpublishAction
UploadBody
UploadEvent
VariantAction
VariantDefinitionAction
VersionAction
VideoPlaybackInfoItem
VideoPlaybackInfoPublic
VideoPlaybackInfoSigned
VideoRenditionInfo
VideoSubtitleInfo
WelcomeBackEvent
WelcomeEvent
Variables
createClient
default
EXPERIMENTAL_API_WARNING
requester
Functions
formatQueryParseError
isHttpError
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Namespaces
Context
Classes
Channel
Error
Client
Error
Connection
Failed
Error
Cors
Origin
Error
Disconnect
Error
Message
Error
Message
Parse
Error
Observable
Patch
Observable
Sanity
Client
Observable
Transaction
Patch
Sanity
Client
Server
Error
Transaction
Interfaces
Agent
Action
Target
Animated
Transform
Options
Archive
Release
Action
Client
Config
Collaboration
Comment
Document
Collaboration
Comment
Portable
Text
Block
Collaboration
Comment
Range
Collaboration
Comments
Client
Collaboration
Comment
Selection
Constant
Agent
Action
Param
Content
Source
Map
Content
Source
Map
Document
Content
Source
Map
Document
Base
Content
Source
Map
Document
Value
Source
Content
Source
Map
Literal
Source
Content
Source
Map
Remote
Document
Content
Source
Map
Unknown
Source
Content
Source
Map
Value
Mapping
Create
Release
Action
Create
Variant
Definition
Action
Current
Sanity
User
Delete
Release
Action
Delete
Variant
Action
Delete
Variant
Definition
Action
Discard
Version
Action
Edit
Release
Action
Edit
Variant
Action
Edit
Variant
Definition
Action
Error
Props
Filtered
Response
Query
Options
Generate
Target
Generate
Target
Include
Groq
Agent
Action
Param
Http
Error
Initialized
Client
Config
Invoke
Function
Event
Invoke
Function
Options
Invoke
Function
Request
Listen
Options
Live
Client
Live
Event
Go
Away
Live
Event
Message
Live
Event
Reconnect
Live
Event
Restart
Live
Event
Welcome
Media
Library
Asset
Document
Media
Library
Asset
Version
Media
Library
Playback
Info
Options
Media
Library
Video
Playback
Transformations
Observable
Collaboration
Comments
Client
Observable
Users
Client
Publish
Release
Action
Publish
Variant
Action
Query
Params
Query
Parse
Error
Raw
Query
Response
Replace
Version
Action
Request
Options
Response
Query
Options
Resumable
Listen
Options
Sanity
Project
Sanity
Projections
By
Resource
Sanity
Project
Member
Sanity
Queries
Sanity
Queries
By
Resource
Sanity
Schemas
By
Resource
Sanity
User
Schedule
Release
Action
Server
Sent
Event
Stega
Config
Storyboard
Transform
Options
Thumbnail
Transform
Options
Transform
Target
Transform
Target
Include
Translate
Target
Translate
Target
Include
Unarchive
Release
Action
Unfiltered
Response
Query
Options
Unfiltered
Response
Without
Query
Unpublish
Variant
Action
Unpublish
Version
Action
Unschedule
Release
Action
Upload
Client
Config
Upload
Progress
Event
Upload
Response
Event
Users
Client
Video
Playback
Info
Video
Playback
Info
Item
Public
Video
Playback
Info
Item
Signed
Video
Playback
Tokens
Video
Rendition
Info
Public
Video
Rendition
Info
Signed
Video
Subtitle
Info
Public
Video
Subtitle
Info
Signed
Type Aliases
_listen
Action
Agent
Action
Param
Agent
Action
Params
Agent
Action
Path
Agent
Action
Path
Segment
Animated
Image
Format
Asset
Metadata
Type
Channel
Error
Event
Client
Params
Client
Perspective
Client
Return
Client
Variant
Client
Variant
Conditions
Collaboration
Comment
Anchor
Collaboration
Comment
Create
Collaboration
Comment
Field
Value
Collaboration
Comment
Message
Collaboration
Comment
Reaction
Short
Name
Collaboration
Comments
Listen
Options
Collaboration
Comments
Request
Options
Collaboration
Comment
Status
Collaboration
Comments
Write
Options
Collaboration
Comment
Target
Collaboration
Comment
Update
Content
Source
Map
Documents
Content
Source
Map
Mapping
Content
Source
Map
Mappings
Content
Source
Map
Paths
Content
Source
Map
Source
Create
Action
Create
Variant
Action
Create
Version
Action
Dataset
Acl
Mode
Dataset
Create
Options
Dataset
Edit
Options
Dataset
Response
Datasets
Response
Delete
Action
Discard
Action
Disconnect
Event
Document
Agent
Action
Param
Edit
Action
Embeddings
Settings
Embeddings
Settings
Body
Field
Agent
Action
Param
Filter
Default
Fit
Mode
Generate
Instruction
Generate
Operation
Generate
Target
Document
Identified
Sanity
Document
Stub
Image
Description
Operation
Import
Release
Action
Initialized
Stega
Config
Listen
Event
Listen
Event
Name
Listen
Params
Live
Event
Logger
Media
Library
Asset
Instance
Identifier
Mutation
Mutation
Event
Observable
Patch
Builder
Open
Event
Patch
Builder
Patch
Document
Patch
Operation
Patch
Target
Prompt
Request
Publish
Action
Query
Options
Query
Without
Params
Raw
Queryless
Query
Response
Reconnect
Event
Release
Action
Release
Cardinality
Release
Id
Release
State
Replace
Draft
Action
Requester
Request
Handler
Request
Handler
Options
Reset
Event
Resumable
Listen
Event
Names
Sanity
Document
Stub
Stackable
Perspective
Stega
Config
Required
Keys
Still
Image
Format
Sync
Tag
Transform
Document
Transform
Operation
Transform
Target
Document
Translate
Document
Unpublish
Action
Upload
Body
Upload
Event
Variant
Action
Variant
Definition
Action
Version
Action
Video
Playback
Info
Item
Video
Playback
Info
Public
Video
Playback
Info
Signed
Video
Rendition
Info
Video
Subtitle
Info
Welcome
Back
Event
Welcome
Event
Variables
create
Client
default
EXPERIMENTAL_
API_
WARNING
requester
Functions
format
Query
Parse
Error
is
Http
Error
Sanity Library Reference Docs
Loading...