# Actions When [making a Browser Request](/docs/api-reference/post-v1-browser-requests.md), you can specify a list of actions you want us to perform on the requested web page. These actions conform to the following format: {% code overflow="wrap" fullWidth="false" %} ```json { "type": "", //the type of the action //other params follow as key value pairs "key": value //string, number, etc. } ``` {% endcode %} ### Universal Parameters All actions have the following parameters:

Name	Type	Required	Description
`type`	`string`	true	The type name of the action.
`continue_on_fail`	`boolean`	false	Should execution of further actions continue or throw an error if this action fails. Default: `false`
`customId`	`string`	false	A customId to help you find the action in the response. Default: `null`

#### Action Execution Actions are carried out in the order they are submitted. Every action type has a `continue_on_fail` parameter, which defaults to `false`.This means that if any action fails, the execution of the browser request ends, and an error will be returned. Setting `continue_on_fail` to `true` ensures that all actions are carried out, regardless of the previous action's results, and an error will not be returned. #### Custom Id As shown above, you can submit a customId with each action you submit to the API. We'll include this Id in the outputs from the browser request so you can find a certain action's output and/or status easily in the response. ## Response Format When a browser request has completed, information on an action's execution {% code fullWidth="false" %} ```json { "id": "", //a unique id given to the action by Gaffa "type": "capture_screenshot", //the type of the action "query": "", //a representation of the action in querystring format "timestamp": "", //the UTC timestamp the action was executed "output": "" //if the action has an output, you will find a URL for this here, "error": "" //if the request fails, the error message will be returned here } ``` {% endcode %} ## Supported Actions The Gaffa API supports the following actions, detailed below. Click the "read more" buttons to read more information about each type. ### Actions without outputs

Type	Description	Read More
`click`	Click on a given element	Click
`scroll`	Scroll to a particular point on the page or, in the case of pages with infinite scrolling, scroll until a given time has elapsed.	Scroll
`type`	Type the provided text into a given element	Type
`wait`	Wait for a given time to elapse or an element to appear on page before proceeding to the next action.	Wait

### Actions with outputs

Type	Description	Read More
`capture_cookies`	Save a JSON object of cookies for the current page	Capture Cookies
`capture_dom`	Export the raw DOM page data	DOM
`capture_screenshot`	Capture a screenshot of the web page	Screenshot
`capture_snapshot`	Create a completely static version of the web page which can be accessed offline	Snapshot
`download_file`	Download an online file using Gaffa	Download File
`generate_markdown`	Convert the page into markdown	Markdown
`generate_simplified_dom`	Generate a simplified version of the DOM	Simplified DOM
`parse_json`	Parse online data to a defined JSON schema	JSON Parsing
`print`	Print the web page to a PDF	Print

--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://gaffa.dev/docs/features/browser-requests/actions.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.