Skip to content

frontline kb

Manage knowledge bases, their sources, search, and agent assignment

frontline kb [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb list

List knowledge bases for the account

frontline kb list [options]

Options

FlagDescriptionDefault
--sharedOnly shared knowledge bases
--privateOnly private knowledge bases
--search-text <text>Filter by name or description
--page <n>Page number
--page-size <n>Page size
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb create

Create a knowledge base

frontline kb create [options]

Options

FlagDescriptionDefault
--name <name>Knowledge base name
--description <description>Knowledge base description
--privateCreate as private (default: shared)
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb get

Get knowledge base details

frontline kb get [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb update

Update a knowledge base

frontline kb update [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--name <name>Knowledge base name
--description <description>Knowledge base description
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb delete

Delete a knowledge base and all of its sources

frontline kb delete [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

Semantic search over a knowledge base

frontline kb search [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--query <text>Search query
--limit <n>Max results (default 10, max 50)
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb sync-history

List crawl sync history for a website source

frontline kb sync-history [options] <knowledgeBaseId> <websiteSourceId>

Options

FlagDescriptionDefault
--sync-type <type>Filter by sync type
--status <status>Filter by status
--page <n>Page number
--page-size <n>Page size
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb assigned

List knowledge bases assigned to an agent

frontline kb assigned [options]

Options

FlagDescriptionDefault
--agent-id <agentId>Agent ID
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb assign

Set the knowledge bases assigned to an agent (replaces existing)

frontline kb assign [options]

Options

FlagDescriptionDefault
--agent-id <agentId>Agent ID
--kb-ids <json>JSON array of knowledge base IDs, e.g. [12,13]
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source

Manage knowledge base sources (URLs, website crawls)

frontline kb source [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source list

List sources in a knowledge base

frontline kb source list [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--filter-text <text>Filter by source name or URL
--status <status>Filter by status
--source-type <type>Filter by source type (FILE, URL, WEBPAGE, FOLDER)
--page <n>Page number
--page-size <n>Page size
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source get

Get a knowledge source's details

frontline kb source get [options] <knowledgeBaseId> <sourceId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source add-url

Add one or more URL sources to a knowledge base

frontline kb source add-url [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--urls <json>JSON array of URLs, e.g. ["https://a.com"]
--description <description>Description for the sources
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source add-crawl

Add a website crawl source to a knowledge base

frontline kb source add-crawl [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--url <url>Root URL to crawl
--max-links <n>Max pages to crawl (1-1000)
--max-depth <n>Max crawl depth (1-5)
--description <description>Description for the source
--include-paths <json>JSON array of path globs to include
--exclude-paths <json>JSON array of path globs to exclude
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source resync

Resync sources by IDs, or resync a website crawl with --website-id

frontline kb source resync [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--source-ids <json>JSON array of source IDs to resync
--website-id <id>Website crawl source ID to recrawl
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline kb source remove

Remove sources from a knowledge base

frontline kb source remove [options] <knowledgeBaseId>

Options

FlagDescriptionDefault
--source-ids <json>JSON array of source IDs to remove
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)