API 參考文件
即時更新,由 OpenAPI 合約產生。
每個端點、結構定義與範例,都與驅動平台的規格同步更新。先探索一番,再用個人存取權杖驗證。
API 文件
完整的 OpenAPI 參考文件:生成、素材、任務、帳務與帳號端點,附上請求與回應的結構定義。
驗證
請求以 Bearer 權杖的形式攜帶個人存取權杖(PAT)。帶上名稱 POST 到 /pat 即可產生。明文權杖(前綴為 nol_)只會回傳一次,請妥善保存。
curl -X POST https://api.nolgia.ai/pat -d '{"name":"my-cli"}'接著在每個請求中以 Authorization: Bearer nol_… 傳送。PAT 只會扣加值點數,絕不動用每月方案點數;需要 Pro 以上方案的模型,仍須具備該方案。
CLI
安裝 nolgia CLI。
一個 Rust 執行檔,就能在終端機生成圖片、影片與音訊。下方每種方式安裝的都是同一個版本。
Homebrew
brew tap nolgiainc/nolgia && brew install nolgia適用 macOS 與 Linux。nolgiainc/homebrew-nolgia 中的 nolgia formula 會追蹤最新版本。
npm
npm install -g @nolgia/cli需要 Node 18 以上版本。會在 postinstall 階段下載適用你平台的預先建置執行檔。
Shell 安裝程式
curl -fsSL https://raw.githubusercontent.com/nolgiainc/nolgia-cli/main/install.sh | bash這道指令會執行從儲存庫 main 分支取得的腳本,接著下載發行版執行檔。如果你的環境需要審查或來源驗證,請先儲存並檢查 install.sh,再用 --tag 鎖定執行檔版本。
Cargo
cargo install nolgia-cli使用穩定版 Rust 工具鏈從原始碼建置。
發行版執行檔
GitHub 版本頁面上有各平台的預先建置執行檔:
nolgia-x86_64-apple-darwinmacOS (universal)nolgia-x86_64-unknown-linux-gnuLinux x86_64nolgia-aarch64-unknown-linux-gnuLinux arm64nolgia-x86_64-pc-windows-msvc.exeWindows x86_64nolgia-aarch64-pc-windows-msvc.exeWindows arm64
技能與外掛程式
教會你的 AI 程式設計代理使用 NOLGIA。
發布於 nolgiainc/nolgia-skills 的三項技能,會教 Claude Code、Cursor 與 Codex 認識平台、影片提示詞寫法與 UGC 廣告。依你的 AI 代理挑選安裝方式。
任何 AI 代理
npx skills add nolgiainc/nolgia-skills需要 Node.js。skills CLI 會偵測 Claude Code、Cursor、Codex 與其他支援的 AI 代理。
GitHub CLI
gh skill install nolgiainc/nolgia-skills --all需要 GitHub CLI 2.90 以上版本(此指令仍在預覽階段)。加上 --scope user 即可為所有專案安裝。
Claude Code
/plugin marketplace add nolgiainc/nolgia-skills
/plugin install nolgia@nolgia在 Claude Code 中輸入這些指令,即可註冊 /nolgia:nolgia-platform、/nolgia:nolgia-video-prompting 與 /nolgia:nolgia-ugc-ads。
Cursor
skills 儲存庫附有 Cursor 外掛程式資訊清單。託管 MCP 伺服器與 /nolgia 指令則來自 nolgiainc/cursor-plugin。
GitHub 上的 nolgiainc/cursor-pluginCodex
gh skill install nolgiainc/nolgia-skills --all --agent codex --scope user以外掛程式形式安裝時,Codex 也會讀取儲存庫中的 Codex 外掛程式資訊清單。
從 nolgia CLI
nolgia skills installCLI 內建同樣的三項技能。目標:--target claude-user、--target claude-project、--target hermes,或 --target dir --dir <path>。
把這段貼給你的 AI 代理
Read https://raw.githubusercontent.com/nolgiainc/nolgia-cli/main/INSTALL_FOR_AGENTS.md and follow it end to end to install and set up the Nolgia CLI for me.你的 AI 程式設計代理會在不需要 sudo 的情況下安裝 CLI,等你完成驗證後安裝技能,再執行一次測試生成。
閱讀操作手冊官方 SDK
四種用戶端,一個平台。
安裝適合你技術堆疊的用戶端,幾分鐘內就能開始生成。每個 SDK 都對應同一套 API。
Python
PyPI · nolgia由 OpenAPI 合約產生的具型別用戶端。匯入 AuthenticatedClient,再呼叫 nolgia.api.* 模組即可。
pip install nolgiaJavaScript / TypeScript
npm · @nolgia/sdk適用 Node 與瀏覽器、完整具型別的 openapi-fetch 用戶端。一次安裝就帶齊所需的一切,以 ESM 發行,並提供完善的 TypeScript 型別定義。
npm install @nolgia/sdkRust
crates.io · nolgia建構於 tokio 的非同步用戶端,由 OpenAPI 合約產生,內建重試、具型別的錯誤、任務等待、上傳與下載。一次安裝就好:它會重新匯出所需的執行環境與 serde_json。只要開啟一個功能旗標,就能改用阻塞式用戶端。
cargo add nolgiaRust CLI
crates.io · nolgia-clinolgia 指令:在終端機生成圖片、影片與音訊的單一 Rust 執行檔。若要在 Rust 程式碼中使用,請改用上方的 nolgia crate。
cargo install nolgia-cli快速入門
先驗證,再呼叫。
用你的 PAT 建立用戶端、提交一次圖片生成,再以長輪詢等待任務產出素材:正是每份 SDK README 開頭的那三個呼叫。Python 用戶端提供具型別的 nolgia.api.* 模組,Rust crate 的 subscribe 一次呼叫就能提交並等待,CLI 則讓你從 Shell 操作整個平台。

