For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dataset Health Check

You can retrieve health check statistics for a dataset using the following endpoint:

curl "https://api.roboflow.com/:workspace/:project/health?api_key=$ROBOFLOW_API_KEY"

This returns class distribution, annotation counts, image dimension summaries, and other dataset quality metrics. See Dataset Health Check for more on what these statistics mean.

Query Parameters

Parameter
Type
Description

regenerate

boolean

Set to true to force a fresh recomputation of health statistics. By default, cached results are returned.

Response

The endpoint returns a JSON object with dataset health statistics:

{
  "health": true,
  "stats": {
    "numImages": 120,
    "numAnnotations": 842,
    "avgImageSize": [640, 480],
    "medianImageRatio": 1.33,
    "missingAnnotations": 3,
    "nullAnnotations": 5,
    "classDistribution": {
      "cat": 410,
      "dog": 432
    }
  }
}

The response includes dataset-level metrics such as image count, annotation count, class distribution, and image dimension statistics. Fields like heatmaps and per-image breakdowns are excluded from the API response.

Last updated

Was this helpful?