Preserve the brief
Archive each input with its output. Keep established requirements for revisions instead of retaining a context-free image.
Code examples
Local example workbenchConnect the capability.
Build what comes next.
Start with a task. Follow the request into a system, then bring a useful result back to your product.
Choose a scenariodesign.generate
Turn a design brief into a generation task.
Structure the product type, form and material requirements. Create a task from your design tool, then return the result to concept review.
Local demonstration
Illustrative contract · use your agreed version for integration. Playback makes no network requests.
01Build the request
POST /v1/tasks
{
"capability": "design.generate",
"input": {
"prompt": "Design an elegant electric GT in liquid silver, with a low silhouette and a dark panoramic roof.",
"constraints": {
"view": "front_three_quarter",
"material": "satin_metal",
"background": "dark_studio"
}
},
"output": {
"format": "png"
}
}Input
Natural-language brief + material and view constraints
02Read the resultinput
Prepare
Make the design intent explicit.
{
"capability": "design.generate",
"input_checks": [
"prompt_present",
"view_supported",
"format_supported"
]
}Output
Image artifact + traceable task result
Follow one complete call.
Play the sequence or select a step to inspect it.
Make the design intent explicit.
Capture product, proportions, material and view. Input can come from a conversation or an existing design form.
From example to integration
Beyond the code,
there is a business context.
Integration places model inputs and outputs inside your system. Each scenario needs its own context, provenance and acceptance criteria.
Separate generation and review
The model produces a concept. Manufacturing feasibility, exact dimensions and structure remain subject to design and engineering review.
Keep artifacts in your workflow
Read outputs within the agreed access period, associate project and version, then expose them according to application rules.
Take a clear starting point
Request, response, walkthrough.
Ready to study in your project.
Download the current scenario as a JSON fixture with requests, response examples and walkthrough notes. Use it to discuss integration or prototype your frontend locally.
design.generateCurrent scenario
- requestInput & parameters
- responseResponse fixture
- walkthroughExecution steps
- curlRequest syntax
A local example file; model services and 3D asset binaries are integrated separately.
Beyond the happy path
For every state,
give your product a next step.
Results & errors referenceINVALID_INPUTFix the input before creating another task.
Identify missing fields or unsupported formats. Create the next request after the input is corrected.
ACCESS_DENIEDCheck permissions instead of repeating requests.
Distinguish API credentials from asset permissions. Resolve inaccessible inputs at the integration boundary.
POLLING_TIMEOUTKeep the task and observe it later.
A local polling timeout does not mean server-side failure. Query the existing task ID to avoid duplicate generation.
Error names are illustrative; use the agreed contract in production.
From understanding the call to building the integration.