from nolgia import AuthenticatedClient
from nolgia.api.generate import generate_image
from nolgia.api.jobs import wait_for_job
from nolgia.models import GenerateImageRequest, ImageModel, Job
# Create a token at https://nolgia.ai/settings/api-tokens and pass it as a bearer.
client = AuthenticatedClient(base_url="https://api.nolgia.ai/v1", token="nol_...")
# POST /generate/image answers 202 with a job.
job = generate_image.sync(
client=client,
body=GenerateImageRequest(model=ImageModel.GPT_IMAGE_2, prompt="a red fox in the snow"),
)
if not isinstance(job, Job):
raise SystemExit(f"refused: {job}")
# Long-poll GET /jobs/{id}/wait for the finished asset.
done = wait_for_job.sync(job.id, client=client, timeout_seconds=120)
if isinstance(done, Job) and done.status == "succeeded":
print(done.asset.signed_url)import { createNolgiaClient } from "@nolgia/sdk";
// Create a token at https://nolgia.ai/settings/api-tokens and pass it as a bearer.
const nolgia = createNolgiaClient("nol_...");
// POST /generate/image answers 202 with a job.
const { data: job, error } = await nolgia.POST("/generate/image", {
body: { model: "gpt-image-2", prompt: "a red fox in the snow", num_images: 1 },
});
if (error) throw new Error(`${error.title}: ${error.detail ?? ""}`);
// Long-poll GET /jobs/{id}/wait for the finished asset.
const { data: done } = await nolgia.GET("/jobs/{id}/wait", {
params: { path: { id: job.id }, query: { timeout_seconds: 120 } },
});
if (done?.status === "succeeded") console.log(done.asset?.signed_url);use nolgia::tokio;
#[tokio::main]
async fn main() -> nolgia::Result<()> {
// Create a token at https://nolgia.ai/settings/api-tokens and export it as NOLGIA_API_KEY.
let nolgia = nolgia::Client::from_env()?;
// POST /generate/image answers 202 with a job; subscribe long-polls
// GET /jobs/{id}/wait for the finished asset.
let done = nolgia.subscribe(nolgia::image("gpt-image-2", "a red fox in the snow")).await?;
nolgia.download(done.url().expect("an image"), "fox.png").await?;
Ok(())
}# Authenticate once: device login in your browser.
nolgia auth login
# Generate an image from a prompt.
nolgia gen image \
--prompt "a serene mountain lake at dawn" \
--out lake.png在 NOLGIA 上開發
不只是一套 API。
透過 MCP 把平台連接到你自己的助理、用市集裡的能力擴充你的 AI 代理,或讓 NOLGIA Agent 替你執行生成。


