Members
(constant) EVENT_TYPES :Array.<string>
Type:
- Array.<string>
Type Definitions
AssisfySDK
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
apiKey | string | The API key |
config | Object | SDK configuration |
environment | 'production' | | Current environment |
- Source
AssisfySDK
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
apiKey | string | The API key |
config | Object | SDK configuration |
environment | 'production' | | Current environment |
AssisfySDK
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
apiKey | string | The API key |
config | Object | SDK configuration |
environment | 'production' | | Current environment |
AutoTrigger
Type:
Properties- Object
| Name | Type | Attributes | Description |
|---|---|---|---|
interval | number | Interval in minutes between triggers | |
end_at | string | ISO date string when auto-trigger should end | |
start_now | boolean | <optional> | Whether to start the first trigger immediately |
web_hook_url | string | URL to send webhook notifications to |
- Source
SDKConfig
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
baseUrl | string | Base URL for API requests |
wsUrl | string | WebSocket URL for real-time connections |
sseUrl | string | Server-Sent Events URL for real-time connections |
sseEgressUrl | string | Server-Sent Events egress URL for sending events |
SDKOptions
Type:
Properties- Object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
apiKey | string | The API key for authentication | ||
config | SDKConfig | <optional> | Optional configuration overrides | |
environment | 'production' | | <optional> | 'production' | The environment to use |
Session
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
sessionId | string | The session ID |
emit | function | Event emitter function |
Session
Type:
Properties- Object
| Name | Type | Description |
|---|---|---|
sessionId | string | The session ID |
emit | function | Event emitter function |
SessionInput
Type:
Properties- Object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
goal | string | The goal or task for the session | ||
url | string | <optional> | Optional URL to start browsing from | |
withAutoTrigger | AutoTrigger | <optional> | Optional auto-trigger configuration | |
connectStrategy | 'sse' | | <optional> | 'sse' | Connection strategy to use |
- Source