← Back to overview

Agents

Agents are autonomous browser-based workers that execute prompts against a target website. Each agent gets its own browser session, follows the instructions in its prompt, and reports back with results.

Paste your API key to use the Try it panels below. Don't have one? Create an account.

POST /api/v1/agents Create a new agent

Creates a new agent and enqueues it for execution. The agent will be assigned a browser session and begin following the prompt instructions.

ParameterTypeInRequiredDescription
project_iduuidbodyYesID of the project this agent belongs to
persona_iduuidbodyNoOptional persona to use for this agent
namestringbodyNoHuman-readable name for the agent
promptstringbodyYesInstructions for the agent to follow
modelstringbodyNoLLM model to use (default: gemini-3-flash-preview)
browser_typestringbodyNoBrowser to use (chrome, firefox, edge) (default: chrome)
max_tokensintegerbodyNoMaximum token budget for the agent's LLM calls (default: 2000000)
max_iterationsintegerbodyNoMaximum number of LLM iterations before the agent stops (default: 100)
record_videobooleanbodyNoWhether to record a video of the browser session (default: false)
clean_sessionbooleanbodyNoClear all browser cookies before starting — prevents stale auth sessions from interfering (default: false)
filesarraybodyNoInitial files to place in the agent workspace (each with path and base64 content)
cURL
Response
GET /api/v1/agents List agents
ParameterTypeInRequiredDescription
limitintegerqueryNoNumber of results to return (default: 20)
cursoruuidqueryNoCursor for pagination (agent ID)
projectuuidqueryNoFilter by project ID
experimentuuidqueryNoFilter by experiment ID (all runs)
experiment_runuuidqueryNoFilter by specific experiment run ID
cURL
Response
GET /api/v1/agents/{id} Get agent by ID
ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
cURL
Response
DELETE /api/v1/agents/{id} Delete an agent
ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
cURL
Response
POST /api/v1/agents/{id}/summarize Generate agent summary

Uses an LLM to generate a summary of what the agent did. Only works on terminal agents (completed, failed, captcha).

ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
forcebooleanqueryNoForce regeneration of existing summary (default: false)
cURL
Response
GET /api/v1/agents/{id}/verification Get agent verification result
ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
cURL
Response
POST /api/v1/agents/{id}/verify Verify an agent

Runs verification checks on the agent's outcome.

ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
cURL
Response
POST /api/v1/agents/{id}/retry Retry an agent

Re-enqueues a terminal agent for another execution attempt.

ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
cURL
Response
POST /api/v1/agents/{id}/files Upload files to agent workspace

Upload files via multipart/form-data. Files are placed in the agent's workspace for use with browser_upload_file during execution. Max 50MB per request, 10MB per file.

ParameterTypeInRequiredDescription
iduuidpathYesAgent ID
pathstringbodyNoSubdirectory to place files in (e.g. 'audio')
filesfile[]bodyYesOne or more files (multipart form field name: 'files')
cURL
Response