# Builderly API reference

Base URL: http://debate.bg
Generated from the running server on 2026-11-05T12:03:32.889Z. Every mounted route is listed with the access it needs, the parameters its handler reads and the data models it uses.

## Authentication

Send `Authorization: Bearer <token>` where a route needs a token. Add `?ionic=true` to get JSON from routes that also render pages.

- **Admin token** (`admin`): Bearer token of a site admin (Authorization: Bearer <token>).
- **User token** (`user`): Bearer token of a signed-in user of the site.
- **Optional user** (`optional-user`): Works without a token; a user token personalises the answer.
- **User with access** (`user-priv`): A signed-in user whose plan grants access to the item.
- **Page access** (`page-priv`): Pages limited to some users check the token when one is sent.
- **Webhook signature** (`webhook`): Called by a provider; verified by its signature.
- **reCAPTCHA** (`recaptcha`): Needs a reCAPTCHA token from the site form.
- **System** (`system`): Internal - called by the platform itself.

### For AI assistants: getting a token

Public endpoints (Access: Public) need no token. Everything else - changing the site, or reading its orders, bookings, customers and other private data - needs the site owner's API token.

You cannot create a token yourself, and you must not ask for the owner's password. Ask the user for a token instead - you can send them this message as it is:

> To work with your site through its API, I need an API token from you:
> 1. Sign in to your Builderly admin: https://admin.max-media.io
> 2. Open Developers > API reference (or go straight to https://admin.max-media.io/tabs/site-builder/api-docs).
> 3. Press "Generate token", copy the token and paste it here.
> The token acts as you, so only share it in this chat. You can cancel it at any time by signing out of all devices.

Then send it with every request as `Authorization: Bearer <token>`, and add `?ionic=true` to get JSON. Calls go to the site's own address (its domain), not to the reference's.

The token acts as the user: say what you will change and wait for their yes before any request that creates, changes or deletes something, never repeat the token back, and never put it in a link or a file you share.

## Status codes

| Code | Name | Meaning |
| --- | --- | --- |
| 200 | OK | It worked. The answer is the object or list asked for. |
| 201 | Created | The object was created. Some endpoints send it back; others send an empty body. |
| 202 | Accepted | The work was started and finishes in the background - for example a video being processed ({ "status": "processing" }). Check back on the object. |
| 204 | No Content | It worked, and there is nothing to send back - for example after removing a staff member. |
| 301 | Moved Permanently | The address changed; follow the Location header. |
| 400 | Bad Request | The request was refused as sent: a required field is missing, a value has the wrong type or fails validation. The body says what - often as plain text. |
| 401 | Unauthorized | No token, or one that is invalid or signed out. Without ?ionic=true, some endpoints answer this with the HTML login page instead of JSON. |
| 402 | Payment Required | The content needs a subscription: the user has no price plan that unlocks it. |
| 403 | Forbidden | The token is valid but may not do this - the record belongs to someone else, or the user is not an admin. AI builder endpoints also answer 403 when the account is out of credits. |
| 404 | Not Found | No object with that ID or URL slug, or no such endpoint. |
| 409 | Conflict | It clashes with the current state: the item is already being processed, a version is already applied, or an AI plan or preview is no longer available. |
| 410 | Gone | It existed but is no longer there - for example a comment already deleted on the social network. |
| 412 | Precondition Failed | A rule the request must meet is not met - for example push notifications of the same type at least 48 hours apart. |
| 418 | I'm a teapot | An account confirmation or password reset link was used with an email that does not match it. |
| 421 | Misdirected Request | The domain is not a Builderly site. Call the site's own address. |
| 422 | Unprocessable Content | The request was understood but could not be done - for example the AI could not read the website it was asked to clone. The message says what to try instead. |
| 429 | Too Many Requests | Slow down: the site's request limit was reached, an AI chat already has a request running, or the hourly limit of AI search answers is used up. Wait and retry. |
| 500 | Internal Server Error | Something failed on the server. Retrying later may work; if it keeps failing, the request may be one the endpoint does not handle. |
| 502 | Bad Gateway | A service the request depends on failed - for example the address a redirect forwards to. |
| 503 | Service Unavailable | Used by the lead form when an order is below its minimum value, not only for outages: read the message. |

Errors do not share one shape: depending on the endpoint the body is plain text, { "error": "..." }, { "message": "..." } or empty. Rely on the status code, and show the body to the user as the reason.

## Endpoints

### Invoices

Invoices and price quotes the site issues for orders and subscriptions, generated from the invoice settings (business details, taxes, numbering).

#### Invoice

##### Retrieve the can alter invoice sequence
`GET /can_alter_invoice_sequence`
Return boolean if invoice sequence can be alteerd.
- Access: Admin token
- Status codes: 200, 401, 500
- Models: Invoice, PriceQuote

##### Retrieve a download invoice
`GET /download-invoice/:id/:translate/:filename`
Download invoice.
- Access: Public
- Path:
  - `id` (string): The ID of the download invoice.
  - `translate` (string): The download invoice's translate.
  - `filename` (string): The download invoice's filename.
- Status codes: 200, 400, 500

##### Delete an invoice
`DELETE /invoices/:id`
Delete Invoicerecord by id.
- Access: Admin token
- Path:
  - `id` (string): The ID of the invoice.
- Returns: an empty answer on success.
- Status codes: 200, 400, 401, 404, 500
- Models: Invoice, PriceQuote

#### Invoice Settings

##### List all invoice settings
`GET /invoice-settings`
Returns the site's invoice settings, newest first unless a sort is given.
- Access: Admin token
- Returns: a list of InvoiceSettings objects.
- Status codes: 200, 401, 500
- Models: InvoiceSettings

##### Create an invoice setting
`POST /invoice-settings`
Create new Invoice Settings.
- Access: Admin token
- Returns: the InvoiceSettings object.
- Status codes: 201, 400, 401, 500
- Models: InvoiceSettings

##### Retrieve an invoice setting
`GET /invoice-settings/:id`
Returns one invoice setting, found by its ID.
- Access: Admin token
- Path:
  - `id` (string): The ID of the invoice setting.
- Returns: the InvoiceSettings object.
- Status codes: 200, 401, 404, 500
- Models: InvoiceSettings

##### Update an invoice setting
`PATCH /invoice-settings/:id`
Update InvoiceSettings by id.
- Access: Admin token
- Path:
  - `id` (string): The ID of the invoice setting.
- Returns: the InvoiceSettings object.
- Status codes: 200, 400, 401, 404, 500
- Models: Invoice, InvoiceSettings

#### Nra Audit

##### Retrieve the NRA audit file
`GET /nra-audit-file`
The audit file itself, as a windows-1251 XML attachment.
- Access: Admin token
- Query:
  - `month` (string): Only NRA audit files with this month.
  - `year` (string): Only NRA audit files with this year.
- Status codes: 200, 400, 401, 500

##### Retrieve the NRA audit summary
`GET /nra-audit-summary`
Dry run - what the file would contain, without producing it.
- Access: Admin token
- Query:
  - `month` (string): Only NRA audit summaries with this month.
  - `year` (string): Only NRA audit summaries with this year.
- Status codes: 200, 400, 401, 500

##### List all NRA settings
`GET /nra-settings`
Current NRA audit-file settings, with the default payment map.
- Access: Admin token
- Status codes: 200, 401, 500

##### Create a NRA setting
`POST /nra-settings`
Create or update the tenant's NRA audit-file settings.
- Access: Admin token
- Status codes: 200, 400, 401, 500

#### Recurring Invoice

##### List all recurring invoices
`GET /recurring-invoices`
All recurring invoices, the next due first.
- Access: Admin token
- Returns: a list of RecurringInvoice objects.
- Status codes: 200, 401, 500
- Models: RecurringInvoice

##### Create a recurring invoice
`POST /recurring-invoices`
Creates a recurring invoice from the fields sent. POST /recurring-invoices - create; its first run is the start date (or the next one after now).
- Access: Admin token
- Returns: the RecurringInvoice object.
- Status codes: 201, 400, 401, 500
- Models: RecurringInvoice

##### Retrieve a recurring invoice
`GET /recurring-invoices/:id`
Returns one recurring invoice, found by its ID. GET /recurring-invoices/:id
- Access: Admin token
- Path:
  - `id` (string): The ID of the recurring invoice.
- Returns: the RecurringInvoice object.
- Status codes: 200, 401, 404, 500
- Models: RecurringInvoice

##### Update a recurring invoice
`PATCH /recurring-invoices/:id`
Changes the fields sent; the others stay as they are. PATCH /recurring-invoices/:id - a schedule change (or switching it on) reschedules it.
- Access: Admin token
- Path:
  - `id` (string): The ID of the recurring invoice.
- Returns: the RecurringInvoice object.
- Status codes: 200, 400, 401, 404, 500
- Models: RecurringInvoice

##### Delete a recurring invoice
`DELETE /recurring-invoices/:id`
Deletes the recurring invoice. This cannot be undone. DELETE /recurring-invoices/:id - the quotes and invoices it already made stay.
- Access: Admin token
- Path:
  - `id` (string): The ID of the recurring invoice.
- Returns: an empty answer on success.
- Status codes: 200, 401, 404, 500
- Models: RecurringInvoice

##### Create a recurring invoice
`POST /recurring-invoices/:id/run`
Creates a recurring invoice from the fields sent. auto_send), outside the schedule, which it leaves as it is.
- Access: Admin token
- Path:
  - `id` (string): The ID of the recurring invoice.
