RIriveterhq
Runs

stop run

Changed on

Stop a run early. Works for every run type. Already-finished runs are left untouched; the response is the run either way.

post/runs/{id}/stop

Request

Path parameters

idstring required

The run id (run_...)

Response

The run after the stop

idstring required

The run id (run_...)

type'enrichment' | 'dataset_build' | 'extraction' | 'scrape' | 'quick_search' | 'search_agent' required

What kind of run this is

status'pending' | 'enqueued' | 'processing' | 'success' | 'stopped' required
credits_usednumber

Credits consumed so far

app_urlstring uri

Link to view this run in the Riveter app

result_urlstring uri required

Where to fetch the run's output

started_atstring date-time nullable
finished_atstring date-time nullable
stopped_reason'user_request' | 'credit_limit' | 'error'

Why the run has status stopped. Only present on stopped runs. user_request: stopped through the API or the app. credit_limit: the account ran out of credits. error: the run failed (internal error, or every enrichment cell failed); error.message has the detail.

enrichment_idstring

Present when the run belongs to an enrichment

enrichment_namestring
dataset_idstring

Present on dataset-build runs

extraction_idstring

Present on extraction runs

monitor_idstring

Present on monitor-scheduled runs

webhook_urlstring uri

Present when the run has a webhook configured

Example response

{
  "id": "run_018f6a70-1234-7abc-89ab-0123456789ab",
  "type": "enrichment",
  "status": "processing",
  "progress": {
    "percent_complete": 40,
    "estimated_seconds_remaining": 90,
    "elapsed_seconds": 60,
    "completed_cells": 4,
    "total_cells_expected": 10,
    "not_found_cells": 0
  },
  "credits_used": 2.5,
  "credit_detail": {
    "estimate": {
      "minimum": 0,
      "maximum": 10,
      "charged_upfront": false
    },
    "credits_used": 2.5
  },
  "app_url": "https://app.riveterhq.com/runs/run_018f6a70-1234-7abc-89ab-0123456789ab",
  "result_url": "https://api.riveterhq.com/v1/runs/run_018f6a70-1234-7abc-89ab-0123456789ab/result",
  "started_at": "2026-01-15T12:00:00Z",
  "finished_at": null,
  "error": null,
  "enrichment_id": "enr_018f5b60-1234-7abc-89ab-0123456789ab",
  "enrichment_name": "My Enrichment"
}

Changes

  • fac56b649559Revision changes
    • warning

      removed the optional property from the response with the status

  • dcb4d45ade1aRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status