Files
geointel/contracts/api/response-envelope.md
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

624 B

API Response and Error Contract

Standard error

All API errors must use:

{
  "error": {
    "code": "STRING_CODE",
    "message": "Human readable message.",
    "details": {}
  }
}

Job response

Long-running operations return:

{
  "job_id": "uuid",
  "analysis_run_id": "uuid",
  "status": "queued",
  "status_url": "/analysis-runs/{id}"
}

Resource metadata

Resources should include:

{
  "id": "uuid",
  "created_at": "ISO-8601",
  "updated_at": "ISO-8601"
}

Pagination

List endpoints use:

{
  "items": [],
  "total": 0,
  "limit": 50,
  "offset": 0
}