How It Works
You can use Jev in two ways:- Start and Wait: SDKs provide a
startAndWait()method that blocks until the task completes and returns the result - Async Pattern: Start a task, get a job ID, then poll for status and results—useful for long-running tasks or when you want more control
Installation
Quick Start
The simplest way to run a Jev task is with thestartAndWait() method, which handles everything for you:
Async Pattern
When you need more control, use the async pattern to start a task and poll for results:Stop a Running Task
Stop a task before it completes:Parameters
string
required
Natural language description of what you want Jev to accomplish. Be specific for best results. The task must be at most 8000 UTF-8 bytes.
string
default:"jev-1.13.0"
Jev decision model to use. Available options:
"jev-1.13.0"- Pinned Jev 1.13.0 decision model (default)"jev-latest"- Latest hosted Jev decision model
string
default:"gemini-3.5-flash-lite"
Text helper model used for field values and the final result. Currently
"gemini-3.5-flash-lite" is the only supported option.number
default:"100"
Maximum number of executed policy actions. Allowed range is 1-300.
number
default:"3"
Accepted for compatibility with other agents. Jev does not add controller-level retries from this value.
string
ID of an existing browser session to reuse. Useful for multi-step workflows that need to maintain the same browser session.
boolean
default:"false"
Keep the browser session alive after task completion.
object
Session configuration (proxy, stealth, captcha solving, etc.). Only applies when creating a new session. If you provide an existing
sessionId, these options are ignored.boolean
default:"false"
Use your own Jev and Google API keys instead of consuming Hyperbrowser credits for model calls. You will only be charged for browser usage.
object
API keys for
jev and google. Both are required when useCustomApiKeys is true.Jev does not send screenshots to either model. It reads visible page text and common HTML/ARIA controls, then dispatches native CDP clicks, typing, and selects.
Reuse Browser Sessions
You can pass in an existingsessionId to the Jev task so that it can execute the task on an existing session. Also, if you want to keep the session open after executing the task, you can supply the keepBrowserOpen parameter.
Using Your Own API Keys
Bring your own Jev and Google API keys to avoid consuming Hyperbrowser credits for model calls. You’ll still be charged for browser session usage, but save on token costs. Jev BYOK requires both keys:jev for decisions and google for text generation.
Session Configuration
Customize the browser session used by Jev with session options.sessionOptions only applies when creating a new session. If you provide a sessionId, these options are ignored.Best Practices
Write clear, specific task descriptions
Write clear, specific task descriptions
Be explicit about what you want Jev to do. Instead of “check the website”, say “go to example.com, find the pricing page, and extract the cost of the Enterprise plan”.
Set appropriate maxSteps
Set appropriate maxSteps
Simple tasks often finish in well under the default of 100 steps. Complex multi-page workflows can use up to 300. Monitor failed tasks and adjust accordingly.
Reuse sessions for multi-step workflows
Reuse sessions for multi-step workflows
It is usually better to split up complex tasks into smaller, more manageable ones and execute them as separate agent calls on the same session.