Manage knowledge bases, their sources, search, and agent assignment
frontline kb [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List knowledge bases for the account
frontline kb list [options]Options
| Flag | Description | Default |
|---|---|---|
--shared | Only shared knowledge bases | |
--private | Only 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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Create a knowledge base
frontline kb create [options]Options
| Flag | Description | Default |
|---|---|---|
--name <name> | Knowledge base name | |
--description <description> | Knowledge base description | |
--private | Create 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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get knowledge base details
frontline kb get [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Update a knowledge base
frontline kb update [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Delete a knowledge base and all of its sources
frontline kb delete [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Semantic search over a knowledge base
frontline kb search [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List crawl sync history for a website source
frontline kb sync-history [options] <knowledgeBaseId> <websiteSourceId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List knowledge bases assigned to an agent
frontline kb assigned [options]Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Set the knowledge bases assigned to an agent (replaces existing)
frontline kb assign [options]Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Manage knowledge base sources (URLs, website crawls)
frontline kb source [options] [command]Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
List sources in a knowledge base
frontline kb source list [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Get a knowledge source's details
frontline kb source get [options] <knowledgeBaseId> <sourceId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Add one or more URL sources to a knowledge base
frontline kb source add-url [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Add a website crawl source to a knowledge base
frontline kb source add-crawl [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Resync sources by IDs, or resync a website crawl with --website-id
frontline kb source resync [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |
Remove sources from a knowledge base
frontline kb source remove [options] <knowledgeBaseId>Options
| Flag | Description | Default |
|---|---|---|
--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) | |
--debug | Show debug info on stderr (token is redacted) | |
--pretty | Pretty-print human-readable output (instead of default JSON) | |
--table | Render list results as a table (implies --pretty) | |
--json | Output raw JSON (default behavior — accepted as a no-op) |