Get Started

AI-suggest which nav items to hide

POST/api/v1/businesses/nav-preferences/suggest

Given a business description and the hideable nav catalog, returns a proposed set of items to hide (with reasons) plus a one-line profile. Proposal only — nothing is saved; apply via PUT /nav-preferences.

Operation ID: suggest_nav_preferences_api_v1_businesses_nav_preferences_suggest_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: NavSuggestRequest

descriptionstringrequired

Free-text business description

itemsarray · NavCatalogItemNavCatalogItem

The hideable nav catalog (frontend-sourced)

4 fields
idstringrequired

Stable hideable id, e.g. 'workspace:inventory'

labelstring

Human label

descriptionstring

What lives here

feature_tagsarray · string

Capability tags that help the model match

signalsobject

Optional account-derived hints, e.g. {'has_inventory': 'true'}

Responses

201Successful Response

Schema: SuccessEnvelope_NavSuggestResponse_

successboolean
messagestring
codestring
dataNavSuggestResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

500Internal Server Error