nexscope-ai/nexscope-ecommerce-skills / ecommerce-multimodal-generate-image
ecommerce.multimodal-generate-image
VerifiedAI-driven image generation and editing tool for creating high-quality product images. Triggered when users ask to generate images, create product pictures, edit photos, text-to-image, image-to-image, replace backgrounds, transform styles, composite products into scenes, swap models, or create any type of AI-generated visual content. Even if the user does not explicitly say "AI image," this skill should be triggered whenever the request involves creating, modifying, or transforming images.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.1 KB |
| manifest.json | config | 498 B |
| references/api.md | markdown | 5.7 KB |
| scripts/multimodal_generate_image.py | script | 6.2 KB |
| scripts/upload_image.py | script | 9.6 KB |
references/api.md
View on GitHub# AI Image Generation API Reference
## Request Specification
- **Endpoint**: `${NEXSCOPE_PROXY_BASE}/api/v1/tools/research/multimodal/generateImage`
- **Method**: POST, Content-Type: application/json
- **Authentication**: Header `Authorization: <api_key>`; read api_key from `nexscope_AGENT_API_KEY` or `nexscopeAGENT_API_KEY`. If neither is configured, follow the authentication and credits guidance in SKILL.md.
## Request Parameters
POST Body (JSON):
| Parameter | Type | Required | Description |
|------|------|------|------|
| prompt | string | Yes | Prompt (supports text-to-image, image-to-image, image editing, and model replacement); maximum length 1000 |
| referenceImageUrl | string | No | Reference image URLs, separated by commas; up to 3 images; maximum length 1000 |
| aspectRatio | string | No | Aspect ratio: `1:1` (square, default), `3:4` (portrait), `4:3` (landscape), `9:16` (full-screen portrait), or `16:9` (full-screen landscape); default `1:1` |
## Nexscope response envelope
These research endpoints return a platform object with numeric `code`, nullable `msg`, and business `data`. Only outer `code: 0` means success; `200`, string codes, missing codes, and HTTP 200 alone do not. A nonzero code is a platform error: show `msg` and do not interpret the payload as a successful result.
`msg` preserves the upstream message when available; Chinese messages are translated to English by Nexscope. A successful response without a message has `msg: null`. Do not infer success or retry behavior from the message text. On both success and failure, the direct fields `code`, `errcode`, `errorCode`, `msg`, `errmsg`, `message`, and `errorMsg` are removed from public `data`. Read the message only from outer `msg`; deeper business fields are preserved, including nested `code` and `status`.
Business field tables and abbreviated business examples below describe `data`, unless explicitly labeled as a complete platform response. For example, a business `products` field is at HTTP `data.products`, and a business `data` array is at HTTP `data.data`. The research endpoints already had this outer envelope; no additional wrapper is added.
```json
{"code":0,"msg":null,"data":{}}
```
Metadata includes string `ts` (epoch milliseconds), string `cost` (elapsed milliseconds, not credits), `time`, and nullable `traceId`. Handle network/HTTP failures before the platform code; gateway failures may not be platform JSON. Keep the existing billing-header guidance separate from elapsed time.
## Response Structure
| Field | Type | Description |
|------|------|------|
| id | string | id |
| finished | boolean | Whether generation is complete |
| status | string | Status |
| text | string | Image content |
| type | string | Markdown type |
| title | string | Image |
| costToken | integer | Tokens used |
## Error Codes
HTTP 200 does not prove business success. Read only the numeric outer platform `code`: `0` succeeds and any other value fails. Show outer `msg`; never test removed provider codes or nested business `code` as the platform status. Authentication, permissions, balance, and validation failures may be platform errors even with HTTP 200; also handle non-2xx HTTP and non-JSON responses.
### Recovery guidance
| Condition | Action |
|---|---|
| Authentication failed | HTTP 401 or authorized error: follow the authentication and credits guidance in SKILL.md. |
| Insufficient credits or balance | HTTP 402: follow the authentication and credits guidance in SKILL.md. |
## curl Examples
```bash
curl -X POST ${NEXSCOPE_PROXY_BASE}/api/v1/tools/research/multimodal/generateImage \
-H "Authorization: $nexscopeAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "Generate a professional product photo of a red handbag with a white background and studio lighting",
"aspectRatio": "1:1"
}'
```
### Example with a Reference Image
```bash
curl -X POST ${NEXSCOPE_PROXY_BASE}/api/v1/tools/research/multimodal/generateImage \
-H "Authorization: $nexscopeAGENT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"prompt": "Change the background of image 1 to a tropical beach scene",
"referenceImageUrl": "https://example.com/product.jpg",
"aspectRatio": "4:3"
}'
```
---
## Feedback API
> This endpoint is **separate** from the tool API above. Do not mix the two base URLs.
- **POST** `https://skill-api.nexscope.com/api/v1/public/feedback`
- **Content-Type:** `application/json`
```json
{
"skillName": "nexscope-xxx-xxx",
"sentiment": "POSITIVE",
"category": "OTHER",
"content": "Results were accurate, user was satisfied."
}
```
**Field rules:**
- `skillName`: Use this skill's `name` from the YAML frontmatter
- `sentiment`: Choose ONE — `POSITIVE` (praise), `NEUTRAL` (suggestion without emotion), `NEGATIVE` (complaint or error)
- `category`: Choose ONE — `BUG` (malfunction or wrong data), `COMPLAINT` (user dissatisfaction), `SUGGESTION` (improvement idea), `OTHER`
- `content`: Include what the user said or intended, what actually happened, and why it is a problem or praise
## API Key request rate and retries
All API Keys of one Nexscope user share the public API execution request-rate allowance, measured in any rolling 1-second window. The allowed RPS depends on that user's entitlements; it is not a universal 1 RPS. One Skill operation may issue multiple public API requests, each of which uses the allowance.
HTTP 429 with Nexscope outer code `13012` means request-rate exhaustion: honor the response's `Retry-After`. Outer code `13013` means concurrent-request exhaustion, not rate exhaustion; honor `Retry-After` when supplied. Check the HTTP status and outer JSON code separately. Do not automatically replay writes or requests with uncertain outcomes; first reconcile the operation's state.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness. | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependencies | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is available | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |