Read, crawl and act on websites, signed in as the user, and turn any site into an API.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Runs one batch of actions on an open session and returns the fresh page. Each action is an object, e.g. {"action":"click","selector":"#go"}. DRIVE: navigate, click, fill, type_text, select, check, hover, submit, press_key, scroll, back, wait, wait_for. SEE: query_dom, find_text, read_text, count, get_attributes, inspect, list_candidates, get_dom, get_screenshot. NETWORK: capture_network, get_request, rotate_exit. CODE: evaluate_js, search_scripts, read_script. RECORD: extract {variable,script}, api_call, login_post, probe_write, confirm_write. 2FA: twofa {challenge_method}. A value written {{name}} with its real value in `inputs` becomes a workflow input. Each action's arguments: the session's start answer, or writ_help('writ_browser_act').
Ordered action objects, e.g. [{"action":"click","selector":"#login"}].
Clip of the returned page (default 40000).
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Runs one batch of actions on an open session and returns the fresh page. Each action is an object, e.g. {"action":"click","selector":"#go"}. DRIVE: navigate, click, fill, type_text, select, check, hover, submit, press_key, scroll, back, wait, wait_for. SEE: query_dom, find_text, read_text, count, get_attributes, inspect, list_candidates, get_dom, get_screenshot. NETWORK: capture_network, get_request, rotate_exit. CODE: evaluate_js, search_scripts, read_script. RECORD: extract {variable,script}, api_call, login_post, probe_write, confirm_write. 2FA: twofa {challenge_method}. A value written {{name}} with its real value in `inputs` becomes a workflow input. Each action's arguments: the session's start answer, or writ_help('writ_browser_act').
| Argument | Type | Description |
|---|---|---|
| inputs | object | |
| actions* | array | Ordered action objects, e.g. [{"action":"click","selector":"#login"}]. |
| max_chars | integer | Clip of the returned page (default 40000). |
| session_id* | string |
{
"type": "object",
"required": [
"session_id",
"actions"
],
"properties": {
"inputs": {
"type": "object"
},
"actions": {
"type": "array",
"items": {
"type": "object"
},
"description": "Ordered action objects, e.g. [{\"action\":\"click\",\"selector\":\"#login\"}]."
},
"max_chars": {
"type": "integer",
"description": "Clip of the returned page (default 40000)."
},
"session_id": {
"type": "string"
}
}
}Hands an open session to the Writ user: kind='captcha' (they complete a security check in the live browser), 'twofa' (they supply the one-time code and Writ types it; the code never reaches this conversation), 'sign_in' (they sign in on the live page; no persona applies) or 'question' (their text answer). The call that opens the ask returns at once with user_link + tell_user to relay; later calls hold up to 60 s and answer answered, waiting_for_user (the same call again) or expired. Their answer is kept if your turn ends first.
| Argument | Type | Description |
|---|---|---|
| kind | string | captcha | twofa | sign_in | question. |
| question | string | kind='question': one short sentence. |
| session_id* | string | |
| wait_seconds | integer | Hold up to this long (1-60). |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"kind": {
"enum": [
"captcha",
"question",
"twofa",
"sign_in"
],
"type": "string",
"description": "captcha | twofa | sign_in | question."
},
"question": {
"type": "string",
"description": "kind='question': one short sentence."
},
"session_id": {
"type": "string"
},
"wait_seconds": {
"type": "integer",
"description": "Hold up to this long (1-60)."
}
}
}Closes an open browser session (an open cloud browser bills until it is closed). Unsaved work that did more than visit pages is auto-saved first and the reply names it; discard=true keeps nothing.
| Argument | Type | Description |
|---|---|---|
| discard | boolean | Throw away unsaved steps instead of auto-saving. |
| session_id* | string |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"discard": {
"type": "boolean",
"description": "Throw away unsaved steps instead of auto-saving."
},
"session_id": {
"type": "string"
}
}
}Authors the workflow in an open session beyond a recording: named API functions (define_function with a `flow` (preferred in an API build), from a captured call's index, or a lists payload; live-tested as defined; compile_function for an authenticated request), set_inputs, add_steps, test_function, remove_function, remove_step, list. Payload shapes: writ_help('writ_browser_compose').
| Argument | Type | Description |
|---|---|---|
| payload | object | The operation's arguments. |
| operation* | string | list | define_function | compile_function | test_function | remove_function | add_steps | remove_step | set_inputs. |
| session_id* | string |
{
"type": "object",
"required": [
"session_id",
"operation"
],
"properties": {
"payload": {
"type": "object",
"description": "The operation's arguments."
},
"operation": {
"enum": [
"list",
"define_function",
"compile_function",
"test_function",
"remove_function",
"add_steps",
"remove_step",
"set_inputs"
],
"type": "string",
"description": "list | define_function | compile_function | test_function | remove_function | add_steps | remove_step | set_inputs."
},
"session_id": {
"type": "string"
}
}
}Re-reads an open session: section=page (url, fields, buttons, cleaned DOM), lists (the page's repeating rows with a live-tested define_function payload for writ_browser_compose), map (the evidence of the build the session is bound to).
| Argument | Type | Description |
|---|---|---|
| offset | integer | |
| section | string | page (default) | lists | map | explorer | concierge_api. |
| max_chars | integer | |
| session_id* | string |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"offset": {
"type": "integer",
"minimum": 0
},
"section": {
"enum": [
"page",
"lists",
"map",
"explorer",
"concierge_api"
],
"type": "string",
"description": "page (default) | lists | map | explorer | concierge_api."
},
"max_chars": {
"type": "integer"
},
"session_id": {
"type": "string"
}
}
}The live browser card's own access: the card ChatGPT and Claude show under writ_browser_use and writ_record_website calls it to read the session's state and get one-time passes for the session's screencast and its take-over channel. The user watches the page in the card and can take it over there. It is not part of a conversation's work.
| Argument | Type | Description |
|---|---|---|
| session_id* | string | The session_id the card was opened with (cbs_...). |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"session_id": {
"type": "string",
"description": "The session_id the card was opened with (cbs_...)."
}
}
}Searches (operation=search, query, method) or reads in full (operation=detail, index) the backend requests the page made after capture_network: the site's real API. writ_browser_act api_call probes one with other values (a `flow`: several requests); an index feeds writ_browser_compose define_function from_index.
| Argument | Type | Description |
|---|---|---|
| index | integer | detail: which call. |
| query | string | Substring filter. |
| method | string | HTTP method filter. |
| offset | integer | |
| max_chars | integer | |
| operation | string | search (default) | detail. |
| session_id* | string |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"description": "detail: which call."
},
"query": {
"type": "string",
"description": "Substring filter."
},
"method": {
"type": "string",
"description": "HTTP method filter."
},
"offset": {
"type": "integer",
"minimum": 0
},
"max_chars": {
"type": "integer"
},
"operation": {
"enum": [
"search",
"detail"
],
"type": "string",
"description": "search (default) | detail."
},
"session_id": {
"type": "string"
}
}
}Saves the open session as a replayable workflow and closes the browser, in the place its browser ran: the user's desktop library or Writ Cloud. Composed functions become callable API functions, declared inputs become its parameters. The answer carries the steps, the inputs and a run_example; the workflow runs at zero AI cost through writ_run_workflow. A save that references something no run could resolve is refused with the reasons, and the browser stays open.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| save_to | string | |
| keep_open | boolean | |
| session_id* | string | |
| description | string | |
| allow_no_data | boolean | Save a workflow that returns no data, on purpose. |
{
"type": "object",
"required": [
"session_id"
],
"properties": {
"name": {
"type": "string"
},
"save_to": {
"enum": [
"desktop",
"cloud",
"both"
],
"type": "string"
},
"keep_open": {
"type": "boolean"
},
"session_id": {
"type": "string"
},
"description": {
"type": "string"
},
"allow_no_data": {
"type": "boolean",
"description": "Save a workflow that returns no data, on purpose."
}
}
}Lists the account's open cloud browser sessions (each resumable by its session_id).
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| include_closed | boolean |
{
"type": "object",
"properties": {
"limit": {
"type": "integer"
},
"include_closed": {
"type": "boolean"
}
}
}A REAL CLOUD BROWSER FOR A TASK ON A SITE: the user's signed-in account (a persona_id from writ_personas: the password stays sealed in Writ, and sessions never ask for a password), a click, form, submit or search inside an app, or a page a plain fetch cannot open (login wall, 403, CAPTCHA). Opens the browser and returns the first page; writ_browser_act drives it (Writ runs no model here). Recording is always on: writ_browser_save turns the session into a workflow that replays without a browser, writ_browser_cancel closes it (an open browser bills). The start answer carries the action vocabulary, the recording rules and, with a persona, the 2FA rules. NOT FOR: reading pages (writ_scrape). An API: writ_website_to_api opens this same browser, bound to a build.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| goal | string | |
| auth_mode | string | |
| fresh_exit | boolean | |
| persona_id | integer | string | |
| use_residential | boolean | Open on the residential network (bot walls, CAPTCHAs). |
| execution_target | string | cloud | auto | local (the user's own desktop app). |
The original files (PDFs, office documents, images, CSVs) a crawl captured, with short-lived download URLs.
| Argument | Type | Description |
|---|---|---|
| runs | integer | |
| crawl | string | |
| limit | integer | |
| crawl_id | integer |
{
"type": "object",
"properties": {
"runs": {
"type": "integer"
},
"crawl": {
"type": "string"
},
"limit": {
"type": "integer"
},
"crawl_id": {
"type": "integer"
}
}
}COLLECTS a site or a section into a queryable, change-tracked dataset (one row per page). Scope: intent (a section, in plain words), rank_cap=N (the top N items of a listing), seed_urls (known pages), or the whole site capped by page_budget. Modes: markdown (default, no AI), extract_mode='schema' (uniform records), executor='ai' + extract_prompt (per-page understanding, 5x the page rate). A bounded crawl answers with its rows; an open one returns a crawl_id for writ_crawl_status wait=true. NOT FOR: reading a few pages now (writ_scrape). Every option: writ_help('writ_crawl_site').
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| name | string | |
| wait | boolean | Hold until done and return the rows (default true when bounded). |
| limit | integer | |
| speed | string | |
| device | string | |
| intent | string | The section wanted, in plain words; the server derives paths and depth. |
| output | object | |
Status of a crawl by crawl_id; wait=true holds up to 75 s and returns the collected rows when it converges.
| Argument | Type | Description |
|---|---|---|
| wait | boolean | Hold until done and inline the rows. |
| limit | integer | |
| output | object | |
| crawl_id* | integer | |
| preview_chars | integer | |
| timeout_seconds | integer |
{
"type": "object",
"required": [
"crawl_id"
],
"properties": {
"wait": {
"type": "boolean",
"description": "Hold until done and inline the rows."
},
"limit": {
"type": "integer"
},
"output": {
"type": "object"
},
"crawl_id": {
"type": "integer"
},
"preview_chars": {
"type": "integer"
},
"timeout_seconds": {
"type": "integer"
}
}
}Creates an automation: on an event (a workflow or crawl completed, a monitor change, a webhook, a schedule) it runs a workflow, sends a notification templated over the event's data, and/or wakes an AI agent. Event, template and webhook options: writ_help('writ_create_automation').
| Argument | Type | Description |
|---|---|---|
| name* | string | |
| when | string | workflow_completed | crawl_completed | change_detected | webhook_received | scheduled | ... |
| title | string | |
| blocks | array | |
| inputs | object | |
| notify | string | Message template, e.g. {{result.extracted_data.0.title}}. |
| enabled | boolean | |
| channels | array | Notification channels. |
| priority | integer | |
| schedule | object | when='scheduled': {kind, interval_minutes | time, days, tz}. |
Drafts or revises a multi-request browserless HTTP extraction (loops, GraphQL, cursor pagination) from captured requests and a plain-language goal. Every option: writ_help('writ_create_http_extraction').
| Argument | Type | Description |
|---|---|---|
| goal* | string | |
| apply | boolean | false (default) drafts; true writes. |
| workflow | string | |
| step_index | integer | |
| workflow_id | integer | |
| requirements | string | |
| desired_inputs | array | |
| request_samples | array | |
| response_sample | string |
{
"type": "object",
"required": [
"goal"
],
"properties": {
"goal": {
"type": "string"
},
"apply": {
"type": "boolean",
"description": "false (default) drafts; true writes."
},
"workflow": {
"type": "string"
},
"step_index": {
"type": "integer"
},
"workflow_id": {
"type": "integer"
},
"requirements": {
"type": "string"
},
"desired_inputs": {
"type": "array",
"items": {
"type": "string"
}
},
"request_samples": {
"type": "array",
"items": {
"type": "object"
}
},
"response_sample": {
"type": "string"
}
}
}WATCHES a page for changes: Writ checks it on a schedule and fires change_detected when the page, a CSS selector's text, a value read by `extract`, or a visual zone changes. Returns the monitor_id that writ_wire_monitor connects to an alert, a workflow or an AI task (a price watch takes a threshold there). Without `interval` the answer is needs_input: this plan's options and a tell_user for the user, nothing created. The page is read first: a sign-in answers needs_persona, a bot check offers use_residential.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| mode | string | |
| watch | string | content (default) | price (the value must hold a number). |
| device | string | |
| enabled | boolean | |
| extract | object | string | Browserless read instead of a selector, e.g. {"from":"html_css","selector":".price"}. |
| interval | string | integer | How often: an option id from needs_input ('5m', '1h', '24h') or seconds. |
| selector | string | CSS selector whose text is watched (unset = whole page / uptime). |
The user's linked Writ desktops: list, use (scope this connection to one: runs, browsers, personas and monitors then target it), clear, monitors, datasets.
| Argument | Type | Description |
|---|---|---|
| action | string | list (default) | use | clear | monitors | datasets. |
| device | string | use: the desktop's agent_id or name. |
{
"type": "object",
"properties": {
"action": {
"enum": [
"list",
"use",
"clear",
"monitors",
"datasets"
],
"type": "string",
"description": "list (default) | use | clear | monitors | datasets."
},
"device": {
"type": "string",
"description": "use: the desktop's agent_id or name."
}
}
}Explains why a saved workflow's run returned nothing or failed: HTTP-lane readiness and, with task_id, the run's requests and responses.
| Argument | Type | Description |
|---|---|---|
| task_id | integer | |
| workflow | string | |
| workflow_id | integer |
{
"type": "object",
"properties": {
"task_id": {
"type": "integer"
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
}
}
}Status of a writ_website_to_api build. wait=true is one held call (up to 75 s) that follows the build to its newest rung and returns when it is done or parked. Answers: succeeded (workflow_id, functions, run_example), failed, cancelled, or needs_guidance (the build is the caller's to finish with writ_website_to_api mode=guided build_id=<id>; its map comes with it).
| Argument | Type | Description |
|---|---|---|
| wait | boolean | One held call until done or parked. |
| build_id* | integer | |
| timeout_seconds | integer | Ceiling for wait=true (up to 75). |
{
"type": "object",
"required": [
"build_id"
],
"properties": {
"wait": {
"type": "boolean",
"description": "One held call until done or parked."
},
"build_id": {
"type": "integer"
},
"timeout_seconds": {
"type": "integer",
"description": "Ceiling for wait=true (up to 75)."
}
}
}Exports a workflow's full data table as CSV or JSON.
| Argument | Type | Description |
|---|---|---|
| q | string | |
| view | string | |
| format | string | csv (default) | json. |
| workflow | string | |
| workflow_id | integer |
{
"type": "object",
"properties": {
"q": {
"type": "string"
},
"view": {
"type": "string"
},
"format": {
"type": "string",
"description": "csv (default) | json."
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
}
}
}Publishes a saved workflow as a REST endpoint (a POST URL that waits and returns its JSON). Repeated calls reuse it.
| Argument | Type | Description |
|---|---|---|
| label | string | |
| workflow | string | |
| workflow_id | integer | |
| wait_timeout | integer | |
| timeout_seconds | integer |
{
"type": "object",
"properties": {
"label": {
"type": "string"
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
},
"wait_timeout": {
"type": "integer",
"maximum": 300,
"minimum": 5
},
"timeout_seconds": {
"type": "integer",
"maximum": 300,
"minimum": 5
}
}
}The full reference of any Writ tool (every parameter and its rules) and the complete guide. topic = a tool name (e.g. 'writ_browser_compose', a 'run_<workflow>' tool), 'guide' for the manual (recurring digests, HTTP flow building, buying on a price, crawl and build modes), 'actions' / 'recording' / '2fa' for the browser rules, 'http_flows' / 'flow_operators' for writing an HTTP flow, or empty for the list of topics.
| Argument | Type | Description |
|---|---|---|
| topic | string | A tool name, 'guide', 'actions', 'recording', '2fa', 'http_flows', 'flow_operators', or empty. |
{
"type": "object",
"properties": {
"topic": {
"type": "string",
"description": "A tool name, 'guide', 'actions', 'recording', '2fa', 'http_flows', 'flow_operators', or empty."
}
}
}The account's inbound webhook URLs and the automations they fire.
| Argument | Type | Description |
|---|---|---|
| webhook_trigger_id | integer | Only this webhook. |
{
"type": "object",
"properties": {
"webhook_trigger_id": {
"type": "integer",
"description": "Only this webhook."
}
}
}Lists the workflows saved in the Writ account; each runs on demand without live browsing. Returns id, name, declared inputs, schedule, and whether it is pinned as its own run_<name> tool.
| Argument | Type | Description |
|---|---|---|
| search | string | Name/description filter, e.g. a site. |
{
"type": "object",
"properties": {
"search": {
"type": "string",
"description": "Name/description filter, e.g. a site."
}
}
}Pays on a site with one of the user's cards; card numbers never reach this conversation. request (site, max_amount, purpose) returns a tell_user and an open_url where the user approves; wait (grant_id or confirmation_id); checkout pauses at the order button for the user's confirmation, then Writ places the order; fill; list (card handles only). Details: writ_help('writ_payment').
| Argument | Type | Description |
|---|---|---|
| site | string | request: the store's domain. |
| steps | array | |
| action* | string | request | wait | checkout | fill | list. |
| fields | object | |
| purpose | string | One line the user reads. |
| session | string | The browser session on the checkout page. |
| summary | string | |
| currency | string | |
| grant_id | string | |
The user's own accounts on websites (personas): how Writ signs in as them. No password passes through this tool or the conversation, and its answers never ask for one: credentials are typed only into a Writ window. action='list' domain=<site> shows the personas usable there; with none it answers persona_needed: a tell_user for the user, a create_url (a small Writ window with only the sign-in form, pre-filled for the site) and a link_id. action='wait' link_id=<id> is one held call that answers when the user saves it, with its persona_id. Also get, request (a link for another account), sign_in (refresh the session) and record_login. A persona_id works on writ_scrape, writ_crawl_site, writ_browser_use and writ_run_workflow; a desktop persona ('device:...') signs in on that desktop, from its own vault.
| Argument | Type | Description |
|---|---|---|
| why | string | request: one line the user sees in the window. |
| wait | boolean | |
| force | boolean | |
| action* | string | list (default) | get | request | wait | sign_in | record_login. |
| device | string | |
| domain | string | list: personas usable on this site. request: the site. |
| link_id | string | wait: the link_id of a persona_needed / request answer. |
Pins (or unpins) a saved workflow as its own run_<name> tool on this server.
| Argument | Type | Description |
|---|---|---|
| pinned | boolean | |
| workflow | string | |
| workflow_id | integer |
{
"type": "object",
"properties": {
"pinned": {
"type": "boolean"
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
}
}
}Records a repeatable task on a site as a workflow (goal + start url): the same session as writ_browser_use, labelled with its goal, driven with writ_browser_act and saved with writ_browser_save. A goal that asks for an API opens as a writ_website_to_api build instead: the same browser, bound to the build.
| Argument | Type | Description |
|---|---|---|
| url* | string | |
| goal* | string | |
| device | string | |
| auth_mode | string | |
| fresh_exit | boolean | |
| persona_id | integer | string | |
| skip_existing | boolean | |
| use_residential | boolean | Residential network (bot walls). |
| skip_marketplace | boolean | |
| residential_country |
Runs a saved crawl; max_age returns its recent data at no cost instead of re-crawling.
| Argument | Type | Description |
|---|---|---|
| wait | boolean | Hold until done. |
| crawl* | string | |
| limit | integer | |
| output | object | |
| max_age | integer | Reuse a run younger than this (seconds). |
| preview_chars | integer | |
| timeout_seconds | integer |
{
"type": "object",
"required": [
"crawl"
],
"properties": {
"wait": {
"type": "boolean",
"description": "Hold until done."
},
"crawl": {
"type": "string"
},
"limit": {
"type": "integer"
},
"output": {
"type": "object"
},
"max_age": {
"type": "integer",
"minimum": 0,
"description": "Reuse a run younger than this (seconds)."
},
"preview_chars": {
"type": "integer"
},
"timeout_seconds": {
"type": "integer"
}
}
}Runs a saved workflow by workflow_id or name and returns its extracted data (it waits by default). Inputs go as top-level fields or under `inputs`; function_name runs one function of a multi-function API (with the sign-in it needs). max_age reuses a recent result at no cost. A write function previews with mutation_mode='dry_run'. Runs sign in as the workflow's persona or persona_id; no password is ever passed. Venue, network, files and output shape: writ_help('writ_run_workflow').
| Argument | Type | Description |
|---|---|---|
| wait | boolean | |
| files | object | |
| device | string | |
| inputs | object | Run inputs (top-level fields work too). |
| output | object | |
| max_age | integer | Reuse a result younger than this many seconds (free). 0 = fresh. |
| workflow | string | Workflow name (or workflow_id). |
| persona_id | integer | string | Run as this saved identity. |
| workflow_id |
Reads the data a saved crawl collected on its last completed run, without crawling.
| Argument | Type | Description |
|---|---|---|
| crawl* | string | |
| limit | integer | |
| output | object | |
| preview_chars | integer |
{
"type": "object",
"required": [
"crawl"
],
"properties": {
"crawl": {
"type": "string"
},
"limit": {
"type": "integer"
},
"output": {
"type": "object"
},
"preview_chars": {
"type": "integer"
}
}
}Lists the crawls saved for re-running, with their scope.
| Argument | Type | Description |
|---|---|---|
| limit | integer |
{
"type": "object",
"properties": {
"limit": {
"type": "integer"
}
}
}READ PAGES NOW, no browser session: one page (url), up to 20 pages in parallel (urls), or a listing plus its top N item pages (url + top_n). Returns clean markdown in 2-10 s, including pages a plain fetch cannot read: rendered by JavaScript (render_mode='browser'; a read that only got the page's shell says so and gives the retry), behind a bot wall or 403 (an automatic residential retry), or behind the user's sign-in (persona_id). Discussion threads keep their comments. format='html' returns the raw HTML for selectors. NOT FOR: a site-wide dataset (writ_crawl_site) or clicking and typing (writ_browser_use).
| Argument | Type | Description |
|---|---|---|
| url | string | |
| urls | array | Up to 20 known pages, read in parallel. |
| top_n | integer | With url = a listing: also read its N top-ranked item pages (max 20). |
| device | string | |
| format | string | markdown (default) | html (raw HTML) | both. |
| persona_id | integer | string | Read signed in as this saved identity (writ_personas). |
| render_mode | string | auto (default: HTTP, a browser when the page needs JS) | http | browser. |
| include_paths | array |
Searches everything the account's workflows already collected for a term, without running anything.
| Argument | Type | Description |
|---|---|---|
| q* | string | |
| limit | integer | |
| device | string | |
| workflow | string | |
| workflow_id | integer | |
| preview_chars | integer |
{
"type": "object",
"required": [
"q"
],
"properties": {
"q": {
"type": "string"
},
"limit": {
"type": "integer"
},
"device": {
"type": "string"
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
},
"preview_chars": {
"type": "integer"
}
}
}Schedules a saved workflow: every_minutes, or kind='daily'/'weekly' with time (HH:MM) and days. functions + inputs schedule chosen functions of a multi-function API.
| Argument | Type | Description |
|---|---|---|
| tz | string | IANA timezone. |
| days | array | Weekdays 1=Mon..7=Sun (weekly). |
| kind | string | interval | daily | weekly. |
| time | string | HH:MM (daily/weekly). |
| inputs | object | |
| enabled | boolean | |
| function | string | |
| workflow | string | |
| functions | array | |
| workflow_id | integer | |
| every_minutes | integer |
Inspects or changes a saved crawl's settings in place.
| Argument | Type | Description |
|---|---|---|
| name | string | |
| crawl* | string | |
| settings | object | Sparse settings patch. |
| description | string | |
| default_max_age_seconds | integer |
{
"type": "object",
"required": [
"crawl"
],
"properties": {
"name": {
"type": "string"
},
"crawl": {
"type": "string"
},
"settings": {
"type": "object",
"description": "Sparse settings patch."
},
"description": {
"type": "string"
},
"default_max_age_seconds": {
"type": "integer",
"minimum": 0
}
}
}Inspects or edits a saved workflow: an outline, one function's source, targeted function or step edits, a settings patch. copy_to keeps a linked copy on Writ Cloud or the user's desktop. Every option: writ_help('writ_update_workflow').
| Argument | Type | Description |
|---|---|---|
| path | string | |
| limit | integer | |
| patch | object | Settings and metadata to change; {"name": "New name"} renames it. |
| device | string | |
| offset | integer | |
| copy_to | string | |
| section | string | |
| step_id | string | |
| verbose | boolean | |
| operator | string | |
| workflow |
TURNS A WEBSITE INTO A CALLABLE API (named functions with inputs, returning JSON), built by the caller in a real browser. url = the page that already shows the rows (search results or a listing, not the home page); goal = the inputs and fields wanted. The call first proposes the user's matching saved workflows and marketplace APIs (skip_existing / skip_marketplace build fresh), then opens a cloud browser bound to the build: capture_network records the site's own calls, writ_browser_network reads them, api_call probes them; a failed probe is evidence, not the end. Functions: HTTP flows first (writ_browser_compose define_function `flow`; writ_help('http_flows')), single requests (from_index) mixed in, DOM extraction last. writ_browser_save, then run_example on two inputs. mode=intelligent: Writ builds it alone (+ writ_discovery_status wait=true), on request.
| Argument | Type | Description |
|---|---|---|
| url | string | |
| goal | string | |
| mode | string | guided (default: the caller drives) | intelligent (Writ builds it alone, on request) | auto | fast | crawl | browser. |
| level | string | |
| scope | string | |
| device | string | |
| save_as | string |
Connects a monitor's change_detected event to an action: action='notify' (channels and recipients the account has configured), 'workflow' (runs a saved workflow), or 'ai_task' (an AI agent opens the page and works `prompt`). A price watch takes `threshold` (+ threshold_op): the action then runs once, when a check reads a price at or below it. Buying at a price (`buy`): writ_help('writ_wire_monitor').
| Argument | Type | Description |
|---|---|---|
| buy | object | Run the workflow or task as a purchase (saved as a rehearsal until armed). |
| name | string | |
| title | string | |
| action* | string | notify | workflow | ai_task. |
| device | string | |
| prompt | string | action='ai_task': what the agent does. |
| enabled | boolean | |
| message | string | |
| channels | array | Notification channels, e.g. ["email","pushover"]. |
| workflow |
Reads a saved workflow's collected data as a table: q filters, run_id picks one run, refs returns full records.
| Argument | Type | Description |
|---|---|---|
| q | string | |
| refs | array | Full records by '<run_id>:<record_index>'. |
| view | string | |
| limit | integer | |
| device | string | |
| output | object | |
| run_id | integer | |
| workflow | string | |
| workflow_id | integer | |
| preview_chars | integer |
{
"type": "object",
"properties": {
"q": {
"type": "string"
},
"refs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Full records by '<run_id>:<record_index>'."
},
"view": {
"type": "string"
},
"limit": {
"type": "integer"
},
"device": {
"type": "string"
},
"output": {
"type": "object"
},
"run_id": {
"type": "integer"
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
},
"preview_chars": {
"type": "integer"
}
}
}Run history (status, timing, errors, venue) of one workflow or all of them.
| Argument | Type | Description |
|---|---|---|
| limit | integer | |
| device | string | |
| status | string | Filter by status. |
| workflow | string | |
| workflow_id | integer |
{
"type": "object",
"properties": {
"limit": {
"type": "integer"
},
"device": {
"type": "string"
},
"status": {
"type": "string",
"description": "Filter by status."
},
"workflow": {
"type": "string"
},
"workflow_id": {
"type": "integer"
}
}
}| residential_country | string |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
},
"goal": {
"type": "string"
},
"auth_mode": {
"enum": [
"reuse",
"fresh_login"
],
"type": "string"
},
"fresh_exit": {
"type": "boolean"
},
"persona_id": {
"type": [
"integer",
"string"
]
},
"use_residential": {
"type": "boolean",
"description": "Open on the residential network (bot walls, CAPTCHAs)."
},
"execution_target": {
"type": "string",
"description": "cloud | auto | local (the user's own desktop app)."
},
"residential_country": {
"type": "string"
}
}
}| max_age |
| integer |
| save_as | string |
| delay_ms | integer |
| executor | string | regular (default, no AI) | ai (5x the page rate). |
| ocr_mode | string |
| rank_cap | integer | Top N items of a listing (one page per agent, in parallel). |
| max_depth | integer |
| seed_urls | array | Exact pages to collect (no discovery). |
| persona_id | integer | string |
| shard_size | integer |
| page_budget | integer | Cap on pages fetched. |
| render_mode | string |
| same_domain | boolean |
| content_spec | object |
| extract_mode | string | markdown (default) | schema | html. |
| exclude_paths | array |
| include_paths | array |
| preview_chars | integer |
| extract_prompt | string | With executor=ai: what to extract from each page. |
| extract_schema | object |
| respect_robots | boolean |
| timeout_seconds | integer |
| use_residential | boolean |
| allow_subdomains | boolean |
| relevance_threshold | number |
| residential_country | string |
| max_concurrent_shards | integer |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
},
"wait": {
"type": "boolean",
"description": "Hold until done and return the rows (default true when bounded)."
},
"limit": {
"type": "integer"
},
"speed": {
"type": "string"
},
"device": {
"type": "string"
},
"intent": {
"type": "string",
"description": "The section wanted, in plain words; the server derives paths and depth."
},
"output": {
"type": "object"
},
"max_age": {
"type": "integer",
"minimum": 0
},
"save_as": {
"type": "string"
},
"delay_ms": {
"type": "integer"
},
"executor": {
"type": "string",
"description": "regular (default, no AI) | ai (5x the page rate)."
},
"ocr_mode": {
"type": "string"
},
"rank_cap": {
"type": "integer",
"maximum": 50,
"minimum": 1,
"description": "Top N items of a listing (one page per agent, in parallel)."
},
"max_depth": {
"type": "integer"
},
"seed_urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exact pages to collect (no discovery)."
},
"persona_id": {
"type": [
"integer",
"string"
]
},
"shard_size": {
"type": "integer"
},
"page_budget": {
"type": "integer",
"description": "Cap on pages fetched."
},
"render_mode": {
"type": "string"
},
"same_domain": {
"type": "boolean"
},
"content_spec": {
"type": "object"
},
"extract_mode": {
"type": "string",
"description": "markdown (default) | schema | html."
},
"exclude_paths": {
"type": "array",
"items": {
"type": "string"
}
},
"include_paths": {
"type": "array",
"items": {
"type": "string"
}
},
"preview_chars": {
"type": "integer"
},
"extract_prompt": {
"type": "string",
"description": "With executor=ai: what to extract from each page."
},
"extract_schema": {
"type": "object"
},
"respect_robots": {
"type": "boolean"
},
"timeout_seconds": {
"type": "integer"
},
"use_residential": {
"type": "boolean"
},
"allow_subdomains": {
"type": "boolean"
},
"relevance_threshold": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"residential_country": {
"type": "string"
},
"max_concurrent_shards": {
"type": "integer"
}
}
}| ai_prompt | string | Wake an AI agent with this task. |
| target_id | integer | change_detected: the monitor_id. |
| recipients | array |
| description | string |
| on_workflow | string | Source workflow for workflow_* events. |
| ai_entry_url | string |
| run_function | string |
| run_workflow | string | Workflow to run. |
| ai_session_id | integer |
| run_functions | array |
| on_workflow_id | integer |
| run_workflow_id | integer |
| cooldown_minutes | integer |
| target_selector_id | integer |
| webhook_trigger_id | integer |
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
},
"when": {
"enum": [
"workflow_completed",
"workflow_started",
"crawl_completed",
"crawl_failed",
"ai_session_completed",
"ai_session_started",
"change_detected",
"webhook_received",
"scheduled"
],
"type": "string",
"description": "workflow_completed | crawl_completed | change_detected | webhook_received | scheduled | ..."
},
"title": {
"type": "string"
},
"blocks": {
"type": "array",
"items": {
"type": "object"
}
},
"inputs": {
"type": "object"
},
"notify": {
"type": "string",
"description": "Message template, e.g. {{result.extracted_data.0.title}}."
},
"enabled": {
"type": "boolean"
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Notification channels."
},
"priority": {
"type": "integer"
},
"schedule": {
"type": "object",
"description": "when='scheduled': {kind, interval_minutes | time, days, tz}."
},
"ai_prompt": {
"type": "string",
"description": "Wake an AI agent with this task."
},
"target_id": {
"type": "integer",
"description": "change_detected: the monitor_id."
},
"recipients": {
"type": "array",
"items": {
"type": "string"
}
},
"description": {
"type": "string"
},
"on_workflow": {
"type": "string",
"description": "Source workflow for workflow_* events."
},
"ai_entry_url": {
"type": "string"
},
"run_function": {
"type": "string"
},
"run_workflow": {
"type": "string",
"description": "Workflow to run."
},
"ai_session_id": {
"type": "integer"
},
"run_functions": {
"type": "array",
"items": {
"type": "string"
}
},
"on_workflow_id": {
"type": "integer"
},
"run_workflow_id": {
"type": "integer"
},
"cooldown_minutes": {
"type": "integer"
},
"target_selector_id": {
"type": "integer"
},
"webhook_trigger_id": {
"type": "integer"
}
}
}| zone_text |
| string |
| persona_id | integer | string |
| session_id | string |
| try_anyway | boolean |
| request_url | string |
| use_residential | boolean | Check through a residential exit (bot walls). |
| interval_minutes | integer |
| requires_browser | boolean |
| residential_country | string |
{
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string"
},
"mode": {
"enum": [
"selector",
"visual"
],
"type": "string"
},
"watch": {
"enum": [
"content",
"price"
],
"type": "string",
"description": "content (default) | price (the value must hold a number)."
},
"device": {
"type": "string"
},
"enabled": {
"type": "boolean"
},
"extract": {
"type": [
"object",
"string"
],
"description": "Browserless read instead of a selector, e.g. {\"from\":\"html_css\",\"selector\":\".price\"}."
},
"interval": {
"type": [
"string",
"integer"
],
"description": "How often: an option id from needs_input ('5m', '1h', '24h') or seconds."
},
"selector": {
"type": "string",
"description": "CSS selector whose text is watched (unset = whole page / uptime)."
},
"zone_text": {
"type": "string"
},
"persona_id": {
"type": [
"integer",
"string"
]
},
"session_id": {
"type": "string"
},
"try_anyway": {
"type": "boolean"
},
"request_url": {
"type": "string"
},
"use_residential": {
"type": "boolean",
"description": "Check through a residential exit (bot walls)."
},
"interval_minutes": {
"type": "integer"
},
"requires_browser": {
"type": "boolean"
},
"residential_country": {
"type": "string"
}
}
}| max_amount |
| number |
| The most it may charge. |
| automation_id | integer |
| total_selector | string |
| commit_selector | string | checkout: the place-order button. |
| confirmation_id | string |
| payment_method_id | string |
{
"type": "object",
"required": [
"action"
],
"properties": {
"site": {
"type": "string",
"description": "request: the store's domain."
},
"steps": {
"type": "array",
"items": {
"type": "object"
}
},
"action": {
"enum": [
"request",
"wait",
"checkout",
"fill",
"list"
],
"type": "string",
"description": "request | wait | checkout | fill | list."
},
"fields": {
"type": "object"
},
"purpose": {
"type": "string",
"description": "One line the user reads."
},
"session": {
"type": "string",
"description": "The browser session on the checkout page."
},
"summary": {
"type": "string"
},
"currency": {
"type": "string"
},
"grant_id": {
"type": "string"
},
"max_amount": {
"type": "number",
"description": "The most it may charge."
},
"automation_id": {
"type": "integer"
},
"total_selector": {
"type": "string"
},
"commit_selector": {
"type": "string",
"description": "checkout: the place-order button."
},
"confirmation_id": {
"type": "string"
},
"payment_method_id": {
"type": "string"
}
}
}| login_url |
| string |
| persona_id | integer |
| include_runs | boolean |
| execution_target | string |
{
"type": "object",
"required": [
"action"
],
"properties": {
"why": {
"type": "string",
"description": "request: one line the user sees in the window."
},
"wait": {
"type": "boolean"
},
"force": {
"type": "boolean"
},
"action": {
"enum": [
"list",
"get",
"request",
"wait",
"sign_in",
"record_login"
],
"type": "string",
"description": "list (default) | get | request | wait | sign_in | record_login."
},
"device": {
"type": "string"
},
"domain": {
"type": "string",
"description": "list: personas usable on this site. request: the site."
},
"link_id": {
"type": "string",
"description": "wait: the link_id of a persona_needed / request answer."
},
"login_url": {
"type": "string"
},
"persona_id": {
"type": "integer"
},
"include_runs": {
"type": "boolean"
},
"execution_target": {
"enum": [
"cloud"
],
"type": "string"
}
}
}| string |
{
"type": "object",
"required": [
"goal",
"url"
],
"properties": {
"url": {
"type": "string"
},
"goal": {
"type": "string"
},
"device": {
"type": "string"
},
"auth_mode": {
"enum": [
"reuse",
"fresh_login"
],
"type": "string"
},
"fresh_exit": {
"type": "boolean"
},
"persona_id": {
"type": [
"integer",
"string"
]
},
"skip_existing": {
"type": "boolean"
},
"use_residential": {
"type": "boolean",
"description": "Residential network (bot walls)."
},
"skip_marketplace": {
"type": "boolean"
},
"residential_country": {
"type": "string"
}
}
}| integer | string |
| A number, or 'local:<id>' (a workflow on the user's desktop). |
| function_name | string | One function of a multi-function workflow. |
| mutation_mode | string | live (default) | dry_run (preview, nothing sent) | private_test. |
| function_names | array |
| timeout_seconds | integer |
| use_residential | boolean |
| execution_target | string | cloud | auto | local (the user's own desktop app). |
| residential_country | string |
{
"type": "object",
"properties": {
"wait": {
"type": "boolean"
},
"files": {
"type": "object"
},
"device": {
"type": "string"
},
"inputs": {
"type": "object",
"description": "Run inputs (top-level fields work too)."
},
"output": {
"type": "object"
},
"max_age": {
"type": "integer",
"minimum": 0,
"description": "Reuse a result younger than this many seconds (free). 0 = fresh."
},
"workflow": {
"type": "string",
"description": "Workflow name (or workflow_id)."
},
"persona_id": {
"type": [
"integer",
"string"
],
"description": "Run as this saved identity."
},
"workflow_id": {
"type": [
"integer",
"string"
],
"description": "A number, or 'local:<id>' (a workflow on the user's desktop)."
},
"function_name": {
"type": "string",
"description": "One function of a multi-function workflow."
},
"mutation_mode": {
"enum": [
"live",
"dry_run",
"private_test"
],
"type": "string",
"description": "live (default) | dry_run (preview, nothing sent) | private_test."
},
"function_names": {
"type": "array",
"items": {
"type": "string"
}
},
"timeout_seconds": {
"type": "integer"
},
"use_residential": {
"type": "boolean"
},
"execution_target": {
"type": "string",
"description": "cloud | auto | local (the user's own desktop app)."
},
"residential_country": {
"type": "string"
}
}
}| preview_chars | integer |
| respect_robots | boolean |
| use_residential | boolean | Residential network for a bot wall (automatic retry when refused). |
| residential_country | string |
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Up to 20 known pages, read in parallel."
},
"top_n": {
"type": "integer",
"maximum": 20,
"minimum": 1,
"description": "With url = a listing: also read its N top-ranked item pages (max 20)."
},
"device": {
"type": "string"
},
"format": {
"enum": [
"markdown",
"html",
"both"
],
"type": "string",
"description": "markdown (default) | html (raw HTML) | both."
},
"persona_id": {
"type": [
"integer",
"string"
],
"description": "Read signed in as this saved identity (writ_personas)."
},
"render_mode": {
"type": "string",
"description": "auto (default: HTTP, a browser when the page needs JS) | http | browser."
},
"include_paths": {
"type": "array",
"items": {
"type": "string"
}
},
"preview_chars": {
"type": "integer"
},
"respect_robots": {
"type": "boolean"
},
"use_residential": {
"type": "boolean",
"description": "Residential network for a bot wall (automatic retry when refused)."
},
"residential_country": {
"type": "string"
}
}
}| Interval in minutes. |
{
"type": "object",
"properties": {
"tz": {
"type": "string",
"description": "IANA timezone."
},
"days": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Weekdays 1=Mon..7=Sun (weekly)."
},
"kind": {
"type": "string",
"description": "interval | daily | weekly."
},
"time": {
"type": "string",
"description": "HH:MM (daily/weekly)."
},
"inputs": {
"type": "object"
},
"enabled": {
"type": "boolean"
},
"function": {
"type": "string"
},
"workflow": {
"type": "string"
},
"functions": {
"type": "array",
"items": {
"type": "string"
}
},
"workflow_id": {
"type": "integer"
},
"every_minutes": {
"type": "integer",
"description": "Interval in minutes."
}
}
}| string |
| Name or id; local:<n> for a desktop workflow. |
| max_chars | integer |
| workflow_id | integer |
| step_updates | array | [{index, patch}] merged into those recorded steps. |
| function_name | string |
| replace_steps | array |
| validate_only | boolean | true previews and validates; nothing is saved. |
| function_updates | array | Targeted edits of one function: [{function_name, patch | json_edits | script_edits}]. |
| regenerate_skill | boolean |
| expected_updated_at | string |
{
"type": "object",
"properties": {
"path": {
"type": "string"
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1
},
"patch": {
"type": "object",
"description": "Settings and metadata to change; {\"name\": \"New name\"} renames it."
},
"device": {
"type": "string"
},
"offset": {
"type": "integer",
"minimum": 0
},
"copy_to": {
"enum": [
"cloud",
"desktop"
],
"type": "string"
},
"section": {
"enum": [
"source",
"flow",
"contract"
],
"type": "string"
},
"step_id": {
"type": "string"
},
"verbose": {
"type": "boolean"
},
"operator": {
"type": "string"
},
"workflow": {
"type": "string",
"description": "Name or id; local:<n> for a desktop workflow."
},
"max_chars": {
"type": "integer",
"maximum": 20000,
"minimum": 1000
},
"workflow_id": {
"type": "integer"
},
"step_updates": {
"type": "array",
"items": {
"type": "object"
},
"description": "[{index, patch}] merged into those recorded steps."
},
"function_name": {
"type": "string"
},
"replace_steps": {
"type": "array",
"items": {
"type": "object"
}
},
"validate_only": {
"type": "boolean",
"description": "true previews and validates; nothing is saved."
},
"function_updates": {
"type": "array",
"items": {
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"description": "Targeted edits of one function: [{function_name, patch | json_edits | script_edits}]."
},
"regenerate_skill": {
"type": "boolean"
},
"expected_updated_at": {
"type": "string"
}
}
}| build_id | integer |
| anonymous | boolean |
| persona_id | integer |
| ai_supervise | boolean |
| skip_existing | boolean | Skip the proposal of the user's own matching workflows. |
| respect_robots | boolean |
| use_residential | boolean |
| execution_target | string |
| skip_marketplace | boolean | Skip the marketplace proposals. |
| residential_country | string |
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"goal": {
"type": "string"
},
"mode": {
"enum": [
"guided",
"intelligent",
"auto",
"fast",
"crawl",
"browser",
"regular",
"deep"
],
"type": "string",
"description": "guided (default: the caller drives) | intelligent (Writ builds it alone, on request) | auto | fast | crawl | browser."
},
"level": {
"enum": [
"light",
"deep"
],
"type": "string"
},
"scope": {
"type": "string"
},
"device": {
"type": "string"
},
"save_as": {
"type": "string"
},
"build_id": {
"type": "integer"
},
"anonymous": {
"type": "boolean"
},
"persona_id": {
"type": "integer"
},
"ai_supervise": {
"type": "boolean"
},
"skip_existing": {
"type": "boolean",
"description": "Skip the proposal of the user's own matching workflows."
},
"respect_robots": {
"type": "boolean"
},
"use_residential": {
"type": "boolean"
},
"execution_target": {
"type": "string"
},
"skip_marketplace": {
"type": "boolean",
"description": "Skip the marketplace proposals."
},
"residential_country": {
"type": "string"
}
}
}| string |
| entry_url | string |
| max_steps | integer |
| threshold | number | string | Price watch: act once when the price reaches this number. |
| monitor_id* | integer |
| recipients | array | e.g. ["email:3"]; omitted = every enabled recipient. |
| workflow_id | integer |
| threshold_op | string | lte (default) | lt | gte | gt. |
| ai_session_id | integer |
| cooldown_minutes | integer |
{
"type": "object",
"required": [
"monitor_id",
"action"
],
"properties": {
"buy": {
"type": "object",
"description": "Run the workflow or task as a purchase (saved as a rehearsal until armed)."
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"action": {
"enum": [
"workflow",
"notify",
"ai_task"
],
"type": "string",
"description": "notify | workflow | ai_task."
},
"device": {
"type": "string"
},
"prompt": {
"type": "string",
"description": "action='ai_task': what the agent does."
},
"enabled": {
"type": "boolean"
},
"message": {
"type": "string"
},
"channels": {
"type": "array",
"items": {
"type": "string"
},
"description": "Notification channels, e.g. [\"email\",\"pushover\"]."
},
"workflow": {
"type": "string"
},
"entry_url": {
"type": "string"
},
"max_steps": {
"type": "integer"
},
"threshold": {
"type": [
"number",
"string"
],
"description": "Price watch: act once when the price reaches this number."
},
"monitor_id": {
"type": "integer"
},
"recipients": {
"type": "array",
"items": {
"type": "string"
},
"description": "e.g. [\"email:3\"]; omitted = every enabled recipient."
},
"workflow_id": {
"type": "integer"
},
"threshold_op": {
"enum": [
"lt",
"lte",
"gt",
"gte"
],
"type": "string",
"description": "lte (default) | lt | gte | gt."
},
"ai_session_id": {
"type": "integer"
},
"cooldown_minutes": {
"type": "integer"
}
}
}