Quick Start

Use this guide to get oriented and make your first Muapi request.

1. Create an account and API key

Create an account at muapi.ai, then create an API key from your dashboard. Keep the key private. For development, use a sandbox key when the model supports sandbox responses; see Authentication for key types and details.

2. Choose a model

Browse the model catalog or the Playground. Check the model page for its current endpoint, required inputs, supported options, and price. Model names and parameters change as the catalog evolves, so avoid copying an old model ID from an unrelated example.

3. Submit a request

Muapi's generation endpoints generally use an asynchronous submit-and-poll pattern:

  1. Send a POST request to the model's endpoint with your API key and model-specific JSON body.
  2. Save the returned request_id.
  3. Poll GET /api/v1/predictions/{request_id}/result until the task completes or fails.

The API Reference explains the common request and response shape. For the exact endpoint and parameters, use the selected model's documentation in the Playground.

4. Choose how you want to integrate

5. Handle results and costs

Generation tasks can take time. Poll the result endpoint or configure a webhook to receive completion notifications. Review Pricing and Credits to understand charges and track usage.

Next steps