Deployments
Turn your runnables into safe deployed agents
What is a Deployment?
A deployment is a runnable version that is available to be called using one of our different interfaces.
You can see your deployments here
Prerequisites
| You need | Why it matters | How to provide it |
|---|---|---|
| Runnable | You can only create a deployment from an existing runnable | Create Runnable |
1 · Select a runnable
You can see your runnables here.
- Select the runnable you want to deploy to production from the list
- Click on the runnable name to expand the left side bar
- Click on
Create New Deployment
2 · Add name and description
Provide a name and description for your runnable. If you re-use the name of an existing runnable, it will create it as a new version of that runnable.
3 · Permissions
You can provide specific access permissions for your production deployments. The available options are:
Access
- Everyone - All users can access this deployment
- Only Me - Only you can access this deployment
- Specific Roles - Only selected roles can access this deployment
Edit
- Everyone - All users can edit this deployment
- Only Me - Only you can edit this deployment
- Specific Roles - Only selected roles can edit this deployment
If you select specific roles, you must select the roles that will be able to access the deployment.
You can manage your roles here
4 · Variables and Secrets (Optional)
You can provide your production-specific variables and secrets to be replaced during execution time. If you are using any sensitive credentials in your flow, we strongly recommend you use the secrets vault to securely store and use them. Avoid saving your credentials directly in your runnable code.
5 · Guardrails (Optional)
We only apply guardrails to user inputs and final outputs, and all filtering actions are fully logged in the trace — nothing is hidden.
The available guardrails options are:
PII Filtering
Removes personally identifiable information from prompts and responses.
You can select multiple options from the following:
- General - Masks Phone, Email, Address, Age, Username, Password, Driver ID, License plate, Vehicle Identification Number (VIN)
- Finance - Masks CVV, Credit/Debit card expiry, Credit/Debit card number, Personal Identification Number (PIN), International Bank Account Number, SWIFT code
- IT - Masks IPv4 address, Media Access Control (MAC) address, Web address, AWS access key, AWS secret key
- USA Specific - Masks US passport number, US Social Security Number (SSN), US Individual Taxpayer Identification Number (ITIN), US bank account number, US bank account routing number
- Canada Specific - Masks Canadian Health Service Number, Canadian Social Insurance Number (SIN)
Toxicity Filtering
Filters content for the following categories: Hate, Insults, Sexual, and Misconduct.
You can select one of the following options:
- Low - Blocks only the most extreme toxic content such as threats or hate speech
- Medium - Filters a balanced level of harmful language including insults, harassment, and offensive comments
- High - Applies the strictest filtering to remove even mild toxicity or potentially harmful tone
Profanity Filtering
Blocks profane and offensive language from prompts and responses.
You can toggle it as enabled/disabled.
Custom guardrails can be created upon request.
6 · Deploy Runnable
Once you are ready with your deployment settings, click the Deploy Runnable button and you will see your deployment details.
Related Resources
Updated 4 days ago
