Skip to main content

Deploying and Configuring Agents on the Zeta Alpha Platform

In this tutorial, we will guide you through the process of deploying your agents on the Zeta Alpha platform. By the end of this tutorial, you will have your agent uploaded in the Zeta Alpha platform and ready to be configured in your tenant.

Prerequisites​

Before you begin, make sure you have completed the following tutorial:

Also make sure you have the following:

  • A Zeta Alpha API Key with admin access to the platform
  • The Zeta Alpha API base URL and the name of the tenant you want to deploy the agent to

Configuring your environment​

In order to upload the agent to the platform, you need to configure your environment with the following command:

za platform login

This command will prompt you to enter:

  1. the Zeta Alpha API base URL: fill in the base URL of the Zeta Alpha API.
  2. the tenant name: fill in the name of the tenant you want to deploy the agent to
  3. the Zeta Alpha API Key: fill in the API key with admin access to the tenant

The output of this command creates a env/zav_config.json file with the configuration needed to connect to the platform and upload your agents.

Uploading the agent to the platform​

After configuring your environment, you can upload the agents in your <agents project> to the platform. For example, if your project contains an agent with the identifier my-agent, that agent will be uploaded.

info

Each uploaded agent becomes available under a specific project of the tenant. By default, this project is named after the <agents project> directory name of your local project. However, you can specify a custom project name by using the --project-name parameter in the upload command.

To upload the agent, run the following command from the root of the <agents project> directory:

za agents deploy upload [--project-name <custom_project_name>]

This command will display the project's agents that are ready to be uploaded. For example, for a project named test-agents which contains the my-agent agent, the command will display:

🚀 Preparing to upload the following agents:
  • test-agents:my-agent
These agents will be uploaded to tenant `<tenant name>` at `<Zeta Alpha API base URL>`
Do you want to continue? [Y/n]:

If everything is correct, type Y and press enter. This will upload the project's agent to the platform.

After a successful upload, the CLI outputs an agent setup JSON file for each agent in the build/ directory. For example, for a project named test-agents with a single my-agent agent, the CLI creates build/my-agent.json:

{
  "bot_identifier": "test-agents:my-agent",
  "agent_name": "test-agents:my-agent",
  "bot_configuration": {
    "context_window_configuration": {
      "enabled": true,
      "preview_tokens": 3000
    },
    "tools_provider_configuration": {
      "enabled": true
    },
    "skills_provider_configuration": {
      "enabled": true,
      "injection_mode": "tools"
    }
  }
}

This file maps directly to the fields in the Platform Admin agent form:

  • bot_identifier — the unique identifier for the agent setup
  • agent_name — the deployed agent to run (in the format project:agent)
  • bot_configuration — the agent's capability configuration (paste this into the Bot Configuration JSON field)

See Managing Agents in the Platform for the full walkthrough.

tip

You can also generate these files without uploading by running za agents deploy bundle. The agent setup JSON files are saved alongside build.zip in the build/ directory.

Listing the uploaded agents​

You can also list the uploaded agents of the project by running the following command:

za agents deploy list

Once the <agents project> is uploaded, you will be shown the list of agent names that have been uploaded in your project. These names are expected to have the following format: <agents project>:<your-agent-name>.

This is the uploaded remote agent name that you will reference when creating an agent setup (example: test-agents:my-agent). The corresponding agent setup JSON files in build/ are ready to use when creating agents in Platform Admin. Follow the next tutorial (Managing Agents in the Platform) to configure and use your agent in the platform.