- Returns: the RecurringInvoice object.
- Status codes: 201, 400, 401, 404, 500
- Models: RecurringInvoice

#### AI builder

##### Modify an invoice setting with AI
`POST /modify-invoice-settings`
Use it to set up or update invoice document settings: legal business name, iban/swift for invoice PDFs, vat/tax ID, home/foreign tax rates, or invoice template field translations.
- Access: User token
- Body:
  - `prompt` (string): What the AI should do with the invoice setting, in plain words - any language.
  - `chatId` (string): The AI chat this request belongs to; its history and language carry over. Leave it out to start a new chat.
- Status codes: 200, 401, 500

##### Update an invoice setting with AI
`POST /update-invoice-settings-ai`
Update an invoice setting from a prompt, written by the AI builder.
- Access: User token
- Body:
  - `prompt` (string): What the AI should do with the invoice setting, in plain words - any language.
  - `chatId` (string): The AI chat this request belongs to; its history and language carry over. Leave it out to start a new chat.
  - `aiVersion` (string): Which version of the AI builder to use; leave it out for the current one.
  - `item_id` (string): The ID of the invoice setting to change.
- Status codes: 200, 401, 500
- Models: ChatMessage

## Objects

### ChatMessage

- `chat_id`: ObjectId, required, → ChatHistory
- `role`: String, one of user | model
- `text`: String
- `target_url`: String
- `action`: String, one of RESPONSE | REDIRECT | OBJECT_RESPONSE | ERROR | CLARIFY | PROPOSED_ACTION
- `options`: String[]
- `data.object`: Mixed
- `data.object_type`: String
- `data.edit_summary`: Mixed
- `data.edit_diff`: Mixed
- `data.undo_record`: Mixed
- `data.hero_animation_offer`: Mixed
- `data.preview_state`: String
- `data.pending_credit_cost`: Number
- `data.target_restore`: Mixed
- `data.media_request`: Mixed
- `data.item_request`: Mixed
- `data.reference_request`: Mixed
- `data.section_options`: Mixed
- `data.section_blueprint`: Mixed
- `data.section_style_options`: Mixed
- `data.section_style_blueprint`: Mixed
- `data.section_role_picker`: Mixed
- `data.small_section_regeneration_options`: Mixed
- `data.small_section_regeneration_target`: Mixed
- `data.small_section_regeneration_prompt`: String
- `data.selected_small_section_action`: Mixed
- `data.component_regeneration_input`: Mixed
- `data.selected_section_role`: Mixed
- `data.selected_section_option`: Mixed
- `data.selected_section_style`: Mixed
- `data.section_options_target`: Mixed
- `data.section_options_prompt`: String
- `data.style_options_target`: Mixed
- `data.style_options_prompt`: String
- `data.previous_container`: Mixed
- `data.preserved_custom_components`: Mixed[]
- `data.selection_request`: Mixed
- `data.proposed_action`: Mixed
- `data.plan_result`: Mixed
- `data.parsed_intent`: Mixed
- `data.parsed_intent_version`: Number
- `data.parsed_intent_at`: Date
- `data.item_id`: ObjectId
- `data.design_archetype`: String
- `data.design_palette`: Mixed
- `data.out_of_credits`: Boolean
- `data.site_wide_edit`: Mixed
- `data.redesign`: Mixed
- `medias`: Object[]
  - `media`: ObjectId, → Media
  - `gcs_url`: String
  - `gemini_uri`: String
  - `gemini_interaction_id`: String
  - `_id`: ObjectId
