SiteAgent

typesince 0.2.7not for built apps

Type: a registered agent persona on a built app, as returned by the site-agent endpoints.

import type { SiteAgent } from 'flowstack-sdk'

The read shape of a persona. Its write counterpart is SiteAgentInput, which additionally carries system_prompt, route_when and cost_hint. Since 0.7.0 (P0-181) both carry model, the builder-pinned LLM for the app.

Signature

interface SiteAgent { name: string; description?: string; capabilities?: string[]; tools?: string[]; model?: string; updated_at?: string; usage?: string }

Returns

Field	Type	Description
`name`	`string`	Persona name — the key used by `useAgent` and by `updateSiteAgent`.
`description`	`string`	Human-readable description of the persona.
`capabilities`	`string[]`	Granted tool categories.
`tools`	`string[]`	Explicit tool-name allowlist, when narrower than `capabilities`.
`model`	`string`	Builder-pinned LLM for this app (P0-181). Absent = fall back to per-user model resolution.
`updated_at`	`string`	Last modification timestamp.
`usage`	`string`	A ready-made `useAgent(...)` snippet for the built app.

WarningNo system_prompt on this type. The prompt is write-only via SiteAgentInput — you cannot read a persona's prompt back out of listSiteAgents.

Warningmodel (0.7.0 / P0-181) overrides the end-user's own model preference for this app. Pin it only when the app genuinely depends on a specific model; otherwise leave it absent so users keep their credential-based choice.

SiteAgent

Signature

Returns

See also