Skip to main content

Deploy a Workflow as a Service

Deploy a compiled Xircuits workflow as a persistent service. Depending on the workflow type, it runs as a conversational agent, a long-running service, or an on-demand job.

Prerequisites​

  • You are signed in to the XpressAI Platform.
  • You have a compiled .xircuits workflow file.
  • Xircuits Studio is open (see Open Xircuits Studio).

Steps​

  1. Open the compiled workflow in Xircuits Studio.
  2. Click Deploy in the toolbar.
  3. Select the workflow type:
TypeBehavior
AGENTDeploys as a conversational agent that responds to messages in conversations.
SERVICEDeploys as a long-running service that stays active continuously.
OTHERDeploys as an on-demand job that runs when triggered. This type is selected automatically for workflows that do not match the AGENT or SERVICE patterns (for example, utility scripts or batch processing workflows).
  1. Configure any deployment-specific settings (name, environment variables).
  2. Click Deploy.
  3. Wait for the Knative service to be created and reach a Ready state.
info

Deployed workflows run as Knative services in your project's namespace. They share the same infrastructure as agents, including NFS storage and network access.

tip

Use the AGENT type when you want users to interact with the workflow through the conversation interface. Use SERVICE for background processes like data pipelines or monitoring.

warning

Deploying creates a running service that consumes resources. Stop or delete services you no longer need to avoid unnecessary costs.

Verify​

  • The deployed service appears in your project's agent or service list.
  • The service status shows as Ready.
  • For AGENT type: a DM conversation is created automatically, and you can send messages to the agent.
  • For SERVICE type: the service is running and accessible within the namespace.