docs: image generation and edit job pages - #64
Merged
Conversation
Document the image.generate and image.edit jobs plus a Generation API concept page. Covers params, the tier/pinned-model catalog from gen-models.json, per-model controls, GET /models discovery, and the webp output shape. Adds the pages to docs.json nav (Generate subgroup under Jobs, Generation under Concepts).
The tier table predated the 2026-07-29 catalog change: standard resolves to z-image-turbo, not ernie-image-turbo, and both ernie-image-turbo and qwen-image-2512-lightning are under review, so pinning either one is rejected at submit. The pages also documented estCostUsd, which GET /models no longer returns; priceTier replaced it. Preview streaming shipped with the jobs but was never documented. - Rebuild both tier tables from gen-registry.ts - Replace every dollar figure with the relative priceTier - Document underReview and the VALIDATION_ERROR it produces - Fix the GET /models sample to the shape the route actually returns - Correct enhancePrompt: no model in the catalog enhances by default - Add a preview streaming section with the job.preview field reference - Note the 4096px dimension cap
The validator has failed on main for the last five merges: the description runs 183 chars against a 160 cap and opens with "Compress", which is not in the allowed start-verb list. Rewritten to 155 chars starting with "Get".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the docs for
image.generateandimage.edit, which went live to production on 2026-07-30 with a changelog entry but no documentation.Three new pages plus nav:
jobs/image-generate.mdx— text to image, tiers and pinned models, model discoveryjobs/image-edit.mdx— instruction editing with one to four reference imagesconcepts/generation.mdx— how tiers, pinned ids, and the shared catalog workThe pages were originally written on 2026-07-26 and the catalog moved underneath them on 2026-07-29, so the second commit rebuilds every factual claim against
gen-registry.tsandgen-models.json:standardresolves toz-image-turbo, noternie-image-turboernie-image-turboandqwen-image-2512-lightningareunderReview, so pinning either returnsVALIDATION_ERROR. Documented, with the reasonestCostUsdis gone fromGET /models. Every dollar figure is replaced by the relativepriceTierGET /modelssample now matches the response schema field for fieldjob.preview/ SDKonPreview) is documented for the first timeTest plan
#watch-it-render,#discover-models.mint validatecould not run locally (the CLI rejects Node 25+)packages/shared/src/jobs/gen-registry.tsandgen-models.jsonorigin/main, so the diff is purely additivePairs with the monorepo PR that adds the
llms.txtlinks pointing at these pages.