Ai Assistant Personalities

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

List Ai Assistant Personalities

Endpoint

GET/ai_assistant_personalities

Return Object

AiAssistantPersonality[]

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

curl https://app.files.com/api/rest/v1/ai_assistant_personalities.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "workspace_id": 1,
    "name": "Concise Assistant",
    "system_prompt": "Respond as a concise operations assistant.",
    "use_by_default": false,
    "apply_to_all_workspaces": false,
    "created_at": "2000-01-01T01:00:00Z",
    "updated_at": "2000-01-01T01:00:00Z"
  }
]

Show Ai Assistant Personality

Endpoint

GET/ai_assistant_personalities/{id}

Return Object

AiAssistantPersonality

Authorization Requirement

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

Request Parameters

ParameterDescription
id
int64
Required		Ai Assistant Personality ID.

Example Request

curl https://app.files.com/api/rest/v1/ai_assistant_personalities/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "name": "Concise Assistant",
  "system_prompt": "Respond as a concise operations assistant.",
  "use_by_default": false,
  "apply_to_all_workspaces": false,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Create Ai Assistant Personality

Endpoint

POST/ai_assistant_personalities

Return Object

AiAssistantPersonality

Authorization Requirement

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

Request Parameters

ParameterDefaultDescription
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

curl https://app.files.com/api/rest/v1/ai_assistant_personalities.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"apply_to_all_workspaces":false,"name":"Concise Assistant","system_prompt":"Respond as a concise operations assistant.","use_by_default":false,"workspace_id":0}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "name": "Concise Assistant",
  "system_prompt": "Respond as a concise operations assistant.",
  "use_by_default": false,
  "apply_to_all_workspaces": false,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Update Ai Assistant Personality

Endpoint

PATCH/ai_assistant_personalities/{id}

Return Object

AiAssistantPersonality

Authorization Requirement

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

Request Parameters

ParameterDescription
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

curl https://app.files.com/api/rest/v1/ai_assistant_personalities/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"apply_to_all_workspaces":false,"name":"Concise Assistant","system_prompt":"Respond as a concise operations assistant.","use_by_default":false,"workspace_id":0}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "workspace_id": 1,
  "name": "Concise Assistant",
  "system_prompt": "Respond as a concise operations assistant.",
  "use_by_default": false,
  "apply_to_all_workspaces": false,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}

Delete Ai Assistant Personality

Endpoint

DELETE/ai_assistant_personalities/{id}

Return Object

No return value.

Authorization Requirement

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

Request Parameters

ParameterDescription
id
int64
Required		Ai Assistant Personality ID.

Example Request

curl https://app.files.com/api/rest/v1/ai_assistant_personalities/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The AiAssistantPersonality Object

Some of the endpoints 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.

Example AiAssistantPersonality Object

{
  "id": 1,
  "workspace_id": 1,
  "name": "Concise Assistant",
  "system_prompt": "Respond as a concise operations assistant.",
  "use_by_default": false,
  "apply_to_all_workspaces": false,
  "created_at": "2000-01-01T01:00:00Z",
  "updated_at": "2000-01-01T01:00:00Z"
}