- `products`: ObjectId[], → Product
- `services`: ObjectId[], → Service
- `blogposts`: ObjectId[], → BlogPost
- `programs`: ObjectId[], → Program
- `suggestions`: Object[]
  - `text`: String
  - `route`: String
  - `item_id`: ObjectId
  - `medias`: Mixed[]
  - `picture`: ObjectId
  - `_id`: ObjectId
- `is_system`: Boolean, default false
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date

### Invoice

- `stripeNumber`: String
- `is_credit_note`: Boolean, default false
- `credit_note_invoice_number`: String
- `credit_note_invoice_date`: String
- `is_debit_note`: Boolean, default false
- `debit_note_invoice_number`: String
- `debit_note_invoice_date`: String
- `number`: Number
- `stripeInvoiceId`: String
- `has_price_quote`: Boolean, default false
- `customer_name`: String
- `customer_address`: String
- `customer_postal_code`: String
- `customer_city`: String
- `customer_country`: String
- `customer_phone`: String
- `customer_email`: String
- `customer_tax_id`: String
- `customer_vat_id`: String
- `customer_responsible_official`: String
- `customer_organization_name`: String
- `billing_customer_address`: String
- `billing_customer_postal_code`: String
- `billing_customer_city`: String
- `billing_customer_country`: String
- `billing_customer_phone`: String
- `subtotal`: Number
- `amount`: Number
- `day_of_issue`: String
- `paid_on`: String
- `foreign`: Boolean
- `home_tax`: Number, default 0
- `foreign_tax`: Number, default 0
- `items`: Object[]
  - `id`: String
  - `name`: String
  - `qty`: Number
  - `unit_price`: Number
  - `discount`: Number
  - `amount`: Number
  - `_id`: ObjectId
