Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Evidently AI Snapshots API

Upload and query evaluation snapshots (reports and test suites)

Evidently AI Snapshots API is one of 4 APIs that Evidently AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Snapshots. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 12 operations across 12 paths, and defines 9 schemas. It is described by OpenAPI 3.0.1, at version 0.7.17.

Requests are made against 2 base URLs: https://app.evidently.cloud/api, http://localhost:8000/api.

12 operations 12 paths 9 schemas 1 DELETE9 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0.7.17
Base URL
https://app.evidently.cloud
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Evidently AI Snapshots API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token (API key) obtained from the Evidently platform settings. Set via the Authorization header or the EVIDENTLYAPIKEY environment variable.

Paths & Operations 12

Across 12 paths, the API surfaces 12 operations — 1 DELETE, 9 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Snapshots 12

Upload and query evaluation snapshots (reports and test suites)

GET
/projects/{project_id}/reports
List reports for a project
listReports 1 param → 200404
GET
/projects/{project_id}/snapshots
List snapshots for a project
listSnapshots 1 param → 200404
GET
/projects/{project_id}/{snapshot_id}/metadata
Get snapshot metadata
getSnapshotMetadata 2 params → 200404
GET
/projects/{project_id}/{snapshot_id}/data
Get snapshot widget data
getSnapshotData 2 params → 200404
GET
/projects/{project_id}/{snapshot_id}/download
Download a snapshot
downloadSnapshot 3 params → 200400404
GET
/projects/{project_id}/{snapshot_id}/graphs_data/{graph_id}
Get graph data from a snapshot
getSnapshotGraphData 3 params → 200404
POST
/v2/snapshots/{project_id}
Upload a snapshot
addSnapshot 1 param body → 201404
DELETE
/v2/snapshots/{project_id}/{snapshot_id}
Delete a snapshot
deleteSnapshot 2 params → 204404
GET
/v2/snapshots/{project_id}/metrics
List snapshot metrics
getSnapshotsMetrics 3 params → 200
GET
/v2/snapshots/{project_id}/labels
List metric labels
getSnapshotsMetricLabels 4 params → 200
GET
/v2/snapshots/{project_id}/label_values
List metric label values
getSnapshotsMetricLabelValues 5 params → 200
POST
/v2/snapshots/{project_id}/data_series_batch
Get metric data series (batch)
getSnapshotsMetricsDataBatch 3 params body → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SnapshotMetadata (6 properties), ReportModel (6 properties), ErrorDetail (2 properties), LabelsList (1 property). Each schema is shown below with its type and property counts.

MetricsList
object
List of metric type identifiers
1 property
BatchMetricData
object
Request body for batch metric data series retrieval
1 property
AddSnapshotResponse
object
Response returned after a successful snapshot upload
1 property
LabelValuesList
object
Distinct values for a metric label
1 property
LabelsList
object
List of label keys for a metric
1 property
SnapshotMetadata
object
Metadata for a single Evidently snapshot (report or test suite)
6 properties
ReportModel
object
Summary metadata for a snapshot-based report
6 properties
ErrorDetail
object
Error response body
2 properties
SeriesResponse
object
Time-series data response for metrics across snapshots

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

evidently-snapshots-api-openapi.yml Raw ↑

Other APIs Evidently AI publishes across the network.

Evidently AI Dashboards API
Evidently AI Projects API
Evidently AI Service API