Documentation / @agentick/react / AgentickProviderProps
Interface: AgentickProviderProps
Defined in: react/src/types.ts:33
Configuration for AgentickProvider.
Properties
children?
optionalchildren:ReactNode
Defined in: react/src/types.ts:76
client?
optionalclient:AgentickClient
Defined in: react/src/types.ts:38
Pre-configured client instance. If provided, clientConfig is ignored.
clientConfig?
optionalclientConfig:object
Defined in: react/src/types.ts:43
Client configuration (used if client is not provided).
baseUrl
baseUrl:
string
paths?
optionalpaths:object
paths.abort?
optionalabort:string
paths.channel?
optionalchannel:string
paths.close?
optionalclose:string
paths.events?
optionalevents:string
paths.send?
optionalsend:string
paths.subscribe?
optionalsubscribe:string
timeout?
optionaltimeout:number
token?
optionaltoken:string
transport?
optionaltransport:TransportConfig
Transport to use for communication.
- "sse": HTTP/SSE transport (default for http:// and https:// URLs)
- "websocket": WebSocket transport (default for ws:// and wss:// URLs)
- "auto": Auto-detect based on URL scheme (default)
- ClientTransport instance: Use a custom transport (e.g., SharedTransport for multi-tab)
Example
import { createSharedTransport } from '@agentick/client-multiplexer';
<AgentickProvider clientConfig={{
baseUrl: 'https://api.example.com',
transport: createSharedTransport({ baseUrl: 'https://api.example.com' }),
}}>withCredentials?
optionalwithCredentials:boolean