- `grounds_for_transaction`: String
- `description_of_transaction`: String
- `place_of_transaction`: String
- `payment`: String
- `dateDue`: String
- `invoice_settings.number`: Number
- `invoice_settings.price_quote_number`: String
- `invoice_settings.bic`: String
- `invoice_settings.swift`: String
- `invoice_settings.tax_id`: String
- `invoice_settings.vat_id`: String
- `invoice_settings.logo`: ObjectId
- `invoice_settings.business_name`: String
- `invoice_settings.business_name_translated`: String
- `invoice_settings.responsible_official`: String
- `invoice_settings.responsible_official_translated`: String
- `invoice_settings.business_email`: String
- `invoice_settings.company_id`: String
- `invoice_settings.business_address`: String
- `invoice_settings.business_address_translated`: String
- `invoice_settings.business_phone_number`: String
- `invoice_settings.business_country`: String
- `invoice_settings.business_country_translated`: String
- `invoice_settings.footer`: String
- `invoice_settings.footer_translated`: String
- `invoice_settings.foreign_tax`: Number, default 0
- `invoice_settings.home_tax`: Number, default 0
- `invoice_settings.currency_symbol`: String
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date

### InvoiceSettings

- `number`: Number
- `price_quote_number`: String
- `bic`: String
- `swift`: String
- `tax_id`: String
- `vat_id`: String
- `logo`: ObjectId
- `business_name`: String
- `business_name_translated`: String
- `responsible_official`: String
- `responsible_official_translated`: String
- `business_email`: String
- `company_id`: String
- `business_address`: String
- `business_address_translated`: String
- `business_phone_number`: String
- `business_country`: String
- `business_country_translated`: String
- `footer`: String
- `footer_translated`: String
- `foreign_tax`: Number, default 0
- `home_tax`: Number, default 0
- `currency_symbol`: String
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date

