--- canonical_url: "https://docs.composio.dev/toolkits/muapi" markdown_url: "https://docs.composio.dev/toolkits/muapi.md" product: "platform" version: null last_updated: null --- # MuAPI Generate images and discover supported models through MuAPI's OpenAI-compatible API. - **Category:** artificial intelligence - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 6 - **Triggers:** 0 - **Slug:** `MUAPI` - **Version:** 20261013_00 ## Tools ### Estimate Model Cost **Slug:** `MUAPI_ESTIMATE_MODEL_COST` Price a native catalog model run before submitting it. Returns the estimated charge for the given inputs, which is what to check when a model has dynamic pricing. Estimating is free and generates nothing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `inputs` | object | No | The generation inputs to price, using the model's own field names. Read input_schema from MUAPI_GET_CATALOG_MODEL to learn them. Fields the model's pricing depends on must be present: flux-schnell prices on num_images, so omitting it fails with COST_CALC_FAILED. | | `model_name` | string | Yes | Catalog model name, as returned in the name field of MUAPI_LIST_CATALOG_MODELS. Ids from MUAPI_LIST_MODELS belong to the separate OpenAI-compatible surface and are not accepted here. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Generate Image **Slug:** `MUAPI_GENERATE_IMAGE` Generate one or more images from a text prompt through MuAPI's OpenAI-compatible API. This operation is billable and requires sufficient account credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `size` | string | No | Requested image dimensions in WIDTHxHEIGHT form; support varies by model. | | `model` | string | No | MuAPI model ID to use. Call MUAPI_LIST_MODELS to discover available IDs. | | `prompt` | string | Yes | Text description of the image or images to generate. | | `image_count` | integer | No | Number of images to request. MuAPI does not publish a supported range. | | `response_format` | string | No | Provider response format. Only the default value, url, is verified by the contract. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account Balance **Slug:** `MUAPI_GET_ACCOUNT_BALANCE` Read the connected MuAPI account's current credit balance, currency, wallet breakdowns, and web-safety state. Use this before submitting a billable job. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Catalog Model **Slug:** `MUAPI_GET_CATALOG_MODEL` Get one native catalog model by name, including its pricing and the provider-defined input and output schemas. Read this before estimating a cost or building a generation request so the input field names and ranges come from the provider rather than a guess. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `model_name` | string | Yes | Catalog model name, as returned in the name field of MUAPI_LIST_CATALOG_MODELS. Ids from MUAPI_LIST_MODELS belong to the separate OpenAI-compatible surface and are not accepted here. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Catalog Models **Slug:** `MUAPI_LIST_CATALOG_MODELS` Browse MuAPI's full native model catalog with per-model pricing, category, family and group. This is the catalog behind MuAPI's native generation endpoints and is much larger than the OpenAI-compatible image model list returned by MUAPI_LIST_MODELS; the two id sets are not interchangeable. The unfiltered catalog is several hundred models and returns a large payload, so pass category, family or group_of whenever you can narrow the search. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `family` | string | No | Filter to one model family, such as 'flux' or 'lipsync'. | | `category` | string | No | Filter to one catalog category. Observed values include 'Text to Image', 'Image to Image', 'Text to Video', 'Image to Video', 'Audio to Video', 'Video to Video', 'Text to Audio', 'Text to Text', 'Text to 3D', 'Image to 3D', 'Lora Support', 'Training' and 'other'. An unknown value returns an empty list rather than an error. | | `group_of` | string | No | Filter to one model group, such as 'image' or 'avatar'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Models **Slug:** `MUAPI_LIST_MODELS` Return the image-generation models available through MuAPI's OpenAI-compatible API. Use each model's id in MUAPI_GENERATE_IMAGE requests. This is a small subset of MuAPI's native catalog and carries no pricing; for the full catalog with costs and input schemas use MUAPI_LIST_CATALOG_MODELS. The two id sets are not interchangeable. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |