Dive deeper into the Nfig SDK capabilities
Parameter | Type | Description |
---|---|---|
apiKey | string | required. Your API key from the Nfig Portal. |
browserMode | ”LOCAL” | “REMOTE” | optional. Specifies the browser mode. Defaults to REMOTE. |
debug | boolean | optional. Enables debug logging if set to true. |
Parameter | Type | Description |
---|---|---|
currentPage | Page | optional (LOCAL mode only). The Playwright Page instance to be used for the session. |
proxy | boolean | optional (REMOTE mode only). Enables proxy while creating session. |
authOptions | AuthOptions | optional (REMOTE mode only). Enabled authentication while creating a session. |
Parameter | Type | Description |
---|---|---|
authApp | enum | The authentication app is to be used during the session. Must be one of the allowed auth apps. |
Name | authApp field enum | 🚧 |
---|---|---|
Amazon | amazon | |
Delta | delta | |
DoorDash | doordash | |
Github | github | |
Instacart | instacart | |
Nextdoor | nextdoor | 🧪 experimental |
OpenTable | opentable | |
Twitter / X | ||
Resy | resy | |
Uber | uber | |
UberEats | uber_eats | 🧪 experimental |
United | united_airlines |
Field | Type | Description |
---|---|---|
success | boolean | Indicates if the session was ended successfully. |
message | string | Informational message about the session termination. |
Field | Type | Description |
---|---|---|
success | boolean | Indicates if the session was ended successfully. |
Parameter | Type | Description |
---|---|---|
goal | string | required. A descriptive goal for the action to be performed. |
options | Object | optional. Additional options to customize the action. |
Property | Type | Description |
---|---|---|
currentPage | Page(playwright) | optional (LOCAL mode only). The Playwright Page instance. |
execute | boolean | optional. If set to false, the action will not be executed locally. Defaults to true. |
action | ”click” | “type” | “navigate” | “wait” | optional. Action is supported only on LOCAL mode. If the perfoming action is failed, it will be switched to agent mode. |
selector | string | optional (For click and type action only). CSS selector of the element to type into. |
iterCount | number | optional (For click action only). Number of times to perform the click action. |
inputText | string | optional (for type action only). CSS selector of the element to type into. |
enter | boolean | optional (for type action only). If set to true, simulates pressing the Enter key after typing. |
url | string | optional. URL to navigate to. |
time | string | optional. Time to wait in milliseconds. |
Parameter | Type | Description |
---|---|---|
goal | string | required. A descriptive goal for the action to be performed. |
options | Object | optional. Additional options to customize the ask action. |
Property | Type | Description |
---|---|---|
currentPage | Page | optional (LOCAL mode only). The Playwright Page instance. |
schema | ZodSchema | optional. Zod schema to validate the extracted data against. |
pageMode | ”fullPage” or “viewPort” | optional (LOCAL mode only). Choose between scraping the entire page or just the visible viewport. |