Skip to content

Commit 6c78ebe

Browse files
Lookoff-AIMLAPILookoff-AIMLAPI
authored
docs: add meta/muse-image (#506)
1 parent 5b17882 commit 6c78ebe

5 files changed

Lines changed: 297 additions & 1 deletion

File tree

‎docs/SUMMARY.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,8 @@
442442
* [Luma AI](api-references/image-models/Luma-AI/README.md)
443443
* [Luma Uni-1](api-references/image-models/Luma-AI/uni-1.md)
444444
* [Luma Uni-1 Max](api-references/image-models/Luma-AI/uni-1-max.md)
445+
* [meta](api-references/image-models/meta/README.md)
446+
* [Meta Muse Image](api-references/image-models/meta/muse-image.md)
445447
* [OpenAI](api-references/image-models/OpenAI/README.md)
446448
* [DALL·E 2](api-references/image-models/OpenAI/dall-e-2.md)
447449
* [DALL·E 3](api-references/image-models/OpenAI/dall-e-3.md)

‎docs/api-references/image-models/meta/README.md‎

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

‎docs/api-references/image-models/meta/muse-image.json‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
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+
"meta/muse-image"
27+
]
28+
},
29+
"prompt": {
30+
"type": "string",
31+
"description": "The text prompt describing the content, style, or composition of the image to be generated."
32+
},
33+
"num_images": {
34+
"type": "number",
35+
"minimum": 1,
36+
"maximum": 10,
37+
"default": 1,
38+
"description": "The number of images to generate."
39+
},
40+
"aspect_ratio": {
41+
"type": "string",
42+
"enum": [
43+
"21:9",
44+
"16:9",
45+
"4:3",
46+
"3:2",
47+
"1:1",
48+
"2:3",
49+
"3:4",
50+
"9:16",
51+
"9:21"
52+
],
53+
"description": "The aspect ratio of the generated image. If omitted, Muse chooses the output dimensions automatically based on the prompt."
54+
},
55+
"output_format": {
56+
"type": "string",
57+
"enum": [
58+
"jpeg",
59+
"png",
60+
"webp"
61+
],
62+
"default": "webp",
63+
"description": "The format of the generated image."
64+
}
65+
},
66+
"required": [
67+
"model",
68+
"prompt"
69+
],
70+
"title": "meta/muse-image"
71+
}
72+
}
73+
}
74+
},
75+
"responses": {
76+
"200": {
77+
"content": {
78+
"application/json": {
79+
"schema": {
80+
"type": "object",
81+
"properties": {
82+
"data": {
83+
"type": "array",
84+
"nullable": true,
85+
"items": {
86+
"type": "object",
87+
"properties": {
88+
"url": {
89+
"type": "string",
90+
"nullable": true,
91+
"description": "The URL where the file can be downloaded from.",
92+
"example": "https://cdn.aimlapi.com/generations/hedgehog/1749730923700-29fe35d2-4aef-4bc5-a911-6c39884d16a8.png"
93+
},
94+
"b64_json": {
95+
"type": "string",
96+
"nullable": true,
97+
"description": "The base64-encoded JSON of the generated image.",
98+
"example": null
99+
}
100+
}
101+
},
102+
"description": "The list of generated images."
103+
},
104+
"meta": {
105+
"type": "object",
106+
"nullable": true,
107+
"properties": {
108+
"usage": {
109+
"type": "object",
110+
"nullable": true,
111+
"properties": {
112+
"credits_used": {
113+
"type": "number",
114+
"description": "The number of tokens consumed during generation.",
115+
"example": 120000
116+
},
117+
"usd_spent": {
118+
"type": "number",
119+
"description": "The total amount of money spent by the user in USD.",
120+
"example": 0.06
121+
}
122+
},
123+
"required": [
124+
"credits_used",
125+
"usd_spent"
126+
]
127+
}
128+
},
129+
"description": "Additional details about the generation."
130+
}
131+
}
132+
}
133+
}
134+
},
135+
"description": "Successful response."
136+
}
137+
},
138+
"x-hideTryItPanel": true,
139+
"x-codeSamples": [
140+
{
141+
"lang": "cURL",
142+
"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\": \"meta/muse-image\", \"prompt\": \"Describe what you want the model to generate.\"}'"
143+
},
144+
{
145+
"lang": "JavaScript",
146+
"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\": \"meta/muse-image\",\n \"prompt\": \"Describe what you want the model to generate.\"\n}),\n});\n\nconsole.log(await response.json());"
147+
},
148+
{
149+
"lang": "Python",
150+
"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': 'meta/muse-image', 'prompt': 'Describe what you want the model to generate.'},\n)\n\nprint(response.json())"
151+
}
152+
]
153+
}
154+
}
155+
},
156+
"components": {
157+
"securitySchemes": {
158+
"access-token": {
159+
"scheme": "bearer",
160+
"bearerFormat": "<YOUR_AIMLAPI_KEY>",
161+
"type": "http",
162+
"description": "Bearer key"
163+
}
164+
}
165+
}
166+
}

‎docs/api-references/image-models/meta/muse-image.md‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Meta Muse Image
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+
* `meta/muse-image`
9+
{% endhint %}
10+
{% endcolumn %}
11+
12+
{% column width="33.33333333333334%" %}
13+
<a href="https://aimlapi.com/app/meta/muse-image" class="button primary">Try in Playground</a>
14+
{% endcolumn %}
15+
{% endcolumns %}
16+
17+
## Model Overview
18+
19+
Meta Muse Image is a text-to-image model with faithful instruction-following and exceptional visual fidelity — fine details like text, plots, and QR codes render accurately.
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="muse-image" path="/v1/images/generations" method="post" %}
56+
[OpenAPI muse-image](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/image-models/meta/muse-image.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': 'meta/muse-image', '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": "meta/muse-image",
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": "meta/muse-image"
122+
}
123+
```
124+
{% endcode %}
125+
126+
</details>

0 commit comments

Comments
 (0)