fix(design): document MuAPI model contracts

This commit is contained in:
Anil-matcha 2026-08-30 07:53:09 +05:30
parent 0720614e6e
commit e7e873dada
6 changed files with 32 additions and 20 deletions

View File

@ -314,9 +314,12 @@ export MUAPI_API_KEY="your-key"
MuAPI uses the asynchronous model endpoint and prediction result API. See the
[MuAPI API reference](https://muapi.ai/docs/api-reference) for authentication
and current model contracts. The logo generator currently supports the
`nano-banana` and `nano-banana-pro` model slugs, and sends only the shared
`prompt` and `aspect_ratio` fields.
and the [nano-banana model contract](https://api.muapi.ai/api/v1/models/nano-banana)
or [nano-banana-pro model contract](https://api.muapi.ai/api/v1/models/nano-banana-pro)
for the current model-specific schemas. The logo generator supports both documented
model slugs and sends their shared required `prompt` plus optional `aspect_ratio`
fields; the Pro model also accepts an optional `resolution` field that this focused
logo workflow leaves at the provider default.
> **Note for Windows:** Use `python` instead of `pip` where needed (e.g., `python -m pip install ...`).

View File

@ -102,6 +102,9 @@ export MUAPI_API_KEY="your-key"
MuAPI uses the asynchronous model endpoint and prediction result API. See the
[MuAPI API reference](https://muapi.ai/docs/api-reference) for authentication
and current model contracts. The logo generator currently supports the
`nano-banana` and `nano-banana-pro` model slugs, and sends only the shared
`prompt` and `aspect_ratio` fields.
and the [nano-banana model contract](https://api.muapi.ai/api/v1/models/nano-banana)
or [nano-banana-pro model contract](https://api.muapi.ai/api/v1/models/nano-banana-pro)
for the current model-specific schemas. The logo generator supports both documented
model slugs and sends their shared required `prompt` plus optional `aspect_ratio`
fields; the Pro model also accepts an optional `resolution` field that this focused
logo workflow leaves at the provider default.

View File

@ -136,12 +136,12 @@ class MuapiGenerationTests(unittest.TestCase):
self, json_request, sleep, download
):
json_request.side_effect = [
{"request_id": "req-123"},
{"request_id": "req-123", "status": "processing"},
{"id": "req-123", "status": "created"},
{"id": "req-123", "status": "processing"},
{
"request_id": "req-123",
"id": "req-123",
"status": "completed",
"outputs": ["https://media.example.com/logo.png"],
"output": {"outputs": ["https://media.example.com/logo.png"]},
},
]

View File

@ -314,9 +314,12 @@ export MUAPI_API_KEY="your-key"
MuAPI uses the asynchronous model endpoint and prediction result API. See the
[MuAPI API reference](https://muapi.ai/docs/api-reference) for authentication
and current model contracts. The logo generator currently supports the
`nano-banana` and `nano-banana-pro` model slugs, and sends only the shared
`prompt` and `aspect_ratio` fields.
and the [nano-banana model contract](https://api.muapi.ai/api/v1/models/nano-banana)
or [nano-banana-pro model contract](https://api.muapi.ai/api/v1/models/nano-banana-pro)
for the current model-specific schemas. The logo generator supports both documented
model slugs and sends their shared required `prompt` plus optional `aspect_ratio`
fields; the Pro model also accepts an optional `resolution` field that this focused
logo workflow leaves at the provider default.
> **Note for Windows:** Use `python` instead of `pip` where needed (e.g., `python -m pip install ...`).

View File

@ -102,6 +102,9 @@ export MUAPI_API_KEY="your-key"
MuAPI uses the asynchronous model endpoint and prediction result API. See the
[MuAPI API reference](https://muapi.ai/docs/api-reference) for authentication
and current model contracts. The logo generator currently supports the
`nano-banana` and `nano-banana-pro` model slugs, and sends only the shared
`prompt` and `aspect_ratio` fields.
and the [nano-banana model contract](https://api.muapi.ai/api/v1/models/nano-banana)
or [nano-banana-pro model contract](https://api.muapi.ai/api/v1/models/nano-banana-pro)
for the current model-specific schemas. The logo generator supports both documented
model slugs and sends their shared required `prompt` plus optional `aspect_ratio`
fields; the Pro model also accepts an optional `resolution` field that this focused
logo workflow leaves at the provider default.

View File

@ -136,12 +136,12 @@ class MuapiGenerationTests(unittest.TestCase):
self, json_request, sleep, download
):
json_request.side_effect = [
{"request_id": "req-123"},
{"request_id": "req-123", "status": "processing"},
{"id": "req-123", "status": "created"},
{"id": "req-123", "status": "processing"},
{
"request_id": "req-123",
"id": "req-123",
"status": "completed",
"outputs": ["https://media.example.com/logo.png"],
"output": {"outputs": ["https://media.example.com/logo.png"]},
},
]