Overview
On this page
Deploying an agent turns a flow you have built and tested into an API that your own apps and systems can call. The deployed version keeps running while you continue working on the source agent.
What deployment gives you
- A stable API protected by a deployment API key.
- Frozen versions of your flow, files, and knowledge. Changes in the builder do not alter the live version until you redeploy.
- Controls to redeploy, roll back, pause, resume, or delete a deployment.
- Runtime compatibility checks, operational logs, and usage information.
- Billing based on use. You can see activity totals, but you never see the transcripts your consumers (the people who use your app) exchange with the agent.
When to deploy an agent
Deploy when an agent is ready to work outside the builder.
For example, you might connect a clinical-guideline agent to a clinician-facing app. An internal system could also send new patient reports to a document-analysis agent and use the structured reply in its next step.
What you need first
You need an agent that works as expected in the builder. Test its usual inputs and check that its answers follow your instructions.
If you are new to Arkus, start with Create agents using the conversational builder and Create a prompt for your AI agents. Then return here when your agent is ready.
How deployment works
- Deploy your agent. Arkus creates a frozen version and publishes it only after it passes a compatibility check. Follow Deploy & manage.
- Connect your app. Create a deployment API key, then use the Runtime API from your server. Follow Integrate the API.
- Watch and maintain it. Check compatibility, logs, usage, and source-agent updates. Follow Monitor & troubleshoot.
Keep your API key safe
Keep the deployment API key on your server. It grants access to the deployed agent and should never appear in browser code or logs.
Where to go next
- Deploy & manage to publish your first version and manage its lifecycle.
- Monitor & troubleshoot to check supported components, compatibility, logs, and limits.
- Integrate the API to create a key and connect an app.
After your first deploy, use Manage deployment on the agent to return to its versions, access settings, Usage overview, and logs.
