APIReference

Datasets API

Generated OpenAPI reference for the Datasets API surface.

Overview

Datasets endpoints are part of the public Everyn API. Dataset read models. Use /v1/dataset-uploads for CSV intake.

Endpoints

The generated OpenAPI component below contains request parameters, request bodies, response bodies, status codes, and schemas for this tag.

Endpoint summary for quick scanning before using the generated reference:

Failures use the PublicErrorEnvelope shape with an X-Request-Id header. Most endpoints below return 400, 401, 403, 404, 409, 422, 429; the few that differ list their own statuses in the table, which otherwise shows only success responses. See API errors for the envelope and recovery patterns.

MethodPathSummaryRequest bodySuccess response
GET/v1/datasetsList DatasetsNone.200 application/json: CountedBidirectionalPage_DatasetReadResponse_
GET/v1/datasets/{dataset_id}Get DatasetNone.200 application/json: DatasetReadResponse
GET/v1/datasets/{dataset_id}/profileGet Dataset ProfileNone.200 application/json: DatasetProfileResponse
GET/v1/datasets/{dataset_id}/rowsList Dataset RowsNone.200 application/json: Page_DatasetRowResponse_

Loading API reference...