Skip to main content

HTTP API agent for remote model management

Project description

XM Agent

HTTP API agent for remote model management. Runs on RunPod or Linux servers and exposes endpoints for model listing, hashing, downloading, and CivitAI metadata lookup.

Installation

# Using uv
uv pip install xm-agent

# Or from git
pip install git+https://github.com/user/xm-agent.git

# Or install locally for development
cd xm-agent
uv sync --dev

Usage

# Start the server (default port 8765)
xm-agent serve

# With custom port and host
xm-agent serve --port 9000 --host 0.0.0.0

Configuration

Configuration via environment variables:

Variable Default Description
XM_AGENT_HOST 0.0.0.0 Server bind address
XM_AGENT_PORT 8765 Server port
XM_AGENT_MODELS_PATH /workspace/ComfyUI/models Base path for model directories
CIVITAI_API_KEY - CivitAI API key for gated models

RunPod

On RunPod, the agent auto-detects the environment via RUNPOD_POD_ID and prints the proxy URL on startup:

XM Agent v0.1.0 starting...
Listening on 0.0.0.0:8765
Models path: /workspace/ComfyUI/models
RunPod detected: abc123xyz
Proxy URL: https://abc123xyz-8765.proxy.runpod.net

API Endpoints

Health

GET /health

Returns server status and version.

{"status": "ok", "version": "0.1.0", "runpod_url": null}

Models

GET /models

List all models across all types.

GET /models/{type}

List models of a specific type. Types: checkpoints, loras, embeddings, vae, controlnet.

GET /models/{type}/{filename}/hash

Compute SHA256 hash of a model file.

{"hash": "ABC123...", "filename": "my_lora.safetensors"}
DELETE /models/{type}/{filename}

Delete a model file.

Download

POST /download

Start a model download as a background task.

Request body:

{
  "url": "https://civitai.com/api/download/models/12345",
  "type": "loras",
  "filename": "my_lora.safetensors",
  "expected_hash": "ABC123..."
}

Response:

{"task_id": "abc123def456"}
GET /download/{task_id}

Get download progress.

{
  "task_id": "abc123def456",
  "status": "running",
  "progress": 45,
  "speed": "5.2 MB/s",
  "error": null,
  "result": null
}
DELETE /download/{task_id}

Cancel a download.

Metadata

GET /metadata/{hash}

Look up model metadata on CivitAI by SHA256 hash.

POST /metadata/sync

Sync metadata for all models. Computes hashes and fetches CivitAI metadata. Returns a task ID for progress tracking.

Development

# Install dev dependencies
uv sync --dev

# Run tests
uv run pytest

# Run server in development
uv run xm-agent serve --port 8765

Security

  • Only downloads from allowed domains (CivitAI, HuggingFace)
  • Path traversal protection for model file operations
  • No authentication by default (assumes trusted network/RunPod proxy)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xm_agent-0.1.11.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xm_agent-0.1.11-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file xm_agent-0.1.11.tar.gz.

File metadata

  • Download URL: xm_agent-0.1.11.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xm_agent-0.1.11.tar.gz
Algorithm Hash digest
SHA256 9a5fa89071e7dbca4a5ccf239264ddc67ee9a03d6ae832ce7f96904f030860a1
MD5 118b46e6d0248afd9a4084d6e69cb9b4
BLAKE2b-256 f95ac0e72299901a999a650f9d11f16d404e8a0914d0e1e0855e85e3fc4ca62d

See more details on using hashes here.

Provenance

The following attestation bundles were made for xm_agent-0.1.11.tar.gz:

Publisher: python-publish.yml on aladac/xm-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file xm_agent-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: xm_agent-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for xm_agent-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 d906fc7c9c0e3068f58cadd7fe374403249daddddaa5a326b2791a21b148d46f
MD5 d4064633ddb683e4a76a4a393cd3a649
BLAKE2b-256 b4f9a64708fe767d3cbc709fe6ea12e4a54dbac53e6da17bbab85d007d30e727

See more details on using hashes here.

Provenance

The following attestation bundles were made for xm_agent-0.1.11-py3-none-any.whl:

Publisher: python-publish.yml on aladac/xm-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page