Skip to content
UserVane Docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Start
What UserVane is
Quickstart (agent-native)
Quickstart (classic widget)
Concepts
Correlation and attestation
Credential-safe round-trip
Measurement honesty
Keys (publishable vs secret)
Widget SDKs
Overview
@uservane/browser
@uservane/react
@uservane/react-native
Agent-native
@uservane/agent-core
@uservane/agent-react
@uservane/vercel-ai
@uservane/openai-agents
@uservane/copilotkit
Langfuse sync
@uservane/langfuse-push
Guides
Langfuse round-trip end to end
Classic in-product widget
Migrating from Delighted
Privacy (export, erase, DPA)
Edge API
Overview
OpenAPI reference
API reference (TypeDoc)
agent-core
@uservane/agent-core reference
classes
@uservane/agent-core: AgentController
functions
@uservane/agent-core: explicitCorrelationSource
@uservane/agent-core: handleRequestUserFeedback
@uservane/agent-core: hasAnyCorrelationId
@uservane/agent-core: markInitCalled
@uservane/agent-core: readShowTokenPayload
@uservane/agent-core: tokenAttestsModelRequested
@uservane/agent-core: unlinkReason
@uservane/agent-core: wasInitCalled
type-aliases
@uservane/agent-core: ActiveAsk
@uservane/agent-core: AgentControllerDeps
@uservane/agent-core: AgentControllerListener
@uservane/agent-core: AgentIdentifyOptions
@uservane/agent-core: AgentInitOptions
@uservane/agent-core: BootstrapResponse
@uservane/agent-core: BoundTokenBinding
@uservane/agent-core: CompleteOptions
@uservane/agent-core: Corner
@uservane/agent-core: CorrelationSnapshot
@uservane/agent-core: CorrelationSource
@uservane/agent-core: HeadlessContract
@uservane/agent-core: IdentityKind
@uservane/agent-core: InitOptions
@uservane/agent-core: Presentation
@uservane/agent-core: RequestUserFeedbackArgs
@uservane/agent-core: RequestUserFeedbackResult
@uservane/agent-core: ResolveTaskOptions
@uservane/agent-core: SurveyDefinition
@uservane/agent-core: SurveyType
variables
@uservane/agent-core: emptyCorrelationSource
@uservane/agent-core: REQUEST_USER_FEEDBACK_DESCRIPTION
@uservane/agent-core: REQUEST_USER_FEEDBACK_NAME
@uservane/agent-core: requestUserFeedbackDescriptor
agent-core-server
@uservane/agent-core/server reference
functions
@uservane/agent-core/server: mintDeferredAskLink
@uservane/agent-core/server: mintFeedbackToken
type-aliases
@uservane/agent-core/server: MintDeferredAskLinkInput
@uservane/agent-core/server: MintDeferredAskLinkResult
@uservane/agent-core/server: MintFeedbackTokenError
@uservane/agent-core/server: MintFeedbackTokenInput
@uservane/agent-core/server: MintFeedbackTokenResult
agent-react
@uservane/agent-react reference
classes
@uservane/agent-react: AgentController
@uservane/agent-react: UserVaneErrorBoundary
functions
@uservane/agent-react: explicitCorrelationSource
@uservane/agent-react: hasAnyCorrelationId
@uservane/agent-react: InlineFeedback
@uservane/agent-react: unlinkReason
@uservane/agent-react: UserVaneProvider
@uservane/agent-react: useUserVane
type-aliases
@uservane/agent-react: ActiveAsk
@uservane/agent-react: AgentControllerDeps
@uservane/agent-react: AgentControllerListener
@uservane/agent-react: AgentIdentifyOptions
@uservane/agent-react: AgentInitOptions
@uservane/agent-react: BootstrapResponse
@uservane/agent-react: BoundTokenBinding
@uservane/agent-react: CompleteOptions
@uservane/agent-react: Corner
@uservane/agent-react: CorrelationSnapshot
@uservane/agent-react: CorrelationSource
@uservane/agent-react: HeadlessContract
@uservane/agent-react: IdentityKind
@uservane/agent-react: InitOptions
@uservane/agent-react: InlineFeedbackProps
@uservane/agent-react: Presentation
@uservane/agent-react: ResolveTaskOptions
@uservane/agent-react: SurveyDefinition
@uservane/agent-react: SurveyType
@uservane/agent-react: UserVaneContextValue
@uservane/agent-react: UserVaneProviderProps
@uservane/agent-react: UseUserVaneResult
variables
@uservane/agent-react: emptyCorrelationSource
browser
@uservane/browser reference
functions
@uservane/browser: allCopyValues
@uservane/browser: catchPromise
@uservane/browser: decideShow
@uservane/browser: fetchBootstrap
@uservane/browser: findSurveyBySlug
@uservane/browser: guard
@uservane/browser: guardAsync
@uservane/browser: guardedListener
@uservane/browser: isDebug
@uservane/browser: isLowScoreFollowUp
@uservane/browser: isSampledIn
@uservane/browser: isSuppressed
@uservane/browser: log
@uservane/browser: logError
@uservane/browser: matchesTargeting
@uservane/browser: parseSurveyType
@uservane/browser: scaleForType
@uservane/browser: setDebug
@uservane/browser: stableHash
@uservane/browser: submitResponse
type-aliases
@uservane/browser: BootstrapResponse
@uservane/browser: Corner
@uservane/browser: Decision
@uservane/browser: FetchBootstrapParams
@uservane/browser: IdentifyOptions
@uservane/browser: InitOptions
@uservane/browser: Presentation
@uservane/browser: ScaleConfig
@uservane/browser: ScaleOption
@uservane/browser: ShowReason
@uservane/browser: SubmitParams
@uservane/browser: SubmitPayload
@uservane/browser: SurveyDefinition
@uservane/browser: SurveyType
@uservane/browser: UserVaneAPI
@uservane/browser: WidgetState
variables
@uservane/browser: COPY
@uservane/browser: DEFAULT_API_BASE
@uservane/browser: DEFAULT_AUTO_DELAY_MS
@uservane/browser: DETRACTOR_MAX
@uservane/browser: PMF_NOT
@uservane/browser: PMF_SOMEWHAT
@uservane/browser: PMF_VERY
@uservane/browser: SCALE_BY_TYPE
@uservane/browser: THANKS_AUTO_DISMISS_MS
@uservane/browser: UserVane
copilotkit
@uservane/copilotkit reference
classes
@uservane/copilotkit: AgentController
@uservane/copilotkit: UserVaneErrorBoundary
functions
@uservane/copilotkit: evaluateResolutionEdge
@uservane/copilotkit: explicitCorrelationSource
@uservane/copilotkit: hasAnyCorrelationId
@uservane/copilotkit: InlineFeedback
@uservane/copilotkit: latestAssistantMessageId
@uservane/copilotkit: unlinkReason
@uservane/copilotkit: UserVaneCopilotFeedback
@uservane/copilotkit: UserVaneProvider
@uservane/copilotkit: useUserVane
@uservane/copilotkit: useUserVaneCopilotResolution
type-aliases
@uservane/copilotkit: ActiveAsk
@uservane/copilotkit: AgentControllerDeps
@uservane/copilotkit: AgentControllerListener
@uservane/copilotkit: AgentIdentifyOptions
@uservane/copilotkit: AgentInitOptions
@uservane/copilotkit: BootstrapResponse
@uservane/copilotkit: BoundTokenBinding
@uservane/copilotkit: ChatMessageLike
@uservane/copilotkit: CompleteOptions
@uservane/copilotkit: Corner
@uservane/copilotkit: CorrelationSnapshot
@uservane/copilotkit: CorrelationSource
@uservane/copilotkit: HeadlessContract
@uservane/copilotkit: IdentityKind
@uservane/copilotkit: InitOptions
@uservane/copilotkit: InlineFeedbackProps
@uservane/copilotkit: Presentation
@uservane/copilotkit: ResolutionEdgeInput
@uservane/copilotkit: ResolutionEdgeResult
@uservane/copilotkit: ResolutionInfo
@uservane/copilotkit: ResolveTaskOptions
@uservane/copilotkit: SurveyDefinition
@uservane/copilotkit: SurveyType
@uservane/copilotkit: UserVaneContextValue
@uservane/copilotkit: UserVaneCopilotFeedbackProps
@uservane/copilotkit: UserVaneProviderProps
@uservane/copilotkit: UseUserVaneCopilotResolutionOptions
@uservane/copilotkit: UseUserVaneCopilotResolutionResult
@uservane/copilotkit: UseUserVaneResult
variables
@uservane/copilotkit: emptyCorrelationSource
copilotkit-server
@uservane/copilotkit/server reference
functions
@uservane/copilotkit/server: mintFeedbackToken
type-aliases
@uservane/copilotkit/server: MintFeedbackTokenError
@uservane/copilotkit/server: MintFeedbackTokenInput
@uservane/copilotkit/server: MintFeedbackTokenResult
langfuse-push
@uservane/langfuse-push reference
functions
@uservane/langfuse-push: pushPendingScores
type-aliases
@uservane/langfuse-push: LangfuseScoreClient
@uservane/langfuse-push: PushPendingScoresOpts
@uservane/langfuse-push: PushPendingScoresResult
openai-agents
@uservane/openai-agents reference
classes
@uservane/openai-agents: AgentController
@uservane/openai-agents: UserVaneErrorBoundary
functions
@uservane/openai-agents: createRequestUserFeedbackTool
@uservane/openai-agents: explicitCorrelationSource
@uservane/openai-agents: hasAnyCorrelationId
@uservane/openai-agents: InlineFeedback
@uservane/openai-agents: unlinkReason
@uservane/openai-agents: UserVaneProvider
@uservane/openai-agents: useUserVane
type-aliases
@uservane/openai-agents: ActiveAsk
@uservane/openai-agents: AgentControllerDeps
@uservane/openai-agents: AgentControllerListener
@uservane/openai-agents: AgentIdentifyOptions
@uservane/openai-agents: AgentInitOptions
@uservane/openai-agents: BootstrapResponse
@uservane/openai-agents: BoundTokenBinding
@uservane/openai-agents: CompleteOptions
@uservane/openai-agents: Corner
@uservane/openai-agents: CorrelationSnapshot
@uservane/openai-agents: CorrelationSource
@uservane/openai-agents: HeadlessContract
@uservane/openai-agents: IdentityKind
@uservane/openai-agents: InitOptions
@uservane/openai-agents: InlineFeedbackProps
@uservane/openai-agents: Presentation
@uservane/openai-agents: RequestUserFeedbackArgs
@uservane/openai-agents: RequestUserFeedbackResult
@uservane/openai-agents: ResolveTaskOptions
@uservane/openai-agents: SurveyDefinition
@uservane/openai-agents: SurveyType
@uservane/openai-agents: UserVaneContextValue
@uservane/openai-agents: UserVaneProviderProps
@uservane/openai-agents: UseUserVaneResult
variables
@uservane/openai-agents: emptyCorrelationSource
@uservane/openai-agents: REQUEST_USER_FEEDBACK_DESCRIPTION
@uservane/openai-agents: REQUEST_USER_FEEDBACK_NAME
@uservane/openai-agents: requestUserFeedbackDescriptor
openai-agents-langfuse
@uservane/openai-agents/langfuse reference
classes
@uservane/openai-agents/langfuse: UserVaneLangfuseExporter
functions
@uservane/openai-agents/langfuse: createLangfuseBridgeProcessor
@uservane/openai-agents/langfuse: installLangfuseBridge
type-aliases
@uservane/openai-agents/langfuse: AgentsSpanLike
@uservane/openai-agents/langfuse: AgentsTraceLike
@uservane/openai-agents/langfuse: ExportOutcome
@uservane/openai-agents/langfuse: LangfuseBridgeOpts
@uservane/openai-agents/langfuse: LangfuseTraceClient
openai-agents-server
@uservane/openai-agents/server reference
functions
@uservane/openai-agents/server: awaitRunResolution
@uservane/openai-agents/server: mintDeferredAskLink
@uservane/openai-agents/server: mintFeedbackForRun
@uservane/openai-agents/server: mintFeedbackToken
@uservane/openai-agents/server: runWithFeedback
type-aliases
@uservane/openai-agents/server: AgentsRunFn
@uservane/openai-agents/server: AgentsRunResultLike
@uservane/openai-agents/server: FeedbackPayload
@uservane/openai-agents/server: MintDeferredAskLinkInput
@uservane/openai-agents/server: MintDeferredAskLinkResult
@uservane/openai-agents/server: MintFeedbackTokenError
@uservane/openai-agents/server: MintFeedbackTokenInput
@uservane/openai-agents/server: MintFeedbackTokenResult
@uservane/openai-agents/server: RunWithFeedbackMintOpts
@uservane/openai-agents/server: RunWithFeedbackOptions
@uservane/openai-agents/server: RunWithFeedbackResult
react
@uservane/react reference
functions
@uservane/react: UserVaneProvider
@uservane/react: useUserVane
type-aliases
@uservane/react: BootstrapResponse
@uservane/react: Corner
@uservane/react: IdentifyOptions
@uservane/react: InitOptions
@uservane/react: Presentation
@uservane/react: SurveyDefinition
@uservane/react: SurveyType
@uservane/react: UserVaneContextValue
@uservane/react: UserVaneProviderProps
@uservane/react: UseUserVaneResult
react-native
@uservane/react-native reference
classes
@uservane/react-native: NativeController
@uservane/react-native: UserVaneErrorBoundary
functions
@uservane/react-native: RatingScale
@uservane/react-native: SurveyCard
@uservane/react-native: UserVaneProvider
@uservane/react-native: useUserVane
type-aliases
@uservane/react-native: ActiveSurvey
@uservane/react-native: BootstrapResponse
@uservane/react-native: Corner
@uservane/react-native: IdentifyOptions
@uservane/react-native: InitOptions
@uservane/react-native: Presentation
@uservane/react-native: RatingScaleProps
@uservane/react-native: SurveyCardProps
@uservane/react-native: SurveyCompleteResult
@uservane/react-native: SurveyDefinition
@uservane/react-native: SurveyPhase
@uservane/react-native: SurveyType
@uservane/react-native: UserVaneContextValue
@uservane/react-native: UserVaneProviderProps
@uservane/react-native: UseUserVaneResult
vercel-ai
@uservane/vercel-ai reference
classes
@uservane/vercel-ai: AgentController
@uservane/vercel-ai: UserVaneErrorBoundary
functions
@uservane/vercel-ai: createRequestUserFeedbackTool
@uservane/vercel-ai: explicitCorrelationSource
@uservane/vercel-ai: hasAnyCorrelationId
@uservane/vercel-ai: InlineFeedback
@uservane/vercel-ai: unlinkReason
@uservane/vercel-ai: UserVaneProvider
@uservane/vercel-ai: useUserVane
type-aliases
@uservane/vercel-ai: ActiveAsk
@uservane/vercel-ai: AgentControllerDeps
@uservane/vercel-ai: AgentControllerListener
@uservane/vercel-ai: AgentIdentifyOptions
@uservane/vercel-ai: AgentInitOptions
@uservane/vercel-ai: BootstrapResponse
@uservane/vercel-ai: BoundTokenBinding
@uservane/vercel-ai: CompleteOptions
@uservane/vercel-ai: Corner
@uservane/vercel-ai: CorrelationSnapshot
@uservane/vercel-ai: CorrelationSource
@uservane/vercel-ai: HeadlessContract
@uservane/vercel-ai: IdentityKind
@uservane/vercel-ai: InitOptions
@uservane/vercel-ai: InlineFeedbackProps
@uservane/vercel-ai: Presentation
@uservane/vercel-ai: RequestUserFeedbackArgs
@uservane/vercel-ai: RequestUserFeedbackResult
@uservane/vercel-ai: ResolveTaskOptions
@uservane/vercel-ai: SurveyDefinition
@uservane/vercel-ai: SurveyType
@uservane/vercel-ai: UserVaneContextValue
@uservane/vercel-ai: UserVaneProviderProps
@uservane/vercel-ai: UseUserVaneResult
variables
@uservane/vercel-ai: emptyCorrelationSource
@uservane/vercel-ai: REQUEST_USER_FEEDBACK_DESCRIPTION
@uservane/vercel-ai: REQUEST_USER_FEEDBACK_NAME
@uservane/vercel-ai: requestUserFeedbackDescriptor
vercel-ai-server
@uservane/vercel-ai/server reference
functions
@uservane/vercel-ai/server: mintDeferredAskLink
@uservane/vercel-ai/server: mintFeedbackToken
type-aliases
@uservane/vercel-ai/server: MintDeferredAskLinkInput
@uservane/vercel-ai/server: MintDeferredAskLinkResult
@uservane/vercel-ai/server: MintFeedbackTokenError
@uservane/vercel-ai/server: MintFeedbackTokenInput
@uservane/vercel-ai/server: MintFeedbackTokenResult
Select theme
Dark
Light
Auto
@uservane/agent-core/server reference
@uservane/agent-core
Section titled “@uservane/agent-core”
Type Aliases
Section titled “Type Aliases”
MintDeferredAskLinkInput
MintDeferredAskLinkResult
MintFeedbackTokenError
MintFeedbackTokenInput
MintFeedbackTokenResult
Functions
Section titled “Functions”
mintDeferredAskLink
mintFeedbackToken
