Skip to content

API: Scripted search

Research driven by a generated script: start a job, follow the live script and progress stream, and read the cited report.

Every HTML route returns JSON with Accept: application/json. Authentication: session cookie, X-API-KEY, Authorization: Bearer or Basic.

GET/scriptedsearchguest
Scripted search page

Question form, live script view, progress, report and recent runs.

curl -X GET -H 'Accept: application/json' 'https://molodetz.nl/scriptedsearch'
GET/scriptedsearch/jobsMember
List scripted searches

The signed-in member's jobs, newest first.

curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs'
POST/scriptedsearch/jobsMember
Start scripted search

Starts a background job for the question. One running job per member.

FieldTypeLocationRequired
querystringbodyyes
curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{"query": ""}' 'https://molodetz.nl/scriptedsearch/jobs'
GET/scriptedsearch/jobs/{uid}Member
Scripted search job

Status and, when finished, the parsed report, sources and script.

curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs/{uid}'
POST/scriptedsearch/jobs/{uid}/cancelMember
Cancel scripted search

Stops a running job; its events stay readable.

curl -X POST -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' -H 'Content-Type: application/json' -d '{}' 'https://molodetz.nl/scriptedsearch/jobs/{uid}/cancel'
DELETE/scriptedsearch/jobs/{uid}Member
Delete scripted search

Deletes a finished job with its events.

curl -X DELETE -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs/{uid}'
GET/scriptedsearch/jobs/{uid}/streamMember
Scripted search stream

Server-sent events with ids for resume: budget, stage, requirements, script, exec, cost, site, results, step, warning, round, telemetry, result, error, done.

curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs/{uid}/stream'
GET/scriptedsearch/jobs/{uid}/report.mdMember
Report download

Markdown report of a finished job.

curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs/{uid}/report.md'
GET/scriptedsearch/jobs/{uid}/script.rrsMember
Script download

Research script of a finished job.

curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY' 'https://molodetz.nl/scriptedsearch/jobs/{uid}/script.rrs'
16.7ms