Skip to main content

Interface: InstallOptions

Defined in: prompt-api/src/index.ts:40

Extends​

Properties​

app?​

optional app?: string

Defined in: client/dist/index.d.ts:962

Name shown to the visitor in the approval window.

Inherited from​

PromptAPIOptions.app

id?​

optional id?: string

Defined in: client/dist/index.d.ts:1107

Provider id, default bridge.

Inherited from​

PromptAPIOptions.id

maxSteps?​

optional maxSteps?: number

Defined in: prompt-api/src/language-model.ts:96

Most tool calls per prompt. Default 20.

Inherited from​

PromptAPIOptions.maxSteps

needs?​

optional needs?: SiteNeeds

Defined in: client/dist/index.d.ts:964

What the site's features need: Leuria recommends an AI and model that fit.

Inherited from​

PromptAPIOptions.needs

provider?​

optional provider?: Provider

Defined in: prompt-api/src/language-model.ts:92

The AI behind LanguageModel. Default: leuria() with these options.

Inherited from​

PromptAPIOptions.provider

retries?​

optional retries?: number

Defined in: prompt-api/src/language-model.ts:98

How many times an answer that misses the responseConstraint goes back to the AI. Default 2.

Inherited from​

PromptAPIOptions.retries

skills?​

optional skills?: string[]

Defined in: client/dist/index.d.ts:972

Skills that guide the visitor's AI on this site, in the npx skills syntax: owner/repo, owner/repo@skill, owner/repo/path#commit, a GitHub URL, or a path on this site (/ for its .well-known/agent-skills). Leuria fetches them, shows them to the visitor, and gives them to the AI in this site's conversations only.

Inherited from​

PromptAPIOptions.skills

storage?​

optional storage?: Pick<Storage, "getItem" | "setItem" | "removeItem">

Defined in: client/dist/index.d.ts:974

Where the site's token is kept. Default: localStorage, else memory.

Inherited from​

PromptAPIOptions.storage

system?​

optional system?: string

Defined in: prompt-api/src/language-model.ts:94

Instructions for the AI when the page gives no system prompt.

Inherited from​

PromptAPIOptions.system

url?​

optional url?: string

Defined in: client/dist/index.d.ts:960

Engine URL. Default DEFAULT_URL.

Inherited from​

PromptAPIOptions.url

when?​

optional when?: "unavailable" | "missing" | "always"

Defined in: prompt-api/src/index.ts:49

When Leuria provides LanguageModel:

  • "unavailable" (default): where the browser has none, or has one that can't run on this device. The browser's own model is used wherever it can run, even if it must download first.
  • "missing": only where the browser has none.
  • "always": always, in place of the browser's.