---
name: brainbi
description: "brainbi API skill. Use when working with brainbi for api. Covers 33 endpoints."
version: 1.0.0
generator: lapsh
---

# brainbi

## Auth
ApiKey Authorization in header

## Base URL
Not specified.

## Setup
1. Set your API key in the appropriate header
2. GET /api/rule -- this resource lists all pricing rules that are currently saved in you account
3. POST /api/rule -- create first rule

## Endpoints
33 endpoints across 1 group. See references/api-spec.lap for full details.

### Api
| Method | Path | Description |
|--------|------|-------------|
| GET | /api/rule | This resource lists all pricing rules that are currently saved in you account |
| GET | /api/rule/1 | This resource returns a specific rule {id} |
| POST | /api/rule | To update a product, please use the listed attributes listed underneath |
| GET | /api/rule/ruleData/1 | This resource lists all data that wa saved for pricing rules |
| GET | /api/rule/ruleData/1/latest | This resource lists only the latest data point that wa saved for a pricing rule |
| GET | /api/products | This resource lists all products that are currently saved in you account |
| GET | /api/products/1 | This resource returns a specific product {id} |
| GET | /api/products/23767/rules | This resource returns all available rules for a product {id} |
| POST | /api/products | To update a product, please use the listed attributes listed underneath |
| GET | /api/analyze/pricing | To update a product, please use the listed attributes listed underneath |
| GET | /api/analyze/pricing | To update a product, please use the listed attributes listed underneath |
| PUT | /api/products | To update a product, please use the listed attributes listed underneath |
| DELETE | /api/products/1137 | Products |
| GET | /api/customers | This resource lists all cusomters that are currently saved in your account |
| GET | /api/customers/1 | This resource returns a specific customer {id} |
| POST | /api/customers | To update a customer, please use the listed attributes listed underneath |
| PUT | /api/customers/1137 | Customers |
| DELETE | /api/customers/1137 | Customers |
| GET | /api/orders | This resource lists all orders that are currently saved in your account |
| GET | /api/orders/12 | This resource returns a specific order {id} |
| POST | /api/orders | To update a order, please use the listed attributes listed underneath |
| PUT | /api/orders/1137 | Orders |
| DELETE | /api/orders/1137 | Orders |
| GET | /api/orderlines | This resource lists all order lines that are currently saved in your account |
| GET | /api/orderlines/123 | This resource returns a specific order line {id} |
| POST | /api/orderlines | To update a order line, please use the listed attributes listed underneath |
| PUT | /api/orderlines/1137 | OrderLines |
| DELETE | /api/orderlines/1137 | OrderLines |
| GET | /api/seo/ranking/latest | This resource lists all pricing rules that are currently saved in you account |
| POST | /api/login | Use this endpoint to make the initial call with your email and password (same as on brainbi |
| POST | /api/register | Use this endpoint to make the initial call with your email and password (same as on brainbi |
| POST | /api/register_woocommerce | Use this endpoint to make the initial call with your email and password (same as on brainbi |
| POST | /api/logout | Once you are done, call this endpoint to lock your account! |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all rule?" -> GET /api/rule
- "List all 1?" -> GET /api/rule/1
- "Create a rule?" -> POST /api/rule
- "List all latest?" -> GET /api/rule/ruleData/1/latest
- "List all products?" -> GET /api/products
- "List all rules?" -> GET /api/products/23767/rules
- "Create a product?" -> POST /api/products
- "List all pricing?" -> GET /api/analyze/pricing
- "List all customers?" -> GET /api/customers
- "Create a customer?" -> POST /api/customers
- "List all orders?" -> GET /api/orders
- "List all 12?" -> GET /api/orders/12
- "Create a order?" -> POST /api/orders
- "List all orderlines?" -> GET /api/orderlines
- "List all 123?" -> GET /api/orderlines/123
- "Create a orderline?" -> POST /api/orderlines
- "Create a login?" -> POST /api/login
- "Create a register?" -> POST /api/register
- "Create a register_woocommerce?" -> POST /api/register_woocommerce
- "Create a logout?" -> POST /api/logout
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints return the modified resource on success

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)