> ## Documentation Index > Fetch the complete documentation index at: https://agentheya.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # public_details > Everything shown on your agent's standalone public chat page — business name, support email, power-user instructions, theme, brand palette, and the page… # `public_details` — Public details & branding Everything shown on your agent's standalone public chat page — business name, support email, power-user instructions, theme, brand palette, and the **page layout** (the UI blocks rendered around the chat panel). **Section key** `public_details` · **Shape** object · **Tier** All plans\ **Edit in the dashboard:** [Public Details page](/sidebar-menu/details)\ **Related:** [Page layout block types](/sections/page-layout) ## Fields | Field | Required | Type | Allowed values / constraints | Default | Description | | ----------------------- | -------- | --------------- | --------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `agent_name` | no | string | — | — | The agent's unique name (read-only from this section — renaming is done via the details save action which writes here after updating the database). | | `description` | no | string | max len 200000 | — | Short internal description of this agent (not shown to power-users). | | `business_name` | no | string | — | — | The name of the business or product this agent represents. Shown in legal documents and the public chat page footer copyright (e.g. "© 2026 Acme Ltd"). NOT the header title — that is `display_name`. | | `display_name` | no | string | max len 80 | — | Human-friendly title shown at the top of the public chat page header (the per-instance flavour name the power-user assigns). Free text with spaces and capitalization. When blank, the header falls back to the instance's link slug (`instance_slug`), then the raw instance id. | | `support_email` | no | string | pattern `^(?:[^\s@]+@[^\s@]+\.[^\s@]+)?$` | — | Email address for users to contact for support. Shown in legal docs. May be left blank. | | `instructions` | no | string | — | — | Additional instructions or notes shown on the agent's public chat page (e.g. usage tips for power-users). | | `theme_id` | no | enum | one of `default`, `minimal`, `bold`, `classic`, `vibrant` | — | Owner-selected visual theme applied to the agent's public Description / Instructions rendering. Picking one applies the corresponding built-in theme to the agent. Defaults to 'default' when unset. | | `response_format` | no | enum | one of `auto`, `rich`, `minimal`, `text_only` | `auto` | How richly the agent should present chat responses. 'auto' = platform default (model decides per the \ heuristic). 'rich' = prefer json-render specs (cards/tables/stats) whenever a structured display is plausibly clearer. 'minimal' = plain markdown, render only genuinely tabular data. 'text\_only' = never emit renders/artifacts. Compiled into a \ block in the agent's system prompt. | | `presentation_notes` | no | string | max len 2000 | — | Free-text nuance for response presentation (e.g. 'always summarise metrics as KPI stats'), appended to the \ system-prompt block. Optional escape hatch beyond the response\_format preset. | | `palette` | no | object | — | — | Owner brand colours for the chat render nodes (badge/alert/stat/…). Each role carries a light and dark hex value; they become `--jr-*` CSS variables injected on a `.jr-themed` wrapper around the render surfaces. Empty/unset roles fall back to the platform defaults in main.css. Never reaches the LLM — the model emits semantic variants and the theme resolves the colour. Item fields below. | | `description_rendered` | no | string | — | — | Server-rewritten copy of `description` with widget-action buttons replaced by opaque action\_ids. Written automatically by the details save action via extractWidgetActionsFromText. The power-user public surface renders this field, not `description`; the owner-edit textarea still binds to `description`. | | `instructions_rendered` | no | string | — | — | Server-rewritten copy of `instructions` with widget-action buttons replaced by opaque action\_ids. Same rationale as description\_rendered. | | `page_layout` | no | array of object | — | `[]` | Ordered list of UI blocks rendered on the public chat page (separate from the embeddable widget). Each block has a stable `id`, a `position` ('above\_chat' \| 'below\_chat' \| 'sidebar'), and a `type`. Supported types: 'markdown' (body), 'links' (heading + items\[\{label,url,icon?}]), 'hero' (headline + subtitle? + image\_url? + image\_href? \[makes the image clickable] + cta\_label? + cta\_url?), 'json\_render' (spec — same shape as $lib/json-render RenderSpec emitted at runtime; optional `data_source` binds the block to a live browser-side tool/code fetch that populates the spec's state — see the json_render block docs), 'input_capture' (heading? + intro? + fields[{name,label,type,required?,options?,placeholder?}] + submit_label? + success_message? + behavior:'send_as_message'\|'append_to_input'), 'suggested_prompts' (heading? + prompts[{label,message,icon?}] + behavior?), 'faq' (heading? + qa[{question,answer}]), 'notice' (tone:'info'\|'success'\|'warning'\|'error' + title? + body + dismissible?), 'file_gallery' (heading? + columns? + files[{file_name,label?,description?,thumbnail_url?}] — clickable tiles for the agent's PUBLIC documents; a tile opens the document in an on-page popup, PDFs/images inline), 'embed' (url + height_px?), 'divider'. Order within a position is the array order. The 'above_chat' and 'below_chat' regions are a full-width 12-column grid (with a small side inset): each block may set `col_span` (1–12, default 12 = full row) and `align` ('left'\|'center'\|'right') to control its width and placement, so blocks can sit side by side (e.g. two at col_span 6) or a narrow block can be centered/right-aligned across the page width; they stack on narrow screens. Empty array = no extra blocks; the chat panel renders standalone. Displayed text fields (hero headline/subtitle, headings, FAQ questions+answers, notice title/body, input_capture intro, markdown bodies) may contain simple owner links written as <a href="https://…">text</a> — rendered as real links only when the href is http(s)/site-relative/mailto/tel (see $lib/shared/safe-links.ts); any other markup stays inert text. See [page\_layout block types](/sections/page-layout) for the full sub-schema. | | `page_images` | no | array of object | max 20 items | `[]` | Freely-positioned decorative images overlaid on the public web chat page (never intercept clicks). Each image stacks by its numeric `z` against the page tiers — layout blocks paint at z 20, the chat window at z 40 — so an image can sit behind everything (z\<0), between the blocks and the chat (e.g. 30), or float over both (e.g. 50); dialogs/menus always stay above. Among images with equal z, array order wins (later = on top). Coordinates/sizes are percentages of the viewport (x/width of its width, y/height of its height) so a design scales to any screen. mode:'cover' makes the image a classic full-bleed wallpaper (ignores the position/size fields). Source is either an external URL (`src`) or an owner-uploaded file (`file`, max 5 MB, common image formats incl. SVG) served from /agent/\{agent\_name}/page-image/\{file}. Edited on the dashboard Web page ('Page images' card); shape is normalized by \$lib/shared/page-images.ts. Item fields below. | ### `palette` fields Owner brand colours for the chat render nodes (badge/alert/stat/…). Each role carries a light and dark hex value; they become `--jr-*` CSS variables injected on a `.jr-themed` wrapper around the render surfaces. Empty/unset roles fall back to the platform defaults in main.css. Never reaches the LLM — the model emits semantic variants and the theme resolves the colour. | Field | Required | Type | Allowed values / constraints | Default | Description | | --------- | -------- | ------ | ---------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accent` | no | object | — | — | A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. Item fields below. | | `success` | no | object | — | — | A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. Item fields below. | | `warning` | no | object | — | — | A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. Item fields below. | | `danger` | no | object | — | — | A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. Item fields below. | | `info` | no | object | — | — | A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. Item fields below. | ### `page_images` items Freely-positioned decorative images overlaid on the public web chat page (never intercept clicks). Each image stacks by its numeric `z` against the page tiers — layout blocks paint at z 20, the chat window at z 40 — so an image can sit behind everything (z\<0), between the blocks and the chat (e.g. 30), or float over both (e.g. 50); dialogs/menus always stay above. Among images with equal z, array order wins (later = on top). Coordinates/sizes are percentages of the viewport (x/width of its width, y/height of its height) so a design scales to any screen. mode:'cover' makes the image a classic full-bleed wallpaper (ignores the position/size fields). Source is either an external URL (`src`) or an owner-uploaded file (`file`, max 5 MB, common image formats incl. SVG) served from /agent/\{agent\_name}/page-image/\{file}. Edited on the dashboard Web page ('Page images' card); shape is normalized by \$lib/shared/page-images.ts. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | | ------------ | -------- | ------ | ---------------------------------------------------------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | **yes** | string | pattern `^[A-Za-z0-9_-]+$`; min len 1; max len 40 | — | Stable unique identifier for this image, used as the reference key for delete/patch operations. Must be unique within page\_images and remain constant across edits. | | | | | `src` | no | string | pattern \`^(https?://.+ | /\[^/].\*)\$\`; max len 2048 | — | External image URL (https\://… or a site-relative /… path). Ignored when `file` is set. | | | | `file` | no | string | pattern `^[A-Za-z0-9_-][A-Za-z0-9._-]*$`; min len 1; max len 160 | — | Filename of an owner-uploaded page image (stored in the agent's page\_images file scope), served from /agent/\{agent\_name}/page-image/\{file}. Takes precedence over `src`. | | | | | `href` | no | string | pattern \`^(https?://.+ | /\[^/].\* | mailto:.+ | tel:.+)\$\`; max len 2048 | — | Optional link target — set, the image renders as a clickable anchor (its rectangle then intercepts clicks; images without a link never block the page). External links open in a new tab. | | `layer` | no | enum | one of `background`, `foreground` | `background` | LEGACY coarse depth (pre-`z` entries): background = behind the page, foreground = above it. `z` is the source of truth when present; on save this is re-derived from `z` (z >= 0 → foreground). | | | | | `z` | no | number | min -99; max 55 | — | Stacking order relative to the page tiers and the other images (higher = closer to the viewer). The page paints layout blocks at z 20 and the chat window at z 40, so e.g. -10 sits behind everything, 30 floats over the blocks but under the chat, 50 floats over both. Dialogs/menus (z 60+) always stay above images. Missing on old entries — falls back to `layer` (foreground → 50, background → -10). | | | | | `mode` | no | enum | one of `free`, `cover` | `free` | free = positioned/sized via the \*\_pct fields; cover = full-viewport wallpaper (object-fit: cover), position/size fields ignored. | | | | | `x_pct` | no | number | min -400; max 400 | — | Left edge as a percentage of the viewport width (free mode). Negative / >100 allowed for off-canvas bleed. | | | | | `y_pct` | no | number | min -400; max 400 | — | Top edge as a percentage of the viewport height (free mode). | | | | | `width_pct` | no | number | min 0.5; max 400 | — | Width as a percentage of the viewport width (free mode). | | | | | `height_pct` | no | number | min 0; max 400 | — | Height as a percentage of the viewport height (free mode). 0 = auto: the image keeps its intrinsic aspect ratio. | | | | | `fit` | no | enum | one of `fill`, `contain`, `cover` | `fill` | object-fit used when an explicit height is set (ignored while height is auto). | | | | | `opacity` | no | number | min 0; max 100 | `100` | Opacity percentage, 0–100. | | | | | `rotate_deg` | no | number | min -360; max 360 | `0` | Rotation in degrees (free mode). | | | | | `alt` | no | string | max len 200 | — | Accessible description of the image; leave empty for purely decorative images. | | | | ### `palette.accent` fields A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | ------- | -------- | ------ | --------------------------------- | --------------- | ---------------------- | - | - | | `light` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | | `dark` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | ### `palette.success` fields A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | ------- | -------- | ------ | --------------------------------- | --------------- | ---------------------- | - | - | | `light` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | | `dark` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | ### `palette.warning` fields A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | ------- | -------- | ------ | --------------------------------- | --------------- | ---------------------- | - | - | | `light` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | | `dark` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | ### `palette.danger` fields A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | ------- | -------- | ------ | --------------------------------- | --------------- | ---------------------- | - | - | | `light` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | | `dark` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | ### `palette.info` fields A semantic colour with separate light- and dark-mode hex values. Either may be omitted (or left empty) to fall back to the platform default. | Field | Required | Type | Allowed values / constraints | Default | Description | | | | ------- | -------- | ------ | --------------------------------- | --------------- | ---------------------- | - | - | | `light` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | | | `dark` | no | string | pattern \`^(#(?:\[0-9a-fA-F]{3,4} | \[0-9a-fA-F]{6} | \[0-9a-fA-F]{8}))?\$\` | — | |