Relayplex
Jobs & Actions

Automate outbound HTTP

Define an Action once (scrape a page or call a credentialed API), then run it on demand or attach a Job to repeat it on a schedule. This page renders the automation, scrape, and good-citizen sections of the canonical api-reference.json record agents consume.

Jobs & Actions in 5 minutes
  1. Check entitlement. GET /v1/limits — confirm actionsEnabled / jobsEnabled and read your caps. Disabled plans get NOT_ENTITLED (403). Jobs & Scraping are off on all self-serve tiers by default and included on Enterprise; Pro, Agency, and Enterprise accounts can have them enabled after a short interview with the Relayplex team (hello@relayplex.com) — the grant lands in your account overlay and shows up in GET /v1/limits.
  2. Create an Action. POST /v1/actions with an http.scrape or http.request spec. Add an output to write results into a site workspace, or omit it to get the body back inline.
  3. Run it. One-off: POST /v1/actions/:id/run (send an Idempotency-Key for mutating requests). Repeating: POST /v1/jobs with an intervalSec >= 15.
  4. Read history. GET /v1/runs?jobId=… shows status, httpStatus, and RU charged per execution.
Auth for all of the above: Authorization: Bearer rlpx_… (your org API key) against api.relayplex.com.

Loading the published reference record…