Documentation

Build.
Deploy.
Executeseamlessly

DeployGent automatically parses Python AI agent modules, extracts task metadata, generates web execution forms, and handles runtime infrastructure.

Get Started Homepage

Quick Index

# Getting Started # Installation # Quick Start # Agent # Tasks # Inputs # Outputs # Runtime # Deployment # CLI # API # Examples

Getting Started

DeployGent turns standard Python repositories into production-ready agent endpoints. The platform clones your code repository, installs dependencies via standard requirements files, inspects module decorators via AST analysis, and hosts an interactive web playground automatically.

Installation

pip install deploygent

Quick Start

from deploygent import Agent

agent = Agent(
    name="Summarizer",
    description="Summarize long documents."
)

agent.serve()

Agent Specification

Every DeployGent repository exposes an initialized Agent instance. The Agent class aggregates operational metadata, registered tasks, runtime parameters, and standard IO bindings required to auto-render input interfaces.

Task Registration

@agent.task
def summarize(text: str) -> str:
    return text

Input Components

Declare task parameters using any of the following input types. Every input accepts label, placeholder, description, required, default, disabled, and hidden, plus the type-specific properties listed below.

TextInput

Single-line free text entry.

label · placeholder · required · default

TextAreaInput

Multi-line free text entry.

rows (default 5)

NumberInput

Numeric entry with bounds.

min · max · step (default 1)

BooleanInput

On/off toggle switch.

default (true / false)

PasswordInput

Masked single-line text entry.

label · placeholder · required

EmailInput

Text entry validated as an email address.

label · placeholder · required

URLInput

Text entry validated as a URL.

label · placeholder · required

DateInput

Calendar date picker.

min · max

TimeInput

Time-of-day picker.

label · required · default

DateTimeInput

Combined date & time picker.

label · required · default

FileInput

Generic file upload.

accept · multiple · max_size

ImageInput

File upload restricted to image/*.

extends FileInput

AudioInput

File upload restricted to audio/*.

extends FileInput

VideoInput

File upload restricted to video/*.

extends FileInput

SelectInput

Single-choice dropdown.

options[] · searchable

MultiSelectInput

Multi-choice selector.

options[] · searchable

JSONInput

Structured JSON entry with live validation.

schema (optional)

Output Renderers

Return any of the following output types from a task to control how the result is rendered in the playground. Every output accepts title, description, downloadable, and preview, plus the type-specific properties listed below.

TextOutput

Renders a plain text response.

title · description

MarkdownOutput

Renders formatted markdown content.

title · description

JSONOutput

Renders a structured JSON payload.

pretty · collapsible

HTMLOutput

Renders raw HTML markup.

title · description

TableOutput

Renders tabular data as a data grid.

sortable · searchable · pagination

ImageOutput

Renders an inline, previewable image.

format · downloadable (default true)

AudioOutput

Renders an inline audio player.

downloadable (default true)

VideoOutput

Renders an inline video player.

downloadable (default true)

FileOutput

Generic downloadable file.

extension · downloadable (default true)

PDFOutput

Downloadable PDF document.

downloadable (default true)

CSVOutput

Downloadable CSV file.

downloadable (default true)

ZIPOutput

Downloadable ZIP archive.

downloadable (default true)

Runtime Management

DeployGent allocates dedicated execution ports, spawns isolated worker sub-processes, monitors execution state, and generates strict OpenAPI REST specifications for every agent deployed.

Deploying via CLI

deploygent deploy

CLI Commands

$ deploygent deploy

$ deploygent serve

$ deploygent doctor

$ deploygent describe

REST API Reference

POST/runExecute a task

GET/healthInstance health status

GET/metadataExtract agent metadata

GET/tasksList registered tasks