Ai Assistant Personalities

An AI Assistant Personality defines a system prompt used to customize the in-app AI Assistant.

List Ai Assistant Personalities

Command

files-cli ai-assistant-personalities list

Output

Outputs a list of AiAssistantPersonality objects according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

files-cli ai-assistant-personalities list

Show Ai Assistant Personality

Command

files-cli ai-assistant-personalities find

Output

Outputs a AiAssistantPersonality object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Ai Assistant Personality ID.

Example Request

files-cli ai-assistant-personalities find \
  --id=1

Create Ai Assistant Personality

Command

files-cli ai-assistant-personalities create

Output

Outputs a AiAssistantPersonality object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDefaultDescription
--apply-to-all-workspaces
boolean		falseIf true, this default-workspace personality can apply to users in all workspaces.
--name=
string
Required		AI Assistant Personality name.
--system-prompt=
string
Required		System prompt injected into the in-app AI Assistant.
--use-by-default
boolean		falseWhether this personality is the default personality for the Workspace.
--workspace-id=
int64		0Workspace ID. 0 means the default workspace.

Example Request

files-cli ai-assistant-personalities create \
  --name="Concise Assistant" \
  --system-prompt="Respond as a concise operations assistant."

Update Ai Assistant Personality

Command

files-cli ai-assistant-personalities update

Output

Outputs a AiAssistantPersonality object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Ai Assistant Personality ID.
--apply-to-all-workspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
--name=
string		AI Assistant Personality name.
--system-prompt=
string		System prompt injected into the in-app AI Assistant.
--use-by-default
boolean		Whether this personality is the default personality for the Workspace.
--workspace-id=
int64		Workspace ID. 0 means the default workspace.

Example Request

files-cli ai-assistant-personalities update \
  --id=1

Delete Ai Assistant Personality

Command

files-cli ai-assistant-personalities delete

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required		Ai Assistant Personality ID.

Example Request

files-cli ai-assistant-personalities delete \
  --id=1

The AiAssistantPersonality Object

Some of the commands above return a AiAssistantPersonality object. The attributes of this object are listed below.

AttributeDescription
id
int64		AI Assistant Personality ID.
workspace_id
int64		Workspace ID. 0 means the default workspace.
name
string		AI Assistant Personality name.
system_prompt
string		System prompt injected into the in-app AI Assistant.
use_by_default
boolean		Whether this personality is the default personality for the Workspace.
apply_to_all_workspaces
boolean		If true, this default-workspace personality can apply to users in all workspaces.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.