Skip to content

Commit 3daeff9

Browse files
Lookoff-AIMLAPILookoff-AIMLAPI
authored
docs: add alibaba/qwen-image-3 (#440)
1 parent 5c25b26 commit 3daeff9

5 files changed

Lines changed: 338 additions & 1 deletion

File tree

‎docs/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,7 @@
361361
* [Wan2.7 Image Pro](api-references/image-models/alibaba-cloud/wan2.7-image-pro.md)
362362
* [Qwen Image 2.0](api-references/image-models/alibaba-cloud/qwen-image-2.0.md)
363363
* [Qwen Image 2.0 Pro](api-references/image-models/alibaba-cloud/qwen-image-2.0-pro.md)
364+
* [Qwen Image 3](api-references/image-models/Alibaba-Cloud/qwen-image-3.md)
364365
* [Beeble](api-references/image-models/Beeble/README.md)
365366
* [Switchx Image To Image](api-references/image-models/Beeble/switchx-image-to-image.md)
366367
* [ByteDance](api-references/image-models/bytedance/README.md)

‎docs/api-references/image-models/Alibaba-Cloud/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Alibaba Cloud
2+

‎docs/api-references/image-models/Alibaba-Cloud/qwen-image-3.json‎

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
{
2+
"openapi": "3.0.0",
3+
"info": {
4+
"title": "AIML API",
5+
"version": "1.0.0"
6+
},
7+
"servers": [
8+
{
9+
"url": "https://api.aimlapi.com"
10+
}
11+
],
12+
"paths": {
13+
"/v1/images/generations": {
14+
"post": {
15+
"operationId": "_v1_images_generations",
16+
"requestBody": {
17+
"required": true,
18+
"content": {
19+
"application/json": {
20+
"schema": {
21+
"type": "object",
22+
"properties": {
23+
"model": {
24+
"type": "string",
25+
"enum": [
26+
"alibaba/qwen-image-3"
27+
]
28+
},
29+
"prompt": {
30+
"type": "string",
31+
"maxLength": 800,
32+
"description": "The text prompt describing the content, style, or composition of the image to be generated."
33+
},
34+
"image_size": {
35+
"anyOf": [
36+
{
37+
"type": "object",
38+
"properties": {
39+
"width": {
40+
"type": "integer",
41+
"minimum": 384,
42+
"maximum": 2048,
43+
"default": 1024
44+
},
45+
"height": {
46+
"type": "integer",
47+
"minimum": 384,
48+
"maximum": 2048,
49+
"default": 1024
50+
}
51+
},
52+
"description": "For both height and width, the value must be a multiple of 32."
53+
},
54+
{
55+
"type": "string",
56+
"enum": [
57+
"square_hd",
58+
"square",
59+
"portrait_4_3",
60+
"portrait_16_9",
61+
"landscape_4_3",
62+
"landscape_16_9"
63+
],
64+
"description": "The size of the generated image."
65+
}
66+
],
67+
"default": "square_hd"
68+
},
69+
"negative_prompt": {
70+
"type": "string",
71+
"maxLength": 500,
72+
"description": "The description of elements to avoid in the generated image."
73+
},
74+
"num_images": {
75+
"type": "integer",
76+
"minimum": 1,
77+
"maximum": 4,
78+
"default": 1,
79+
"description": "The number of images to generate."
80+
},
81+
"output_format": {
82+
"type": "string",
83+
"enum": [
84+
"jpeg",
85+
"png",
86+
"webp"
87+
],
88+
"default": "png",
89+
"description": "The format of the generated image."
90+
},
91+
"seed": {
92+
"type": "integer",
93+
"minimum": 0,
94+
"maximum": 2147483647,
95+
"description": "The same seed and the same prompt given to the same version of the model will output the same image every time."
96+
},
97+
"enable_prompt_expansion": {
98+
"type": "boolean",
99+
"default": true,
100+
"description": "If set to True, prompt will be upsampled with more details."
101+
},
102+
"enable_safety_checker": {
103+
"type": "boolean",
104+
"default": true,
105+
"description": "If set to True, the safety checker will be enabled."
106+
}
107+
},
108+
"required": [
109+
"model",
110+
"prompt"
111+
],
112+
"title": "alibaba/qwen-image-3"
113+
}
114+
}
115+
}
116+
},
117+
"responses": {
118+
"200": {
119+
"content": {
120+
"application/json": {
121+
"schema": {
122+
"type": "object",
123+
"properties": {
124+
"data": {
125+
"type": "array",
126+
"nullable": true,
127+
"items": {
128+
"type": "object",
129+
"properties": {
130+
"url": {
131+
"type": "string",
132+
"nullable": true,
133+
"description": "The URL where the file can be downloaded from.",
134+
"example": "https://cdn.aimlapi.com/generations/hedgehog/1749730923700-29fe35d2-4aef-4bc5-a911-6c39884d16a8.png"
135+
},
136+
"b64_json": {
137+
"type": "string",
138+
"nullable": true,
139+
"description": "The base64-encoded JSON of the generated image.",
140+
"example": null
141+
}
142+
}
143+
},
144+
"description": "The list of generated images."
145+
},
146+
"meta": {
147+
"type": "object",
148+
"nullable": true,
149+
"properties": {
150+
"usage": {
151+
"type": "object",
152+
"nullable": true,
153+
"properties": {
154+
"credits_used": {
155+
"type": "number",
156+
"description": "The number of tokens consumed during generation.",
157+
"example": 120000
158+
},
159+
"usd_spent": {
160+
"type": "number",
161+
"description": "The total amount of money spent by the user in USD.",
162+
"example": 0.06
163+
}
164+
},
165+
"required": [
166+
"credits_used",
167+
"usd_spent"
168+
]
169+
}
170+
},
171+
"description": "Additional details about the generation."
172+
}
173+
}
174+
}
175+
}
176+
},
177+
"description": "Successful response."
178+
}
179+
},
180+
"x-hideTryItPanel": true,
181+
"x-codeSamples": [
182+
{
183+
"lang": "cURL",
184+
"source": "curl --request POST \\\n --url 'https://api.aimlapi.com/v1/images/generations' \\\n --header 'Authorization: Bearer <YOUR_AIMLAPI_KEY>' \\\n --header 'Content-Type: application/json' \\\n --data '{\"model\": \"alibaba/qwen-image-3\", \"prompt\": \"Describe what you want the model to generate.\"}'"
185+
},
186+
{
187+
"lang": "JavaScript",
188+
"source": "const response = await fetch('https://api.aimlapi.com/v1/images/generations', {\n method: 'POST',\n headers: {\n 'Authorization': 'Bearer <YOUR_AIMLAPI_KEY>',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({\n \"model\": \"alibaba/qwen-image-3\",\n \"prompt\": \"Describe what you want the model to generate.\"\n}),\n});\n\nconsole.log(await response.json());"
189+
},
190+
{
191+
"lang": "Python",
192+
"source": "import requests\n\nresponse = requests.post(\n \"https://api.aimlapi.com/v1/images/generations\",\n headers={\n \"Authorization\": \"Bearer <YOUR_AIMLAPI_KEY>\",\n \"Content-Type\": \"application/json\",\n },\n json={'model': 'alibaba/qwen-image-3', 'prompt': 'Describe what you want the model to generate.'},\n)\n\nprint(response.json())"
193+
}
194+
]
195+
}
196+
}
197+
},
198+
"components": {
199+
"securitySchemes": {
200+
"access-token": {
201+
"scheme": "bearer",
202+
"bearerFormat": "<YOUR_AIMLAPI_KEY>",
203+
"type": "http",
204+
"description": "Bearer key"
205+
}
206+
}
207+
}
208+
}

‎docs/api-references/image-models/Alibaba-Cloud/qwen-image-3.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Qwen Image 3
2+
3+
{% columns %}
4+
{% column width="66.66666666666666%" %}
5+
{% hint style="info" %}
6+
This documentation is valid for the following list of our models:
7+
8+
* `alibaba/qwen-image-3`
9+
{% endhint %}
10+
{% endcolumn %}
11+
12+
{% column width="33.33333333333334%" %}
13+
<a href="https://aimlapi.com/app/alibaba/qwen-image-3" class="button primary">Try in Playground</a>
14+
{% endcolumn %}
15+
{% endcolumns %}
16+
17+
## Model Overview
18+
19+
Qwen Image 3 text-to-image model with strong Chinese and English text rendering and automatic prompt expansion.
20+
21+
{% hint style="success" %}
22+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
23+
{% endhint %}
24+
25+
<details>
26+
27+
<summary>How to make the first API call</summary>
28+
29+
**1️⃣ Required setup (don’t skip this)**\
30+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
31+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
32+
33+
**2️ Copy the code example**\
34+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
35+
36+
**3️ Update the snippet for your use case**\
37+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
38+
▪ **Select a model:** set the `model` field to the model you want to call.\
39+
▪ **Provide input:** fill in the request input field(s) shown in the example.
40+
41+
**4️ (Optional) Tune the request**\
42+
See the API schema below for optional generation settings.
43+
44+
**5️ Run your code**\
45+
Run the updated code in your development environment.
46+
47+
{% hint style="success" %}
48+
For a detailed walkthrough, use our [Quickstart guide](https://docs.aimlapi.com/quickstart/setting-up).
49+
{% endhint %}
50+
51+
</details>
52+
53+
## API Schema
54+
55+
{% openapi-operation spec="qwen-image-3" path="/v1/images/generations" method="post" %}
56+
[OpenAPI qwen-image-3](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/image-models/Alibaba-Cloud/qwen-image-3.json)
57+
{% endopenapi-operation %}
58+
59+
## Code Example
60+
61+
{% tabs %}
62+
{% tab title="Python" %}
63+
{% code overflow="wrap" %}
64+
```python
65+
import requests
66+
67+
response = requests.post(
68+
"https://api.aimlapi.com/v1/images/generations",
69+
headers={
70+
"Authorization": "Bearer <YOUR_AIMLAPI_KEY>",
71+
"Content-Type": "application/json",
72+
},
73+
json={'model': 'alibaba/qwen-image-3', 'prompt': 'Describe what you want the model to generate.'},
74+
)
75+
76+
print(response.json())
77+
```
78+
{% endcode %}
79+
{% endtab %}
80+
81+
{% tab title="JavaScript" %}
82+
{% code overflow="wrap" %}
83+
```javascript
84+
const response = await fetch('https://api.aimlapi.com/v1/images/generations', {
85+
method: 'POST',
86+
headers: {
87+
'Authorization': 'Bearer <YOUR_AIMLAPI_KEY>',
88+
'Content-Type': 'application/json',
89+
},
90+
body: JSON.stringify({
91+
"model": "alibaba/qwen-image-3",
92+
"prompt": "Describe what you want the model to generate."
93+
}),
94+
});
95+
96+
console.log(await response.json());
97+
```
98+
{% endcode %}
99+
{% endtab %}
100+
{% endtabs %}
101+
102+
<details>
103+
104+
<summary>Response</summary>
105+
106+
{% code overflow="wrap" %}
107+
```json
108+
{
109+
"data": [
110+
{
111+
"url": "https://cdn.aimlapi.com/generations/hedgehog/1749730923700-29fe35d2-4aef-4bc5-a911-6c39884d16a8.png",
112+
"b64_json": null
113+
}
114+
],
115+
"meta": {
116+
"usage": {
117+
"credits_used": 120000,
118+
"usd_spent": 0.06
119+
}
120+
},
121+
"model": "alibaba/qwen-image-3"
122+
}
123+
```
124+
{% endcode %}
125+
126+
</details>

0 commit comments

Comments
 (0)