Skip to main content
POST
Run a Preset
Runs a preset and answers the way the job behind it answers.
  • A template preset starts a template run. The response is the same as Run a Template, with presetId added; poll the run with GET /template-runs/{runId}.
  • A tool preset sends its saved request to the tool. The response is exactly that tool’s response, with presetId and tool added: a map answers with its links straight away, a scrape or crawl with a job ID to poll at its own endpoint.
A map preset, shortened to one link:

Change some inputs for one run

overrides replaces template inputs, or request fields of a tool preset, for this run only. The preset itself doesn’t change.
That run mapped the same site for typing instead of asyncio. Add "wait": true to wait for a quick result, as with a template run or a batch scrape.

Errors

Anything else (not enough credits, a bad override) comes back from the tool or template as it would for a direct request.

Authorizations

Authorization
string
header
required

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

Path Parameters

presetId
string
required

The preset's ID.

Body

application/json
overrides
object

Change some inputs (template presets) or request fields (tool presets) for this run only, such as { "search": "typing" }.

wait
boolean
default:false

Wait for a quick result, where the tool supports it.

Response

Finished (a map, or a run that finished within wait).

The response is of type object.