image-api-workbench

name

image-api-workbench

description

Generate, edit, probe, and verify images through the OpenAI Images API or compatible gateways such as NewAPI. Use for GPT Image generation, reference-image editing, transparent PNG/WebP assets, bilingual visual localization, model catalog checks, streaming partial images, API compatibility tests, covers, social graphics, and publishing assets. Triggers on image API, GPT Image, NewAPI image, gpt-image-2, generate image, edit reference image, 生成图片, 生图, 配图, 封面图, 透明图, 图片编辑, 参考图编辑, 双语图片, 模型可用性. Excludes image search, visual critique, local-only bitmap editing, and requests that explicitly require the built-in image generation tool instead of an API workflow.

Image API Workbench

Purpose

Run reproducible Images API generation or editing against OpenAI or a reviewed compatible gateway. The CLI validates requests, catalogs, streaming partials, outputs, and evidence. Default to gpt-image-2; catalogs are route evidence, not endpoint proof.

Workflow

1. Read model support before changing models or advanced parameters.
2. Use scripts/image_api_workbench.py --dry-run for every new parameter combination.
3. Use --list-remote-models to inspect the configured gateway without spending image credits.
4. Generate with /v1/images/generations; add --input-image to switch to /v1/images/edits.
5. Use --background transparent --output-format png or webp for alpha.
6. Use --stream --partial-images 1..3 only when the gateway relays image SSE.
7. Save assets outside this skill and inspect the image plus metadata sidecar.

Safety Defaults

• gpt-image-1.5, gpt-image-1-mini, and chatgpt-image-latest require --allow-deprecated-model; all are scheduled to shut down on 2026-12-01.
• Retired DALL-E models are blocked unless --allow-retired-model is explicit.
• Known GPT Image parameters are model-validated. Provider extensions require --allow-provider-extensions.
• Credentials come from environment variables or token files. Never persist keys in prompts, metadata, skill files, reports, or logs.
• Metadata stores a prompt hash by default. Prompt preview is opt-in.

Editing And Localization

For matched bilingual visuals, create one approved master and edit that exact image for each language. Preserve composition and non-text details; replace visible copy only. Build a side-by-side review with scripts/bilingual_contact_sheet.py.

See operating guide for commands, error classification, streaming behavior, and verification. Routing boundaries are covered by evals/trigger_cases.json.

Output Contract

A successful paid call requires:

• stdout JSON has ok: true;
• final image exists and is non-empty;
• metadata sidecar exists unless explicitly disabled;
• detected format and dimensions are plausible;
• actual_size_matches_request is checked rather than inferred;
• edit metadata identifies each input by path, bytes, SHA-256, and dimensions.

Catalogs and dry runs do not prove endpoint support. Paid probes require user approval.