RIriveterhq
Dataset CRUD

read dataset

Changed on

One dataset: input_columns, index_column, the bound enrichment_id and its output_columns (names; prompts and schemas are on GET /enrichments/{id}), row_count, whether the rows expired (rows_expired), whether a CSV import is still landing (import_in_progress), and the five newest runs (list generation and fills).

get/datasets/{id}

Request

  • Base URL
    https://api.riveterhq.com/v1
  • Auth
    HTTP bearer

Path parameters

idstring required

The dataset id (ds_...)

Response

The dataset

idstring

ds_...

namestring nullable
input_columnsstring[]

Input column names, in order (row identity)

index_columnstring nullable

The input column rows are unique on

enrichment_idstring nullable

The bound enrichment (its output columns are the dataset's)

output_columnsstring[]

Output column names, in order (from the bound enrichment; [] without one). Prompts and schemas are on GET /enrichments/{enrichment_id}

row_countinteger
rows_expiredboolean

True once the rows were removed by retention; the structure stays

import_in_progressboolean

A CSV import accepted with 202 has not landed yet

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "ds_018f6a70-1234-7abc-89ab-0123456789ab",
  "name": "Targets",
  "input_columns": [
    "Company",
    "Website"
  ],
  "index_column": "Company",
  "enrichment_id": "enr_018f5b60-1234-7abc-89ab-0123456789ab",
  "output_columns": [
    "CEO",
    "HQ city"
  ],
  "row_count": 2,
  "rows_expired": false,
  "import_in_progress": false,
  "runs": [
    {
      "id": "run_018f6a70-cccc-7abc-89ab-0123456789ab",
      "type": "enrichment",
      "status": "success",
      "created_at": "2026-10-01T12:05:00Z",
      "finished_at": "2026-10-01T12:07:00Z"
    }
  ],
  "created_at": "2026-10-01T12:00:00Z",
  "updated_at": "2026-10-01T12:07:00Z"
}

Changes

  • fac56b649559Revision changes
    • info

      api tag Dataset CRUD added

    • info

      api tag Datasets removed

  • 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