@pouchy_ai/companion-sdk - v0.63.0
Guide (/sdk)
npm
Preparing search index...
@pouchy_ai/companion-sdk - v0.63.0
Classes
CompanionClient
CompanionError
Interfaces
A2UIComponent
A2UISurface
AudioClipPayload
CallReadyPayload
CompanionAvatar
CompanionCall
CompanionCallOptions
CompanionClientOptions
CompanionEnvelope
CompanionToolDecl
CompanionTranscriptEntry
CompanionTurn
CompanionView
CompanionViewOptions
CompanionViewSnapshot
CompanionWallet
ConfirmActionResult
ConfirmRequestPayload
ControlErrorPayload
DataActivityPayload
DynamicInterface
EmbeddedAction
EndSessionResult
ExpressionPayload
HelloAck
HelloAckPayload
InterfaceUpdatePayload
MandateDocument
MessageAttachment
MessagePayload
OutboundPayloadMap
OutboxStore
PendingConfirm
PendingToolCall
QueuedSend
RecalledMemory
RememberDedup
RenderInterfacePayload
SendTextReply
SkillCardPayload
SocialMessagePayload
ToolCallEvent
ToolCallPayload
TurnUsage
TypingPayload
UsagePayload
VoiceInjectPayload
VoiceToolBridge
WalletBalance
WorldStateEvent
Type Aliases
A2UIValue
BrandIconSize
CallCredentials
CompanionDebugEvent
CompanionErrorCode
CompanionErrorCodeValue
CompanionModality
CompanionScope
CompanionStreamState
ConfirmOutcomeClass
ControlErrorCode
ControlErrorCodeValue
GenuiNode
InboundType
InstantUIInput
OutboundType
WorldStateInput
Variables
AVATAR_VISUAL_TOOL_NAMES
AVATAR_VISUAL_TOOLS
COMPANION_ERROR_CODES
COMPANION_MODALITIES
COMPANION_SCOPES
CONTROL_ERROR_CODES
DEFAULT_MODALITIES
DEFAULT_SCOPES
HOST_CONTROL_TOOL_NAMES
HOST_CONTROL_TOOLS
INBOUND_TYPES
INSTANT_UI_NODE_TYPES
OUTBOUND_TYPES
OUTBOX_AMBIGUOUS_MAX_AGE_MS
OUTBOX_MAX_REPLAY_ATTEMPTS
PROTOCOL_VERSION
REPRESENT_SCOPES
SENSITIVE_SCOPES
VOICE_TOOL_HEADER_PLAIN
VOICE_TOOL_VARIABLE
VOICE_TOOL_VARIABLE_PLAIN
Functions
createCompanion
createCompanionView
fromA2UI
grantsScope
hasScope
isRepresentScope
isSensitiveScope
openCompanionCall
pouchyBrandIconUrl
toA2UI
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Classes
Companion
Client
Companion
Error
Interfaces
A2
UI
Component
A2
UI
Surface
Audio
Clip
Payload
Call
Ready
Payload
Companion
Avatar
Companion
Call
Companion
Call
Options
Companion
Client
Options
Companion
Envelope
Companion
Tool
Decl
Companion
Transcript
Entry
Companion
Turn
Companion
View
Companion
View
Options
Companion
View
Snapshot
Companion
Wallet
Confirm
Action
Result
Confirm
Request
Payload
Control
Error
Payload
Data
Activity
Payload
Dynamic
Interface
Embedded
Action
End
Session
Result
Expression
Payload
Hello
Ack
Hello
Ack
Payload
Interface
Update
Payload
Mandate
Document
Message
Attachment
Message
Payload
Outbound
Payload
Map
Outbox
Store
Pending
Confirm
Pending
Tool
Call
Queued
Send
Recalled
Memory
Remember
Dedup
Render
Interface
Payload
Send
Text
Reply
Skill
Card
Payload
Social
Message
Payload
Tool
Call
Event
Tool
Call
Payload
Turn
Usage
Typing
Payload
Usage
Payload
Voice
Inject
Payload
Voice
Tool
Bridge
Wallet
Balance
World
State
Event
Type Aliases
A2
UI
Value
Brand
Icon
Size
Call
Credentials
Companion
Debug
Event
Companion
Error
Code
Companion
Error
Code
Value
Companion
Modality
Companion
Scope
Companion
Stream
State
Confirm
Outcome
Class
Control
Error
Code
Control
Error
Code
Value
Genui
Node
Inbound
Type
Instant
UI
Input
Outbound
Type
World
State
Input
Variables
AVATAR_
VISUAL_
TOOL_
NAMES
AVATAR_
VISUAL_
TOOLS
COMPANION_
ERROR_
CODES
COMPANION_
MODALITIES
COMPANION_
SCOPES
CONTROL_
ERROR_
CODES
DEFAULT_
MODALITIES
DEFAULT_
SCOPES
HOST_
CONTROL_
TOOL_
NAMES
HOST_
CONTROL_
TOOLS
INBOUND_
TYPES
INSTANT_
UI_
NODE_
TYPES
OUTBOUND_
TYPES
OUTBOX_
AMBIGUOUS_
MAX_
AGE_
MS
OUTBOX_
MAX_
REPLAY_
ATTEMPTS
PROTOCOL_
VERSION
REPRESENT_
SCOPES
SENSITIVE_
SCOPES
VOICE_
TOOL_
HEADER_
PLAIN
VOICE_
TOOL_
VARIABLE
VOICE_
TOOL_
VARIABLE_
PLAIN
Functions
create
Companion
create
Companion
View
from
A2
UI
grants
Scope
has
Scope
is
Represent
Scope
is
Sensitive
Scope
open
Companion
Call
pouchy
Brand
Icon
Url
to
A2
UI
Guide (/sdk)
npm
@pouchy_ai/companion-sdk - v0.63.0
Loading...