VindexDocs
    Vindex docs
    Dashboardgetvindex.com

    API reference

    Meta

    Health and pointers. No key needed.

    Pointers to the docs and health check

    GET/no key needed

    Request

    cURL
    curl "https://api.getvindex.com/"

    Response 200

    OK

    Example
    {
  "name": "adult-platform",
  "version": "0.2.0",
  "docs": "https://docs.getvindex.com",
  "openapi": "https://api.getvindex.com/openapi.json",
  "health": "https://api.getvindex.com/health"
}

    Liveness and worker version

    GET/healthno key needed

    Request

    cURL
    curl "https://api.getvindex.com/health"

    Response 200

    OK

    Example
    {
  "ok": true,
  "version": "0.2.0",
  "engine": "v1"
}