Skip to main content

🎨 NovelAI OpenClaw Adaptor

A seamless shim to connect NovelAI's API to OpenClaw using the OpenAI format.

"Solving the core pain point of integrating NovelAI with OpenClaw by providing a simple, OpenAI-compatible local proxy."

License: MIT Python 3.10+

Quick Start · How It Works · 简体中文 · 日本語

Preview 1 Preview 2 Preview 3 Preview 4
Preview 5 Preview 6 Preview 7 Preview 8

Why NovelAI OpenClaw Adaptor? 🌟

The core pain point for many users is that NovelAI's API cannot be directly integrated into OpenClaw, as OpenClaw expects the standard OpenAI API format.

To solve this, we created a shim (adaptor) that acts as a middleman. It translates OpenAI-formatted requests from OpenClaw into NovelAI-compatible requests, and returns the generated images seamlessly.

Additionally, it supports a simplified generation method: you can just pass your prompt directly to generate images without complex configurations!

Quick Start 🚀

📥 Install:

pip install novelai-openclaw-adaptor

⚙️ Initialize config:

novelai-config init

One-line init example:

novelai-config init --language en --api-key "YOUR_NOVELAI_API_KEY" --text-model glm-4-6 --image-output-dir "./images" --image-model nai-diffusion-4-5-full --force

▶️ Start the text model shim:

novelai-shim

🖼️ Generate an image:

novelai-image --prompt "1girl, solo, masterpiece, best quality"

❓ Help:

novelai-config --help
novelai-shim --help
novelai-image --help

Connect to OpenClaw:

Tell OpenClaw directly:

Help me install novelai-openclaw-adaptor and add a new model provider "novelai": pip install novelai-openclaw-adaptor && novelai-config --help

Supported Models

Text models exposed by the shim:

  • glm-4-6
  • erato
  • kayra
  • clio
  • krake
  • euterpe
  • sigurd
  • genji
  • snek

Image models supported by the image CLI:

  • nai-diffusion-4-5-full
  • nai-diffusion-4-5-curated
  • nai-diffusion-4-full
  • nai-diffusion-4-curated
  • nai-diffusion-3
  • nai-diffusion-3-furry

How It Works ✨

  1. Local Proxy: The adaptor runs locally and provides an OpenAI-compatible endpoint (e.g., http://localhost:xxxx/v1).
  2. Format Translation: When OpenClaw sends an OpenAI-style request, the adaptor translates it into NovelAI's specific parameters.
  3. Simple Prompting: You can simply pass the prompt string to generate images.
  4. Configuration: In OpenClaw, set the base_url to your local adaptor address, for example http://127.0.0.1:11434/v1, and configure the model name as required.

License 📄

This project is released under the MIT license.

Metadata

Release files for novelai-openclaw-adaptor 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for novelai-openclaw-adaptor 1.0.0
File Size Uploaded
novelai_openclaw_adaptor-1.0.0.tar.gz 27.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for novelai-openclaw-adaptor 1.0.0
File Interpreter ABI Platform
novelai_openclaw_adaptor-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 54.2 kB

Release files / novelai_openclaw_adaptor-1.0.0.tar.gz

Download URL novelai_openclaw_adaptor-1.0.0.tar.gz
Size 27.1 kB
Tags Source
SHA-256 checksum
How to use checksums
ba9c4ce0f2fa3d6856a82dcecea245282e8cf5cb4b2fb7bec174936f524fca14
BLAKE2b-256 checksum
How to use checksums
4e219233345b6334b231a3d160b884eaa4ca4432a9bf2cb1882628dd44f4f22b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Release files / novelai_openclaw_adaptor-1.0.0-py3-none-any.whl

Download URL novelai_openclaw_adaptor-1.0.0-py3-none-any.whl
Size 27.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f8efd77d8986f33978e3356c0db5d7a43f062f2429259967763cad1a2466d5b2
BLAKE2b-256 checksum
How to use checksums
f5d2ac86e1b721129d9cf33d4e3fe6a1060224f2b78ab368c038449dd4c2f486
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.7

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page