Authentication

Automation uses a key that starts with hfwk_. The server stores a hash. The full value is shown once when you generate it from HENDOI Settings or the HENFLOW Developers page. Prefer Authorization: Bearer hfwk_… or X-Henflow-Key. Confirm the key with GET /api/v1/usage.

Work this page from top to bottom. Read Before you call this API, then Request syntax, then the walkthrough. Sample numbers show field names only.

How to use this documentation page

1. Skim the intro so you know what meter this call spends.
2. Complete the walkthrough once with the dummy key, then again with your live key.
3. Copy a language sample and keep JSON key names identical.
4. On every response, read HTTP status first.
5. When automation returns 202, open Jobs and usage and poll until the job finishes.

Before you call this API

• You have an active HENDOI account and a live HENFLOW API key (hfwk_…).
• You create the key from HENDOI Settings → Generate API key for HENFLOW, or from the HENFLOW Developers page.
• You will treat every numeric sample on this page as a shape guide, not measured engineering data.

Request syntax

1. Method. GET.
2. URL. https://henflow.hendoi.com/api/v1/usage.
3. Header. Authorization: Bearer hfwk_demo_4c91e2ab8d07. Or send the raw key in X-Henflow-Key.
4. Body. None.

Step by step

1. Sign in at https://hendoi.com/login, open Settings, then Generate API key for HENFLOW. Copy the full hfwk_… key once.
2. Send GET to https://henflow.hendoi.com/api/v1/usage with the production host.
3. Prefer Authorization: Bearer hfwk_…. Or use X-Henflow-Key with no Bearer prefix.
4. Send the request with one of the language samples. Expect HTTP 200 when finished, or HTTP 202 with jobId when queued.
5. On 401, regenerate the key from Settings. On 403 with QUOTA_EXCEEDED, open Limits and errors.

Quick checklist

• □ Method and URL path are exact.
• □ Live HENFLOW API key is in the Authorization (or X-Henflow-Key) header.
• □ Client branches on HTTP status before reading result fields.

Example request

The key hfwk_demo_4c91e2ab8d07 is a dummy. Replace it before you send.

GET https://henflow.hendoi.com/api/v1/usage
Authorization: Bearer hfwk_demo_4c91e2ab8d07

If the request is accepted

{
  "ok": true,
  "usage": {
    "apiRequests": {
      "remaining": 496
    }
  }
}

If the request is not accepted

HTTP 401, missing or deactivated key:

{
  "error": "This API key is deactivated or was not recognized. Only an active key can call the API."
}

HTTP 403, a meter is used up:

{
  "error": "API usage limit reached.",
  "meter": "apiRequests",
  "code": "QUOTA_EXCEEDED"
}

Language samples

Replace the dummy key before you send. Keep JSON key names identical.

cURL

curl -s \
  "https://henflow.hendoi.com/api/v1/usage" \
  -H "Authorization: Bearer hfwk_demo_4c91e2ab8d07" \
  -w "\n%{http_code}\n"

Node.js

const res = await fetch("https://henflow.hendoi.com/api/v1/usage", {
  headers: { Authorization: "Bearer hfwk_demo_4c91e2ab8d07" }
});
const data = await res.json();
console.log(res.status, data);

Python

import requests
r = requests.get("https://henflow.hendoi.com/api/v1/usage", headers={"Authorization": "Bearer hfwk_demo_4c91e2ab8d07"})
print(r.status_code, r.json())