Health

Verify that the edge runtime is operational and inspect the organization and model permissions tied to your API key.

GET /v1/health

Authentication

• Authentication is required. Include a valid df_ API key in the Authorization header, or rely on the machine-local default credential. See Authentication.

---

Request Body

• This endpoint does not require a request body.

---

Response

The data payload describes the service and echoes the org and allowed models carried by your key.

Field	Type	Description
service	string	Always deepfaic-edge.
org	string	The organization configured on this edge install.
token_org	string	The organization bound to your API key.
token_exp	number	Unix expiry timestamp of your API key.
allowed_models	string[]	The models your key is permitted to run.
offline	boolean	true (Edge runs offline)

{
  "status": true,
  "code": 200,
  "message": "Edge API healthy",
  "data": {
    "service": "deepfaic-edge",
    "org": "acme",
    "token_org": "acme",
    "token_exp": 1767139200,
    "allowed_models": ["model1", "model2", "model3", "..."],
    "offline": true
  }
}

---

Example Request

curl http://<edge-host>:9123/v1/health \
  -H "Authorization: Bearer df_..."