Sanity Library Reference Docs
    Preparing search index...

    Module index

    Modules

    <internal>

    Classes

    ObservableSanityClient
    SanityClient
    ConnectionFailedError
    DisconnectError
    ChannelError
    MessageError
    MessageParseError
    ObservablePatch
    Patch
    Transaction
    ObservableTransaction
    ClientError
    ServerError
    CorsOriginError

    Interfaces

    ConstantAgentActionParam
    GroqAgentActionParam
    AgentActionTarget
    GenerateTargetInclude
    GenerateTarget
    TransformTargetInclude
    TransformTarget
    TranslateTargetInclude
    TranslateTarget
    ServerSentEvent
    LiveClient
    HttpError
    StegaConfig
    RequestOptions
    ClientConfig
    InitializedClientConfig
    UploadClientConfig
    ErrorProps
    ProgressEvent
    ResponseEvent
    SanityProjectMember
    SanityProject
    SanityUser
    CurrentSanityUser
    QueryParams
    CreateReleaseAction
    EditReleaseAction
    PublishReleaseAction
    ArchiveReleaseAction
    UnarchiveReleaseAction
    ScheduleReleaseAction
    UnscheduleReleaseAction
    DeleteReleaseAction
    DiscardVersionAction
    ReplaceVersionAction
    UnpublishVersionAction
    ListenOptions
    ResponseQueryOptions
    FilteredResponseQueryOptions
    UnfilteredResponseQueryOptions
    UnfilteredResponseWithoutQuery
    RawQueryResponse
    QueryParseError
    ContentSourceMapDocumentValueSource
    ContentSourceMapLiteralSource
    ContentSourceMapUnknownSource
    ContentSourceMapValueMapping
    ContentSourceMapDocumentBase
    ContentSourceMapDocument
    ContentSourceMapRemoteDocument
    ContentSourceMap
    LiveEventRestart
    LiveEventReconnect
    LiveEventMessage
    LiveEventWelcome
    LiveEventGoAway
    SanityQueries
    ThumbnailTransformOptions
    AnimatedTransformOptions
    StoryboardTransformOptions
    MediaLibraryVideoPlaybackTransformations
    MediaLibraryPlaybackInfoOptions
    VideoPlaybackInfoItemPublic
    VideoPlaybackInfoItemSigned
    VideoPlaybackInfo
    VideoPlaybackTokens
    ObservableUsersClient
    UsersClient

    Type Aliases

    FieldAgentActionParam
    DocumentAgentActionParam
    AgentActionPathSegment
    AgentActionPath
    AgentActionParam
    AgentActionParams
    GenerateOperation
    GenerateTargetDocument
    GenerateInstruction
    PatchOperation
    PatchTarget
    PatchDocument
    PromptRequest
    TransformTargetDocument
    ImageDescriptionOperation
    TransformOperation
    TransformDocument
    TranslateDocument
    _listen
    PatchBuilder
    ObservablePatchBuilder
    StegaConfigRequiredKeys
    InitializedStegaConfig
    FilterDefault
    Logger
    UploadBody
    ReleaseId
    StackablePerspective
    ClientPerspective
    AssetMetadataType
    HttpRequest
    HttpRequestEvent
    DatasetAclMode
    DatasetResponse
    DatasetsResponse
    SanityDocumentStub
    IdentifiedSanityDocumentStub
    QueryWithoutParams
    Mutation
    ReleaseAction
    VersionAction
    Action
    ImportReleaseAction
    CreateVersionAction
    CreateAction
    ReplaceDraftAction
    EditAction
    DeleteAction
    DiscardAction
    PublishAction
    UnpublishAction
    MutationEvent
    ChannelErrorEvent
    DisconnectEvent
    ReconnectEvent
    OpenEvent
    WelcomeEvent
    ListenEvent
    ListenEventName
    ListenParams
    QueryOptions
    RawQuerylessQueryResponse
    ReleaseState
    ReleaseCardinality
    ContentSourceMapSource
    ContentSourceMapMapping
    ContentSourceMapMappings
    ContentSourceMapDocuments
    ContentSourceMapPaths
    SyncTag
    LiveEvent
    ClientReturn
    FitMode
    StillImageFormat
    AnimatedImageFormat
    VideoPlaybackInfoItem
    VideoPlaybackInfoSigned
    VideoPlaybackInfoPublic
    MediaLibraryAssetInstanceIdentifier

    Variables

    requester
    createClient
    default
    EXPERIMENTAL_API_WARNING
    unstable__adapter
    unstable__environment

    Functions

    isHttpError
    formatQueryParseError

    Settings

    Member Visibility

    On This Page

    Modules
    Classes
    Interfaces
    ConstantAgentActionParamGroqAgentActionParamAgentActionTargetGenerateTargetIncludeGenerateTargetTransformTargetIncludeTransformTargetTranslateTargetIncludeTranslateTargetServerSentEventLiveClientHttpErrorStegaConfigRequestOptionsClientConfigInitializedClientConfigUploadClientConfigErrorPropsProgressEventResponseEventSanityProjectMemberSanityProjectSanityUserCurrentSanityUserQueryParamsCreateReleaseActionEditReleaseActionPublishReleaseActionArchiveReleaseActionUnarchiveReleaseActionScheduleReleaseActionUnscheduleReleaseActionDeleteReleaseActionDiscardVersionActionReplaceVersionActionUnpublishVersionActionListenOptionsResponseQueryOptionsFilteredResponseQueryOptionsUnfilteredResponseQueryOptionsUnfilteredResponseWithoutQueryRawQueryResponseQueryParseErrorContentSourceMapDocumentValueSourceContentSourceMapLiteralSourceContentSourceMapUnknownSourceContentSourceMapValueMappingContentSourceMapDocumentBaseContentSourceMapDocumentContentSourceMapRemoteDocumentContentSourceMapLiveEventRestartLiveEventReconnectLiveEventMessageLiveEventWelcomeLiveEventGoAwaySanityQueriesThumbnailTransformOptionsAnimatedTransformOptionsStoryboardTransformOptionsMediaLibraryVideoPlaybackTransformationsMediaLibraryPlaybackInfoOptionsVideoPlaybackInfoItemPublicVideoPlaybackInfoItemSignedVideoPlaybackInfoVideoPlaybackTokensObservableUsersClientUsersClient
    Type Aliases
    FieldAgentActionParamDocumentAgentActionParamAgentActionPathSegmentAgentActionPathAgentActionParamAgentActionParamsGenerateOperationGenerateTargetDocumentGenerateInstructionPatchOperationPatchTargetPatchDocumentPromptRequestTransformTargetDocumentImageDescriptionOperationTransformOperationTransformDocumentTranslateDocument_listenPatchBuilderObservablePatchBuilderStegaConfigRequiredKeysInitializedStegaConfigFilterDefaultLoggerUploadBodyReleaseIdStackablePerspectiveClientPerspectiveAssetMetadataTypeHttpRequestHttpRequestEventDatasetAclModeDatasetResponseDatasetsResponseSanityDocumentStubIdentifiedSanityDocumentStubQueryWithoutParamsMutationReleaseActionVersionActionActionImportReleaseActionCreateVersionActionCreateActionReplaceDraftActionEditActionDeleteActionDiscardActionPublishActionUnpublishActionMutationEventChannelErrorEventDisconnectEventReconnectEventOpenEventWelcomeEventListenEventListenEventNameListenParamsQueryOptionsRawQuerylessQueryResponseReleaseStateReleaseCardinalityContentSourceMapSourceContentSourceMapMappingContentSourceMapMappingsContentSourceMapDocumentsContentSourceMapPathsSyncTagLiveEventClientReturnFitModeStillImageFormatAnimatedImageFormatVideoPlaybackInfoItemVideoPlaybackInfoSignedVideoPlaybackInfoPublicMediaLibraryAssetInstanceIdentifier
    Variables
    Functions