Skip to main content
POST
Create a Preset
A preset is a saved job. There are two kinds:
  • Template preset (kind: "template"): a template and its inputs, such as Google Maps leads for dentists in Lekki.
  • Tool preset (kind: "tool"): the request body for scrape, batch, crawl, map, search or parse, exactly as you would send it to that endpoint.
Run either with Run a Preset, or watch it for changes.

Template preset

The inputs are checked the same way a run checks them, and missing defaults are filled in. Add columns to save which columns the dashboard table shows.

Tool preset

config must have what the tool requires: urls for scrape and batch, baseUrl for crawl, url for map, query for search, and url or fileId for parse. cookies and wait are never stored, so a preset never keeps a login.

Errors

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
kind
enum<string>
required
Available options:
template
name
string
required
template
string
required

The template's slug.

inputs
object
required

The template's inputs. Checked like a run.

description
string
columns
object[]

Optional. The columns the dashboard table shows.

Response

Saved.

status
enum<string>
Available options:
success
message
string
data
object