Skip to content
nitida
Search
Ctrl
K
Cancel
@nitida/sdk on npm
Select theme
Dark
Light
Auto
Start here
What this is, and when to use it
Getting your credentials
For agents
Quickstart
Migrating from @aquienpz
How it works
How it works, end to end
Variants and presets
Formats, transparency and why not AVIF
Beyond images — palette, AI proxies, probes
Documents, audio and everything else
WASM WebP for batches
Access and privacy — what a URL means
Guides
Video and HLS
Compression in the browser
Uploads that survive a reload
What each symptom actually means
The rest of the surface
The transform benchmark
Comparisons
How this compares
Examples
Browser-direct upload
Upload and render
React — slots
Mobile — React Native and Expo
Palette — colour taken from the image
A gallery that is fast on a phone and sharp on a desktop
API reference
@nitida/asset-client
<internal>
Type Aliases
AssetDTO
AssetPalette
AssetVariant
HlsRung
PaletteSwatch
PrivateTransformOptions
RequestablePreset
ResolveSlotOptions
SignAccessOptions
SignedTransformOptions
SignTransformOptions
SlotDTO
SlotResolution
TransformEffect
TransformFit
TransformFormat
TransformGravity
TransformOptions
TransformWidth
VariantEntryPreset
VariantPreset
VisibilityHint
Variables
MAX_SIGNED_TRANSFORM_TTL_SECONDS
MAX_SIGNED_URL_TTL_SECONDS
MIN_SIGNED_TRANSFORM_TTL_SECONDS
PRESET_EXT
PRESET_LONG
PRESET_MAX_DIM
PRESET_SHORT
REQUESTABLE_PRESETS
TRANSFORM_WIDTHS
Functions
accessMessage
assertPublic
assertSha
bestTextContrast
computeVariantDimensions
configureSlotResolver
contrastRatio
deriveAccessKey
deriveTransformKid
extractAssetSha
getAmbientGradient
getAssetDimensions
getAssetSrcSet
getAssetUrl
getByteBudgetTransformUrl
getCdnBase
getHlsLadder
getHlsStreamingUrl
getPaletteBlurBackground
getPaletteCssVars
getPrivateAssetUrl
getPrivateTransformUrl
getSignedTransformUrl
getTenantId
getTextColorForBackground
getTransformSrcSet
getTransformUrl
getVideoTransformUrl
hasPreset
hasSizeLadder
hlsLadderAlignment
invalidateSlotCache
isRequestablePreset
iteratePaletteSwatches
pickAmbientBackground
relativeLuminance
resolveSlot
resolveSlots
serializeTransform
setCdnBase
setTenantId
signAccessUrl
signTransformUrl
toRequestablePresets
transformMessage
@nitida/sdk
<internal>
Classes
NitidaClient
Type Aliases
AssetDTO
AssetPalette
AssetVariant
ComposeMarketingComposition
ComposeMarketingOptions
ComposeMarketingResult
ComposeMarketingSegment
CompressOptions
HlsRung
NitidaClientOptions
PaletteSwatch
PresignUploadUrlOptions
PrivateTransformOptions
RegenerateResult
RequestablePreset
ResolveSlotOptions
SignAccessOptions
SignedTransformOptions
SignTransformOptions
SlotDTO
SlotHistoryEntry
SlotResolution
TransformEffect
TransformFit
TransformFormat
TransformGravity
TransformOptions
TransformWidth
UploadOptions
UploadResult
UploadUrlResult
UploadVideoOptions
UsageDailyPoint
UsagePerKey
UsageSnapshot
UsageWindow
VariantEntryPreset
VariantPreset
VisibilityHint
Variables
isRequestablePreset
MAX_SIGNED_TRANSFORM_TTL_SECONDS
MAX_SIGNED_URL_TTL_SECONDS
MIN_SIGNED_TRANSFORM_TTL_SECONDS
PRESET_EXT
PRESET_LONG
PRESET_MAX_DIM
PRESET_SHORT
REQUESTABLE_PRESETS
toRequestablePresets
TRANSFORM_WIDTHS
Functions
accessMessage
assertPublic
assertSha
bestTextContrast
computeVariantDimensions
configureSlotResolver
contrastRatio
deriveAccessKey
deriveTransformKid
extractAssetSha
getAmbientGradient
getAssetDimensions
getAssetSrcSet
getAssetUrl
getByteBudgetTransformUrl
getCdnBase
getHlsLadder
getHlsStreamingUrl
getPaletteBlurBackground
getPaletteCssVars
getPrivateAssetUrl
getPrivateTransformUrl
getSignedTransformUrl
getTenantId
getTextColorForBackground
getTransformSrcSet
getTransformUrl
getVideoTransformUrl
hasPreset
hasSizeLadder
hlsLadderAlignment
invalidateSlotCache
isUniversallyPlayableAudio
iteratePaletteSwatches
mimeFromFileName
pickAmbientBackground
relativeLuminance
resolveSlot
resolveSlots
serializeTransform
setCdnBase
setTenantId
signAccessUrl
signTransformUrl
transformMessage
@nitida/sdk/expo
<internal>
Classes
UploadTask
Type Aliases
ExpoUploadOptions
UploadEvents
UploadFileInput
UploadSessionState
UploadTaskOptions
Functions
cancelResumableSession
createExpoUploader
listResumableSessions
@nitida/sdk/native
Type Aliases
CompressedResult
References
compressImage
compressImages
CompressInput
CompressionError
CompressionOptions
CompressionStatusKey
DEFAULT_COMPRESSION_OPTIONS
DEFAULT_NATIVE_CONCURRENCY
MAX_UPLOAD_DIMENSION
@nitida/sdk/react
<internal>
Functions
NitidaProvider
useNitidaClient
useSlot
useSlots
@nitida/sdk/server
Classes
NitidaClient
Type Aliases
ServerClientOptions
References
accessMessage
assertPublic
assertSha
AssetDTO
AssetPalette
AssetVariant
bestTextContrast
ComposeMarketingComposition
ComposeMarketingOptions
ComposeMarketingResult
ComposeMarketingSegment
CompressOptions
computeVariantDimensions
configureSlotResolver
contrastRatio
deriveAccessKey
deriveTransformKid
extractAssetSha
getAmbientGradient
getAssetDimensions
getAssetSrcSet
getAssetUrl
getByteBudgetTransformUrl
getCdnBase
getHlsLadder
getHlsStreamingUrl
getPaletteBlurBackground
getPaletteCssVars
getPrivateAssetUrl
getPrivateTransformUrl
getSignedTransformUrl
getTenantId
getTextColorForBackground
getTransformSrcSet
getTransformUrl
getVideoTransformUrl
hasPreset
hasSizeLadder
hlsLadderAlignment
HlsRung
invalidateSlotCache
isRequestablePreset
isUniversallyPlayableAudio
iteratePaletteSwatches
MAX_SIGNED_TRANSFORM_TTL_SECONDS
MAX_SIGNED_URL_TTL_SECONDS
mimeFromFileName
MIN_SIGNED_TRANSFORM_TTL_SECONDS
NitidaClientOptions
PaletteSwatch
pickAmbientBackground
PRESET_EXT
PRESET_LONG
PRESET_MAX_DIM
PRESET_SHORT
PresignUploadUrlOptions
PrivateTransformOptions
RegenerateResult
relativeLuminance
REQUESTABLE_PRESETS
RequestablePreset
resolveSlot
ResolveSlotOptions
resolveSlots
serializeTransform
setCdnBase
setTenantId
SignAccessOptions
signAccessUrl
SignedTransformOptions
SignTransformOptions
signTransformUrl
SlotDTO
SlotHistoryEntry
SlotResolution
toRequestablePresets
TRANSFORM_WIDTHS
TransformEffect
TransformFit
TransformFormat
TransformGravity
transformMessage
TransformOptions
TransformWidth
UploadOptions
UploadResult
UploadUrlResult
UploadVideoOptions
UsageDailyPoint
UsagePerKey
UsageSnapshot
UsageWindow
VariantEntryPreset
VariantPreset
VisibilityHint
@nitida/sdk/web
<internal>
Classes
NitidaClient
Type Aliases
CompressOptions
CompressResult
CompressStage
WebClientOptions
Variables
DEFAULT_COMPRESSION_OPTIONS
Functions
compressImage
compressImages
References
accessMessage
assertPublic
assertSha
AssetDTO
AssetPalette
AssetVariant
bestTextContrast
ClientCompressOptions
ComposeMarketingComposition
ComposeMarketingOptions
ComposeMarketingResult
ComposeMarketingSegment
computeVariantDimensions
configureSlotResolver
contrastRatio
deriveAccessKey
deriveTransformKid
extractAssetSha
getAmbientGradient
getAssetDimensions
getAssetSrcSet
getAssetUrl
getByteBudgetTransformUrl
getCdnBase
getHlsLadder
getHlsStreamingUrl
getPaletteBlurBackground
getPaletteCssVars
getPrivateAssetUrl
getPrivateTransformUrl
getSignedTransformUrl
getTenantId
getTextColorForBackground
getTransformSrcSet
getTransformUrl
getVideoTransformUrl
hasPreset
hasSizeLadder
hlsLadderAlignment
HlsRung
invalidateSlotCache
isRequestablePreset
isUniversallyPlayableAudio
iteratePaletteSwatches
MAX_SIGNED_TRANSFORM_TTL_SECONDS
MAX_SIGNED_URL_TTL_SECONDS
mimeFromFileName
MIN_SIGNED_TRANSFORM_TTL_SECONDS
PaletteSwatch
pickAmbientBackground
PRESET_EXT
PRESET_LONG
PRESET_MAX_DIM
PRESET_SHORT
PresignUploadUrlOptions
PrivateTransformOptions
RegenerateResult
relativeLuminance
REQUESTABLE_PRESETS
RequestablePreset
resolveSlot
ResolveSlotOptions
resolveSlots
serializeTransform
setCdnBase
setTenantId
SignAccessOptions
signAccessUrl
SignedTransformOptions
SignTransformOptions
signTransformUrl
SlotDTO
SlotHistoryEntry
SlotResolution
toRequestablePresets
TRANSFORM_WIDTHS
TransformEffect
TransformFit
TransformFormat
TransformGravity
transformMessage
TransformOptions
TransformWidth
UploadOptions
UploadResult
UploadUrlResult
UploadVideoOptions
UsageDailyPoint
UsagePerKey
UsageSnapshot
UsageWindow
VariantEntryPreset
VariantPreset
VisibilityHint
@nitida/sdk on npm
Select theme
Dark
Light
Auto
scroll to zoom · drag to pan
−
Reset
+
Close
nitida
Copy page
View as Markdown
Modules
Section titled “Modules”
@nitida/asset-client
@nitida/sdk
@nitida/sdk/expo
@nitida/sdk/native
@nitida/sdk/react
@nitida/sdk/server
@nitida/sdk/web