Skip to main content

​
API reference

Each product has an overview page with context, monitoring endpoints, and integration flows — then generated endpoint pages from OpenAPI below it in the sidebar.
ProductOverviewBase path
AuthAuth API/api/v1
HRHR API/api/v1/hr
PayrollPayroll API/api/v1/payroll
PayPay API/api/v1/payments
BooksBooks API/api/v1
UtilsUtils API/api/v1/app
Open any endpoint to see parameters, request bodies, responses, and try the interactive playground with cURL and Node.js examples.

​
Playground authorization

The playground prompts for three credentials on every product route (including health checks):
HeaderPlayground fieldRequired value
AuthorizationBearerYour access token JWT
X-Fluide-Api-KeyX-Fluide-Api-KeyYour fl_dev_... developer key
X-Fluide-Client-IdX-Fluide-Client-Idfluide-developer
Click Authorize before Send. If you skip it, the API returns 400 Authorization field missing or 401 with codes such as MISSING_API_KEY or CLIENT_AUDIENCE_MISMATCH.

Get credentials

Header reference and step-by-step playground setup.

​
Operations endpoints

Every service exposes operational routes under the Operations tag group where applicable:
  • App — service root (GET)
  • Health — liveness and dependency checks
  • Prometheus — metrics scrape target (/metrics or product-prefixed path)

​
Keep specs up to date

node export-openapi.mjs