Skip to main content
POST
Run a Template
A run takes the template’s inputs, reads the pages it needs and returns one row per result. Find a template’s slug and inputs with List Templates and Get a Template, or on its page in the dashboard (the API tab there shows the exact request).

Example request

The run starts and the response is 202 with status: "running":
inputs comes back with the defaults filled in. Poll GET /template-runs/{runId} every few seconds until status isn’t running.

Wait for a quick result

Add "wait": true and a quick run comes back complete, with its rows, in the same response (200). Templates that read up to 10 pages wait up to 45 seconds; search-based templates wait up to 20 seconds. Anything longer answers 202 as above and you poll it as usual. Templates that run several searches (such as rank trackers), and runs with a second step switched on, always answer 202.

Statuses

Cost

A run costs what the same job costs with the tool behind it, usually 1 credit per page read. Most templates use no AI. Estimate a Template Run gives the number before you run it, for free. Pages that fail aren’t charged, and a run whose site can’t be read fails without charging.

Errors

Authorizations

Authorization
string
header
required

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

Path Parameters

slug
string
required

The template's slug.

Body

application/json
inputs
object

The template's inputs, by key. GET /templates/{slug} lists them.

wait
boolean
default:false

Wait for a quick run to finish: up to 45 seconds for templates that read up to 10 pages, 20 seconds for search-based ones. Templates that run several searches, or have a second step on, ignore it.

Response

The run finished within wait.

status
enum<string>
Available options:
success
run
object