Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Parquet Experiment Series

GET/api/v2/models/{modelRid}/experiments/{experimentRid}/series/{experimentSeriesName}/parquet
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Retrieve raw time-series data for a single series as a streamed binary response in Apache Parquet format.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.

Path parameters

modelRid
string

The Resource Identifier (RID) of a Model.

experimentRid
string

The Resource Identifier (RID) of an Experiment.

experimentSeriesName
string

The name of a series (metrics tracked over time).

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Response body

body
string

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/models/ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9/experiments/ri.models.main.experiment.abc123/series/loss/parquet?preview=true"

Error responses

Error Name
ExperimentSeriesNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested series was not found in the experiment.
ParametersmodelRid, experimentRid, seriesName
ModelExperimentNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested experiment was not found or the user lacks permission to access it.
ParametersmodelRid, experimentRid
ParquetExperimentSeriesPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not parquet the ExperimentSeries.
ParametersexperimentSeriesName, experimentRid, modelRid