Skip to content

Documentation / @agentick/react / AgentickProviderProps

Interface: AgentickProviderProps ​

Defined in: react/src/types.ts:33

Configuration for AgentickProvider.

Properties ​

children? ​

optional children: ReactNode

Defined in: react/src/types.ts:76


client? ​

optional client: AgentickClient

Defined in: react/src/types.ts:38

Pre-configured client instance. If provided, clientConfig is ignored.


clientConfig? ​

optional clientConfig: object

Defined in: react/src/types.ts:43

Client configuration (used if client is not provided).

baseUrl ​

baseUrl: string

paths? ​

optional paths: object

paths.abort? ​

optional abort: string

paths.channel? ​

optional channel: string

paths.close? ​

optional close: string

paths.events? ​

optional events: string

paths.send? ​

optional send: string

paths.subscribe? ​

optional subscribe: string

timeout? ​

optional timeout: number

token? ​

optional token: string

transport? ​

optional transport: 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 ​
tsx
import { createSharedTransport } from '@agentick/client-multiplexer';

<AgentickProvider clientConfig={{
  baseUrl: 'https://api.example.com',
  transport: createSharedTransport({ baseUrl: 'https://api.example.com' }),
}}>

withCredentials? ​

optional withCredentials: boolean

Released under the ISC License.