> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Flow agents

> The Flow-based agent model: Persona, Voice, Knowledge, Memory, and agent management.

*Flow agents* covers the Flow-based agent model: an agent built from a Persona, a Job, and a Flow.

If you're starting a new agent today, see [Agents](https://docs.cognigy.com/ai/agents/overview) instead.

## In this section

> [card] [Persona](https://docs.cognigy.com/ai/agents/develop/persona.md)
>
> Give an agent a consistent personality, tone, and voice.

> [card] [Voice](https://docs.cognigy.com/ai/agents/develop/flow-agents/voice.md)
>
> Build a voice agent using dial logic and Voice Gateway.

> [card] [Knowledge](https://docs.cognigy.com/ai/agents/develop/flow-agents/knowledge.md)
>
> Attach a Knowledge Store when you create an agent.

> [card] [Jobs and tools](https://docs.cognigy.com/ai/agents/develop/flow-agents/configure-jobs-and-tools.md)
>
> Add jobs and tools to an agent, including handovers and MCP.

> [card] [Data privacy and security](https://docs.cognigy.com/ai/agents/develop/flow-agents/data-privacy-and-security.md)
>
> Configure Contact Profile use and safety instructions.

> [card] [Memory](https://docs.cognigy.com/ai/agents/develop/ai-agent-memory/overview)
>
> Give an agent context that persists across a conversation.

> [card] [Design-time and run-time features](https://docs.cognigy.com/ai/agents/develop/flow-agents/design-time-and-run-time-features.md)
>
> Use generative AI while building a Flow and while it runs.

## Create flow agents

You can create a flow agent from scratch and customize it to fit your business needs.

### Create from scratch

> [tab] GUI
>
> 1. In the left-side menu of the **Project** page, select **Design > Flows**. On the Flows page, open the **Flow agents** tab.
>
> 2. Click **Create flow agent**. Configure the following settings:
>
> > [accordion] 1. General settings
> >
> > 1. In the **General Settings** step, fill in the following fields:
> >    * **Name** — enter a name for your flow agent. This name will be visible to end users when the flow agent greets them in the chat or when one flow agent transfers the conversation to another flow agent. For example, `Hello, my name is Sara. How can I help you?` or `Our support specialist Alex will help with this question, transferring the conversation now`.
> >    * **Description** — enter a description of the flow agent that shapes its behavior and enhances its ability to understand the desired communication style. For example, describe the flow agent as follows: `Anna works at ACME and is highly skilled at making customers feel comfortable.`
> > 2. In the **Avatar** section, select avatar of your choice or upload your custom one by clicking **+** next to avatars.
> >    You can use any image as an avatar for your flow agent, or create a Cognigy-style avatar using the [Cognigy PSD template](https://docscognigyassets.blob.core.windows.net/assets/Template.psd). To open and customize the template, you will need Adobe Photoshop or [Paint.net](https://www.getpaint.net/) with the [PSD plugin](https://www.psdplugin.com/) installed. The requirements for the avatar are as follows:
> >    * Use an alpha channel for a transparent background.
> >    * Set the recommended width to 136px.
> >    * Set the recommended height to 184px.
> >    * Save the file as `.png`.
> >    * Include `_optimized` in the file name.
>
> > [accordion] 2. Speaking style
> >
> > 1. In the **Speaking Style** step, configure the following settings:
> >    * **Set up Style** — configure how the flow agent's choice of wording is influenced by the selected speaking style, which can affect the tone and clarity of its responses:
> >      * **Concise/Comprehensive** — adjust the slider to the left for brief responses and to the right for detailed responses.
> >      * **Formal/Informal** — adjust the slider to the left for more casual and conversational responses, and to the right for professional and structured responses.
> >    * **Voice Configuration** — assign a specific voice to your flow agent if you want to use your flow agent as a voice-based assistant. To configure this setting, ensure you have installed [Voice Gateway](https://docs.cognigy.com/voice-gateway/index) and set up the [Voice Preview](https://docs.cognigy.com/ai/agents/test/voice-preview.md) provider. Then, fill in the fields following the same process you used for [Set Session Config Node](https://docs.cognigy.com/ai/agents/develop/node-reference/voice/voice-gateway/parameter-details.md):
> >      * **TTS Vendor** — select the text-to-speech provider for your flow agent. This setting determines which service will convert the flow agent's text responses into speech.
> >      * **TTS Language** — select the language that your flow agent will use for speech output. Ensure this language aligns with the preferred language of the end user.
> >      * **TTS Voice** — select the voice from the selected TTS vendor. This setting allows you to customize the tone, gender, and style of your flow agent's voice.
> >      * **TTS Label** — select the alternative name of the TTS vendor, as specified in the [Voice Gateway Self-Service Portal](https://docs.cognigy.com/voice-gateway/webapp/applications#add-additional-tts-and-stt-vendor). If you have multiple speech services from the same vendor, use the label to specify which service to use.
> >      * **Disable TTS Audio Caching** — by default, this setting is deactivated. With caching enabled, previously requested TTS audio is stored in the flow agent cache, and repeated requests for the same audio text will use the cached result instead of sending another request. With caching disabled, the flow agent stores the TTS audio but doesn't use it; each request is sent directly to the speech provider. Note that disabling caching can increase TTS costs. For detailed information, contact your speech provider.
> >      * **Language Configuration** — by default, this setting is activated. Deactivate automatic language detection to ensure the flow agent always responds in the language defined by your instructions. This setting provides predictable and consistent responses, preventing unintended language switching when users say or type words from more than one language. When active, this setting also simplifies the system prompt, giving you clearer control over language behavior.
>
> > [accordion] 3. Instructions
> >
> > 1. In the **Instructions** step, configure the following setting:
> >    * **Instructions** — provide special instructions to your flow agent in bullet-point form. For example:
> >      ```txt theme={null}
> >       - Greet users warmly and professionally.
> >       - Keep responses concise; expand only if requested.
> >       - Start with a formal tone; adjust as needed.
> >       - Share troubleshooting links for technical issues.
> >       - Apologize if errors occur, then correct promptly.
> >      ```
>
> > [accordion] 4. Knowledge store
> >
> > 1. In the **Knowledge Store** step, configure the following settings:
> >    * **Knowledge Store Type** — select or upload a knowledge source that the flow agent will use to access information from the documents you provide. By accessing and understanding these knowledge bases, the flow agent can deliver more accurate, context-aware, and helpful responses to user queries. You need to configure an [embedding model](https://docs.cognigy.com/ai/agents/develop/knowledge-ai/overview) to use Knowledge AI. Select one of the following options:
> >      * **Choose existing Knowledge Store** — select the [Knowledge Store](https://docs.cognigy.com/ai/agents/develop/knowledge-ai/knowledge-store.md) that the flow agent will use to access information from the documents you provide.
> >      * **Upload Knowledge Source** — upload documents with supported formats, such as PDF, text, DOCX, PPTX, or CTXT file formats. The CTXT file format has restrictions. For more information, refer to the [CTXT](https://docs.cognigy.com/ai/agents/develop/knowledge-ai/knowledge-source/text-formats/ctxt.md) article.
> >      * **Upload URL Knowledge Source** — enter the URL of the web page to be used as a Knowledge Source. This type of Knowledge Source has restrictions. For more information, refer to the [Web Page](https://docs.cognigy.com/ai/agents/develop/knowledge-ai/knowledge-source/text-formats/web-page.md) article.
>
> > [accordion] 5. Data privacy & security
> >
> > 1. In the **Data Privacy & Security** step, configure the fields described in [Data Privacy and Security](https://docs.cognigy.com/ai/agents/develop/flow-agents/data-privacy-and-security.md).
>
> > [accordion] 6. Job selection
> >
> > 1. In the **Job Selection** step, select one of the following options:
> >    * **Default** — create a flow agent with a predefined Flow, then click **Create** to save changes and open the Flow with the created flow agent. If you haven't added an LLM before, the system will prompt you to [configure a model](https://docs.cognigy.com/ai/agents/develop/gen-ai-and-llms/llms) to ensure your AI-driven Flow works.
> >    * **Personality Only** — create a flow agent without a predefined Flow, then click **Create** to save changes.
> >    * **Job** — select one of the available jobs you want to assign to the flow agent, then click **Create** to save changes.

> [tab] API
>
> You can create an Agent from scratch using the [Cognigy API POST beta/aiagents](https://api-trial.cognigy.ai/openapi#post-/beta/aiagents) request.

## Other operations

> [tab] GUI
>
> On the **Flow agents** tab, you can view and delete flow agents and copy their Reference ID.

> [tab] API
>
> You can create, edit, and delete flow agents using [Cognigy API](https://api-trial.cognigy.ai/openapi#get-/beta/aiagents).

> [tab] CLI
>
> You can clone and edit flow agents using [Cognigy CLI](https://github.com/Cognigy/Cognigy-CLI).
