Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Json Experiment Artifact Table

GET/api/v2/models/{modelRid}/experiments/{experimentRid}/artifactTables/{experimentArtifactTableName}/json
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.

Read table data from an experiment artifact as a streamed binary response containing JSON. The response body is a JSON array of row objects, where each object maps column names to values. Results are paginated by row count with a default page size of 10 and a maximum of 100.

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.

experimentArtifactTableName
string

The name of an experiment artifact.

Query parameters

pageSize
integeroptional

Maximum number of rows to return. Default is 10, maximum is 100.

offset
integeroptional

Number of rows to skip from the beginning. Defaults to 0.

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/artifactTables/predictions_table/json?preview=true"

Error responses

Error Name
ExperimentArtifactNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested artifact was not found in the experiment.
ParametersmodelRid, experimentRid, artifactName
ModelExperimentNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe requested experiment was not found or the user lacks permission to access it.
ParametersmodelRid, experimentRid
JsonExperimentArtifactTablePermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not json the ExperimentArtifactTable.
ParametersexperimentRid, experimentArtifactTableName, modelRid