Deploy Quick Start

Add a deploy: section to agents.yaml, then deploy it with three method calls.

from praisonai_deploy import Deploy

deploy = Deploy.from_yaml("agents.yaml")
result = deploy.deploy()
status = deploy.status()

Quick Start

Write agents.yaml

Add a deploy: block alongside your agent definition.

name: Sample Agent
framework: praisonai

agents:
  assistant:
    role: Assistant
    goal: Help users with tasks
    backstory: Experienced assistant ready to help

deploy:
  type: api
  api:
    host: 127.0.0.1
    port: 8005

Deploy from Python

from praisonai_deploy import Deploy

deploy = Deploy.from_yaml("agents.yaml")
result = deploy.deploy()
print(result.url)  # http://127.0.0.1:8005

Or deploy from the CLI

praisonai deploy run --file agents.yaml

agents.yaml by Type

Each deployment type reads a matching block under deploy:.

API
Docker
Cloud (GCP)

deploy:
  type: api
  api:
    host: 127.0.0.1
    port: 8005
    workers: 1
    cors_enabled: true
    auth_enabled: true

deploy:
  type: docker
  docker:
    image_name: praisonai-app
    tag: latest
    base_image: python:3.11-slim
    expose:
      - 8005
    push: false
  # Optional — configure the generated in-container server.
  # Omit to keep default auth on.
  api:
    host: 0.0.0.0
    port: 8005
    auth_enabled: false   # exposes /chat without a token

The sibling api: block under type: docker shipped in PR #3609. Before that, auth_enabled: false was silently dropped and the container returned 401 on /chat.

deploy:
  type: cloud
  cloud:
    provider: gcp
    region: us-central1
    service_name: my-agent
    project_id: your-project-id
    min_instances: 1
    max_instances: 10

Generate a Sample

generate_sample_yaml produces a ready-to-edit config for any type.

from praisonai_deploy import generate_sample_yaml, DeployType, CloudProvider

yaml_text = generate_sample_yaml(DeployType.CLOUD, CloudProvider.GCP)
print(yaml_text)

Best Practices

Start with type: api

The API type needs no cloud credentials and runs on your machine. Validate the agent locally before moving to Docker or cloud.

Validate before you deploy

Run praisonai deploy validate --file agents.yaml to catch schema errors early — a type: cloud block without a cloud: section fails fast.

Need a target that isn’t built in? See Custom cloud providers.

Config Reference

Every field, type, and default

Python API

Deploy class methods and results

Getting Started

Install

Core Concepts

Guides

Features

Models

Databases

Observability

Memory

Telemetry & Analytics

Knowledge

RAG

Persistence

Tools

Other Features

Developers

Configuration

Best Practices

Getting Started (No Code)

Deploy Quick Start

Quick Start

agents.yaml by Type

Generate a Sample

Best Practices

Config Reference

Python API

​Quick Start

​agents.yaml by Type

​Generate a Sample

​Best Practices

​Related

Config Reference

Python API

Quick Start

agents.yaml by Type

Generate a Sample

Best Practices

Related