### PriceQuote

- `customer_name`: String
- `customer_address`: String
- `customer_postal_code`: String
- `customer_city`: String
- `customer_country`: String
- `customer_phone`: String
- `customer_email`: String
- `customer_tax_id`: String, required
- `customer_vat_id`: String
- `customer_responsible_official`: String, required
- `customer_organization_name`: String
- `billing_customer_address`: String
- `billing_customer_postal_code`: String
- `billing_customer_city`: String
- `billing_customer_country`: String
- `billing_customer_phone`: String
- `subtotal`: Number
- `amount`: Number
- `day_of_issue`: String
- `number`: Number
- `foreign`: Boolean
- `home_tax`: Number, default 0
- `foreign_tax`: Number, default 0
- `items`: Object[]
  - `id`: String
  - `name`: String
  - `qty`: Number
  - `unit_price`: Number
  - `discount`: Number
  - `amount`: Number
  - `_id`: ObjectId
- `grounds_for_transaction`: String
- `description_of_transaction`: String
- `place_of_transaction`: String
- `payment`: String
- `dateDue`: String
- `invoice_id`: ObjectId, → invoice
- `invoice_settings.number`: Number
- `invoice_settings.price_quote_number`: String
- `invoice_settings.bic`: String
- `invoice_settings.swift`: String
- `invoice_settings.tax_id`: String
- `invoice_settings.vat_id`: String
- `invoice_settings.logo`: ObjectId
- `invoice_settings.business_name`: String
- `invoice_settings.business_name_translated`: String
- `invoice_settings.responsible_official`: String
- `invoice_settings.responsible_official_translated`: String
- `invoice_settings.business_email`: String
- `invoice_settings.company_id`: String
- `invoice_settings.business_address`: String
- `invoice_settings.business_address_translated`: String
- `invoice_settings.business_phone_number`: String
- `invoice_settings.business_country`: String
- `invoice_settings.business_country_translated`: String
- `invoice_settings.footer`: String
- `invoice_settings.footer_translated`: String
- `invoice_settings.foreign_tax`: Number, default 0
- `invoice_settings.home_tax`: Number, default 0
- `invoice_settings.currency_symbol`: String
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date

### RecurringInvoice

- `title`: String, default ""
- `active`: Boolean, default true
- `auto_send`: Boolean, default false
- `interval_count`: Number, default 1
- `interval_unit`: String, one of day | week | month | year, default "month"
- `start_date`: Date, required
- `end_date`: Date
- `due_days`: Number, default 0
- `next_run_at`: Date
- `customer_name`: String
- `customer_address`: String
- `customer_postal_code`: String
- `customer_city`: String
- `customer_country`: String
- `customer_phone`: String
- `customer_email`: String
- `customer_tax_id`: String
- `customer_vat_id`: String
- `customer_responsible_official`: String
- `customer_organization_name`: String
- `billing_customer_address`: String
- `billing_customer_postal_code`: String
- `billing_customer_city`: String
- `billing_customer_country`: String
- `billing_customer_phone`: String
- `foreign`: Boolean, default false
- `items`: Object[]
  - `id`: String
  - `name`: String
  - `qty`: Number, default 1
  - `unit_price`: Number, default 0
  - `discount`: Number, default 0
  - `_id`: ObjectId
- `payment`: String
- `grounds_for_transaction`: String
- `description_of_transaction`: String
- `place_of_transaction`: String
- `runs`: Number, default 0
- `last_run_at`: Date
- `last_price_quote_id`: ObjectId
- `last_invoice_id`: ObjectId
- `last_error`: String
- `_id`: ObjectId
- `updatedAt`: Date
- `createdAt`: Date