# riveterhq-com Runs API

**Canonical:** https://apis.io/apis/riveterhq-com/riveterhq-com-runs-api/  
**Provider:** riveterhq-com — https://apis.io/providers/riveterhq-com/  
**Base URL:** https://api.riveterhq.com/v1  
**Documentation:** https://docs.riveterhq.com/

riveterhq-com Runs API is one of 8 APIs that [riveterhq-com](https://apis.io/providers/riveterhq-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Runs. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The uniform lifecycle for every async operation — status, results, stop. **The run** (returned by kickoffs and every `/runs` endpoint): ```json { "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-...", "result_url": "https://api.riveterhq.com/v1/runs/run_018f6a70-.../result", "started_at": "2026-01-15T12:00:00Z", "finished_at": null, "error": null, "enrichment_id": "enr_018f5b60-...", "enrichment_name": "My Enrichment" } ``` Related resource ids (`enrichment_id`, `dataset_id`, `extraction_id`, `monitor_id`) appear when they apply to the run. A kickoff that took a legacy mode adds `legacy` ([LegacyNotice](#model/legacynotice)).

## Operations (5)

| Method | Path | Summary |
|---|---|---|
| GET | `/runs/{id}` | run status |
| GET | `/runs/{id}/result` | run result |
| POST | `/runs/{id}/stop` | stop run |
| GET | `/runs` | list runs |
| GET | `/runs/summary` | list runs (summary) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/riveterhq-com/openapi/riveterhq-com-runs-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-tool-catalog-schema.json
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-run-schema.json
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-enrichment-schema.json
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-monitor-schema.json
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-dataset-schema.json
- **JSONSchema** — https://artifacts.apis.io/riveterhq-com/json-schema/riveterhq-com-dataset-row-schema.json

## Other riveterhq-com APIs (7)

- [riveterhq-com Account API](https://apis.io/apis/riveterhq-com/riveterhq-com-account-api/)
- [riveterhq-com Configured list builds API](https://apis.io/apis/riveterhq-com/riveterhq-com-configured-list-builds-api/)
- [riveterhq-com Datasets API](https://apis.io/apis/riveterhq-com/riveterhq-com-datasets-api/)
- [riveterhq-com Enrich API](https://apis.io/apis/riveterhq-com/riveterhq-com-enrich-api/)
- [riveterhq-com Extractions API](https://apis.io/apis/riveterhq-com/riveterhq-com-extractions-api/)
- [riveterhq-com Monitors API](https://apis.io/apis/riveterhq-com/riveterhq-com-monitors-api/)
- [riveterhq-com Tools API](https://apis.io/apis/riveterhq-com/riveterhq-com-tools-api/)

## Tags

Runs

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/riveterhq-com/riveterhq-com-runs-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/riveterhq-com/.