Async Worker

Learn to set up an asynchronous agentic application with NLX in minutes

What's an Async Worker application?

An Async Worker is an agentic application that runs tasks using assigned tools, such as web search, email delivery, and image/text/PDF generation, to execute work asynchronously (in the background) from a single prompt or trigger. You can also assign custom flows as tools for advanced services or structured processes for your worker to follow.

Worker use cases:

  • Search the web for information and compile the findings into a PDF

  • Discover trending topics and generate a blog post with a promotional image

  • Send results via email or pass them to downstream systems via custom workflows

This application type is ideal when you want automation that gathers, creates, and delivers outputs without building step-by-step conversation flows.

Create a worker app

Import the Research Agent template into your workspace to see a sample use case you can follow as a guide.

  • Select Applications in your workspace menu > Choose New application

  • Click Blank application from the available options > Choose Async worker

  • Provide a name for your application > Click Create application

Configuration

The Configuration tab allows you to provide the necessary instructions, tools, and communication method for your worker to operate.

1

AI Engine

  • Provider: Choose the generative AI intelligence powering your application. You may choose the built-in NLX model or select a managed LLM provider you previously integrated into your workspace

    • Model (optional): For managed LLM providers, you can specify the particular model you want to power your worker's intelligence

  • Prompt: Provide a complete set of instructions that details the purpose and context of the worker's role, its core capabilities, any guidelines you want it to adhere to while executing with given tools and requests, formatting rules or quality standards, and any other rules or notes that are pertinent to its task

2

Delivery

  • Set up the details for how to communicate with your async worker

    • + Add channel: Choose the delivery service that your worker will use to correspond with users

      • User name: Enter a name for your agent that will be visible through its delivery channel

        • Email: Taken from the User name entered with the NLX suffix [user name]@dev.nlxa.gent

      • Allow list: Enter all user emails who are permitted to trigger the worker through email correspondence and receive its executed output

    • Language: Specify the language the worker should use

3

Functionality

  • Select one or more of the following to imbue your worker with different tools for completing its task:

    • Custom: Flow: Choose one or more MCP-enabled flows created in your workspace that the agent can follow. This allows you to provide access to your business systems or other integration services using Data request nodes

    • Generate image: Creates a custom image

    • Generate PDF: Assembles content into a downloadable PDF document

    • Generate text: Writes short or long-form content like summaries, posts, or instructions

    • Search web: Looks up real-time information from the internet to answer questions or gather content

    • Send email: Sends a message or file to an email address with any of the outputs created

  • Click Save

Head to Deployment step when ready to make your worker app live.

Executions

The Executions tab reveals all tasks that have been triggered with your agent and detailed information on its time to process and ultimate status of the task:

  • Goal: Lists the request message a user gave to the agent

  • Status: Lists the current progress state as it performs a request

    • Completed: Finished the defined goal request

    • Waiting for user: Awaiting additional information from the user to complete a request

    • Running: Currently performing the request

    • Failed: An error occurred during execution and the task request could not be completed

  • Runtime: The length of time it takes the agent to complete a request

  • Timestamp: The date and time when a request came in and an execution plan was created

Deployment

The deployment process for a Worker application allows you to construct a build that contains a package of the worker's tools, prompt, and delivery details in the state they exist at the time the build is created. You may then deploy a successful build to make it live or roll back to a previous deployment.

1

Build

  • Click deployment status in upper right > Select Build and deploy

  • Review Validation check for critical errors or detected UX issues in custom flows. Before each new build initiates, a validation check is run to provide a preview of potential errors that may cause failed builds. Detected issues are listed with descriptions and potential solutions

  • You may provide a Description of notable build edits as a changelog

  • Click Create build

You may now test your newest build in your workspace using any of the test chats.

Experiencing a Failed build? Select the All builds option in the deployment status and click the failed build to view details on what caused an error.

2

Deploy

The delivery channel provides the frontend interface and determines how users experience your app. Deploying a build pushes your updates to the delivery channel, effectively making your app live outside of your NLX workspace.

  • Click deployment status in upper right > Select All builds > Choose Deploy on successful build

    • Optional:

      • Deployment languages: Select the languages to include in the deployment, if multiple are available

      • Hosting: Host your application as a Touchpoint app via the conversational.app domain. Ideal for previewing its final look during development and sharing your app externally with collaborators. Enable the Hosting option to configure the URL (e.g., mybusiness.conversational.app)

  • Click Create deployment

Enable One-click deploy to auto-deploy every new build. From the deployment status, open Deployment settings and turn on One-click deploy on. All future builds will deploy automatically.

Once a build is made, flows added as tools can be further edited without affecting a deployed worker application. Only deploying a new build will impact live applications. Only one build can be deployed at a time and deploying any build deactivates the previous one. You can freely alternate between newer and older builds using Rollback or Deploy.

Want to take your worker offline? Click deployment status in upper right of application > Choose all builds and select latest deployed build > From the Deployment tab in modal, click Delete deployment. The app stays offline until you redeploy.

Using your worker app

Your async worker runs tasks asynchronously to achieve its goal. You can interact with your worker after a successful deployment in two ways:

  1. Email delivery channel: Open your email client and send a request to the worker’s email address (found in the Configuration tab of your app). Make sure:

    • The sender email address is on the worker’s Allow list on the Configuration tab

    • The sender confirmed a subscription to the worker from the email notification sent

  2. Touchpoint app (hosted chat): Use the hosting URL found in the deployment link details to open a chat interface and talk to your worker. The hosting option must be enabled when deploying your build

Async Worker settings

  • Set a custom timeout (in seconds) for connecting to the AI provider service. You may also specify the number of successive attempts you permit connection attempts before the request is marked as a fail

Last updated