Documentation | ZroImg

On this page

Guides

New to ZroImg? Start with the introduction and quickstart, then learn how credits are charged.

IntroductionZroImg is an all-in-one AI visual creation platform: text-to-image and video, reference remixes, inpainting, infinite canvas, prompt polish, gallery and API.QuickstartGet started with ZroImg in minutes: sign up, get credits, create your first image and video, try the infinite canvas and AI prompt polish, and manage your works.Credits & BillingZroImg bills in credits: per image, per video second or request, and per AI polish. Learn how costs are estimated and charged, refunds, check-ins and packages.

API basics

Before you call the API, learn about authentication, the async task model, idempotency, rate limits and errors.

API OverviewGet started with the ZroImg API: base URL, API key auth, async tasks, idempotent submits, rate limits and errors, plus full Python and JavaScript examples.Error CodesZroImg API error format and codes: auth failures, insufficient credits, rate and concurrency limits, idempotency conflicts, invalid params, not found, and retries.

API endpoints

Parameters, responses and ready-to-run cURL, Python and JavaScript examples for every endpoint.

ModelsGET /open/v1/models lists available image and video models with modes, ratios, quality or resolution, counts, durations, reference limits, defaults and pricing.Image GenerationPOST /open/v1/images/generations submits text-to-image, image-to-image and inpainting tasks; returns a task object and credit cost. Supports Idempotency-Key.Video GenerationPOST /open/v1/videos/generations submits text-to-video and image-to-video tasks with duration, ratio, resolution and multiple references; returns a task and cost.TasksGET /open/v1/tasks/{id} returns task status, progress, download URLs and failure reasons; GET /open/v1/tasks pages tasks by status and type, with polling tips.Prompt PolishPOST /open/v1/prompts/polish expands a short description into a detailed image or video prompt, billed like web AI polish; returns the result, cost and balance.Credit BalanceGET /open/v1/balance returns the credit balance of the account that owns the API key. The API and web app share one balance; use it for pre-checks or alerts.