> For the complete documentation index, see [llms.txt](https://docs.codatum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codatum.com/ai-assist/ai-profile.md).

# AI Profile

## Overview

An AI Profile combines the AI model, context, tool permissions, and other settings used by Codatum Agent. Create profiles for different purposes and select the appropriate profile from the Agent screen.

## Types

### Managed AI Profile

Uses an AI model managed by Codatum. No API key is required. You can select the model tier to use.

The AI provider and endpoint cannot be specified. Use a Custom AI Profile if your security requirements require a particular provider or credential.

### Custom AI Profile

Uses a BYOAI (Bring Your Own AI) model with an API key or service account provided by your organization. You can configure the AI provider, model, reasoning effort, and related connection settings.

When using Google Vertex AI, grant the `Vertex AI User` role to the service account. Registered secrets are stored encrypted.

{% hint style="info" %}
Custom AI Profile is a paid option. For details, contact us via chat or at `support@codatum.com`.
{% endhint %}

## Configuration

Go to `Workspace Settings` > `Options` > `AI Profile`, select `Create AI Profile`, and create a Managed AI Profile or Custom AI Profile.

Available settings depend on the profile type and your plan.

## Context

An AI Profile can include the following context:

* **Plain text**
  * Add assumptions, terminology, and interpretation guidelines.
* **Notebook**
  * Load the content of a selected Notebook.
* **Folder**
  * Load all Notebooks in the selected folder and its subfolders.

Notebooks and folders are loaded only when the user running the Agent can view them. A user cannot use an AI Profile if it contains a Notebook that the user cannot access.

{% hint style="warning" %}
Notebooks and folders configured in an AI Profile are not loaded for Guest Report Agents or Workflow executions. Plain text is applied to Guest Report Agents but is not used in Workflow executions.
{% endhint %}

If the Agent does not need to load every document in a folder, configure only an index Notebook and allow the Agent to search for the information it needs. See [Agent Context](/ai-assist/agent-context.md) for the recommended structure.

## Tool permissions

Configure the information and tools that Codatum Agent can use for each AI Profile.

### Notebook access

* `All accessible notebooks`
* `Current notebook only`

### Connection access

* `All accessible connections`
* `Allow only selected`
* `Deny selected`

### Web search and web fetch

Configure web search and web fetch separately:

* `Off`
* `Allow specific domains`
* `On`

When allowing specific domains, enter domains in the form `example.com` or `*.example.com`.

### Agent Connectors

* `Off`
* `Allow only selected connectors`
* `All connectors`

See [Agent Connectors](/ai-assist/agent-connector.md) for connector configuration.

{% hint style="info" %}
AI Profile permissions do not extend the user's own access. The Agent can only use resources and tools allowed by both the user's permissions and the AI Profile.
{% endhint %}

## Sharing

Configure who can use and manage an AI Profile for all workspace members, a group, or an individual user.

* `Owner`
  * Can modify the AI Profile.
* `User`
  * Can use the AI Profile in Codatum Agent.

Workspace owners are always owners of every AI Profile.

## Conversation logs

When `Save conversation message content to logs` is enabled, workspace administrators can view user and assistant messages for Agent sessions that use the AI Profile under `Agent Usage`.

This setting does not share conversation message content with Codatum developers. See [Data handling in Codatum Agent](/ai-assist/ai-agent.md) for the information recorded by Codatum developers for service quality improvement.

## Custom behavior and start screen

Depending on your plan, you can configure Agent behavior and the chat start screen for each AI Profile.

* **Custom behavior**
  * Add instructions for how the Agent should ask questions, explain results, and perform analyses.
* **Default behavior**
  * Disable default instructions that should not apply to the AI Profile.
* **Start screen**
  * Configure a welcome title, description, and suggested prompts.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.codatum.com/ai-assist/ai-profile.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.