Files
geointel/docs/API_EXAMPLE_RESPONSES.md
T
Jens faeb58ef6d
GeoIntel release gates / Compile, test, contracts and builds (push) Successful in 1m49s
GeoIntel release gates / Python and npm vulnerability policy (push) Successful in 21s
GeoIntel release gates / Production AI image, SBOM and container scan (push) Successful in 5m39s
GeoIntel release gates / Deploy exact gated revision to Unraid (push) Failing after 58m43s
Initial public release
2026-08-31 21:56:53 +02:00

2.0 KiB

API Example Responses

Error Envelope

{
  "error": {
    "code": "DATASET_UNSUPPORTED_FORMAT",
    "message": "The uploaded file extension is not supported.",
    "details": {"extension": ".txt"},
    "request_id": "req_01HY"
  }
}

Health

{
  "status": "ok",
  "services": {
    "database": "ok",
    "redis": "ok",
    "storage": "ok"
  },
    "version": "1.0.0"
}

Project

{
  "id": "prj_geel_demo",
  "name": "Geel Building Detection Demo",
  "description": "Portfolio demo for GeoAI object detection and GRB QA.",
  "region": "Kempen",
  "created_at": "2026-06-10T00:00:00Z"
}

Area FeatureCollection

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "id": "area_geel_center",
        "name": "Geel Centrum",
        "area_m2": 1250000
      },
      "geometry": {
        "type": "Polygon",
        "coordinates": [[[4.98,51.16],[5.00,51.16],[5.00,51.18],[4.98,51.18],[4.98,51.16]]]
      }
    }
  ]
}

Dataset Metadata

{
  "id": "ds_grb_buildings_geel",
  "project_id": "prj_geel_demo",
  "name": "GRB Buildings Geel Demo",
  "dataset_type": "vector",
  "source": "demo_fixture",
  "status": "ready",
  "crs": "EPSG:4326",
  "bounds": [4.98, 51.16, 5.00, 51.18],
  "metadata": {
    "feature_count": 12,
    "geometry_types": ["Polygon"]
  }
}

Detection Run

{
  "id": "run_detection_001",
  "project_id": "prj_geel_demo",
  "analysis_type": "object_detection",
  "status": "completed",
  "parameters": {
    "model_id": "demo-yolo-buildings-v1",
    "confidence_threshold": 0.35,
    "tile_size": 512
  },
  "metrics": {
    "detection_count": 14,
    "mean_confidence": 0.82
  }
}

QA/QC Result

{
  "id": "qc_001",
  "analysis_run_id": "run_detection_001",
  "reference_dataset_id": "ds_grb_buildings_geel",
  "iou_threshold": 0.5,
  "metrics": {
    "true_positive": 11,
    "false_positive": 3,
    "false_negative": 1,
    "precision": 0.7857,
    "recall": 0.9167,
    "f1": 0.8462
  }
}