HomeGuidesAPI ReferenceRelease notes
Log In
Guides

Deploying agents

SUPERWISE® enables you to deploy and publish production-grade agents using either the built-in internal agent builder or by registering an external agent you've developed elsewhere. Once your agent is ready, it can be deployed and integrated into your environment, with tools for embedding, querying, and monitoring.

📘

Test before you publish

Before publishing, please use our playground tool to ensure your agent works as expected and avoid publishing redundant versions. To read more, please visit here.

Publish via the UI

Once the agent configuration is ready, publishing is as simple as clicking a button. Just press "Publish," supply a few basic details to describe your newly published version, and the new version should be deployed within 1-2 minutes.

📘

Version details

When publishing a new version, please use short and concise names and provide details to describe the changes made from the previous version. This will help you later review changes or roll back correctly if needed.

Please note that the publish option is only available when you have a valid agent configuration. This means that for native SUPERWISE® agents, the required configuration per agent type should be provided (e.g., a model and context for AI assistant retrieval) or registration settings for externally based agents.

While publishing, you will see an indication in the UI that the new version is deploying.

Agent Status

You can track your agent's deployment status directly within the SUPERWISE® interface. The main statuses you may encounter include:

  • Available – The agent is live and accessible. Note that this status may still display as "Available" even if there are internal issues with agent components.
  • Unavailable – The agent is currently offline, and the service is down. This status will remain until a valid version has been deployed.

Publish via the SDK

Create agent:

agent = sw.agent.create(f"my agent name", description="Description for my agent", authentication_enabled=False, observability_enabled=True)

Deploy version:

version = sw.agent.create_version(agent_id=agent.id,name="My Version name", description="My Version description", agent_config=agent_config)

See the status of a given agent:

agent = sw.agent.get_by_id("2baea60a-8af1-4513-9012-595ccc1ebe91")
status = agent.status

Now what...

Once your version is deployed, you can:

  • Embed your agent - Use our agent embedding options to integrate it into your production environments.
  • Operate your agent - Use the agent management settings tab to manage operational aspects of your agent, such as the use of observability services, authentication, and more.