# HelloBooks AI API

**Canonical:** https://apis.io/apis/hellobooks-ai/hellobooks-ai-api/  
**Provider:** HelloBooks AI — https://apis.io/providers/hellobooks-ai/  
**Documentation:** https://hellobooks.ai/docs/api-reference/endpoints

HelloBooks AI API is published by [HelloBooks AI](https://apis.io/providers/hellobooks-ai/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

HelloBooks AI API as documented publicly: 26 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| GET | `/hellobooks/webhook` | GET /hellobooks/webhook |
| POST | `/hellobooks/webhook` | POST /hellobooks/webhook |
| GET | `/orgs/{o}/entities/{e}/bom-reports/component-usage` | Components ranked by reuse |
| GET | `/orgs/{o}/entities/{e}/bom-reports/cost-analysis` | BOM cost analysis report |
| DELETE | `/orgs/{o}/entities/{e}/boms` | Soft-archive (bulk; body { ids: [...] } ) |
| GET | `/orgs/{o}/entities/{e}/boms` | List BOMs (filterable by status, item, search) |
| POST | `/orgs/{o}/entities/{e}/boms` | Create BOM |
| GET | `/orgs/{o}/entities/{e}/boms/{id}` | Read one BOM |
| PUT | `/orgs/{o}/entities/{e}/boms/{id}` | Update BOM |
| GET | `/orgs/{o}/entities/{e}/boms/{id}/material-requirements` | Explode BOM × plannedQty into component needs |
| GET | `/orgs/{o}/entities/{e}/items/{itemid}/active-bom` | Get active BOM for an item (used by Work Order creation) |
| GET | `/orgs/{o}/entities/{e}/items/{itemid}/recipe` | Get recipe by output item recipe:read |
| GET | `/orgs/{o}/entities/{e}/items/{itemid}/where-used` | Find all BOMs that consume this item |
| DELETE | `/orgs/{o}/entities/{e}/recipes` | Soft-archive (bulk) recipe:delete |
| GET | `/orgs/{o}/entities/{e}/recipes` | List recipe:read |
| POST | `/orgs/{o}/entities/{e}/recipes` | Create recipe:create |
| GET | `/orgs/{o}/entities/{e}/recipes/{id}` | Read one recipe:read |
| PUT | `/orgs/{o}/entities/{e}/recipes/{id}` | Update recipe:update |
| GET | `/public/v1/health` | Returns 200 ok with a server timestamp. Use as a reachability and auth-acceptance probe. |
| GET | `/public/v1/me` | Returns the current install context — who you are, which tenant you are scoped to, and which scopes you hold. |
| GET | `/public/v1/orgs/{o}/entities/{e}/bills` | bills:read |
| GET | `/public/v1/orgs/{o}/entities/{e}/customers` | customers:read |
| GET | `/public/v1/orgs/{o}/entities/{e}/invoices` | invoices:read |
| GET | `/public/v1/orgs/{orgid}/entities/{entityid}/webhooks` | List active webhook subscriptions for the install, including delivery health metrics. |
| POST | `/public/v1/orgs/{orgid}/entities/{entityid}/webhooks` | Subscribe to one or more event topics. Returns the subscription row and a one-time signing_secret. |
| DELETE | `/public/v1/orgs/{orgid}/entities/{entityid}/webhooks/{id}` | Soft-delete a webhook subscription. Subsequent listings exclude it; the row is preserved for audit. |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/hellobooks-ai/openapi/_ae-authored/hellobooks-ai-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-get-orgs-oentities-eboms-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-get-hellobooks-webhook-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-post-hellobooks-webhook-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-post-orgs-oentities-eboms-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-get-orgs-oentities-eboms-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hellobooks-ai/json-schema/hellobooks-ai-post-hellobooks-webhook-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/hellobooks-ai/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hellobooks-ai/hellobooks-ai-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hellobooks-ai/.