Getting Started

This is the Beta 2 version of Masterpiece X - Generate API. Please note that the specifications of this API are beta and subject to change or deprecation at any time.

To get started,

Visit https://developers.masterpiecex.com to create an account.
Create an app and get your API KEY at https://developers.masterpiecex.com/apps
Note that you can also use our SDKs to access the API in your code. First install the package

   pip install mpx-genai-sdk

npm install mpx-genai-sdk

Use the Test Connection endpoint to ensure that your API KEY is valid and that you can connect to the API.
Purchase some Generation Credits here to get started generating!

Usage

It probably goes without saying, but API keys are meant to ONLY be used for server-to-server communications over https. It is forbidden to use them from a frontend/web page directly because they are insecure and can be easily stolen by others that can then spend your Generation Credits for themselves. You are totally responsible for charges incurred by use of your API key, so keep it safe!
Using the API is subject to our Terms of Service. By using the API, you have indicated that you have read and agree to the Terms of Service.
The API is subject to quotas and rate limits. See below for details.
The API is subject to charges. See below for details.

Pricing

Pay As You Go

The Masterpiece X - Generate API is a pay-as-you-go service. You are only charged for the number of functions or components requests you make. Status, Create Asset and Test Connection requests are not subject to charges. There are no monthly fees or subscriptions. We may introduce subscriptions in the future for high volume users. You can purchase generation credits at any time from the Purchase Page.

Credits

Current costs:

each Generate request is fixed at 50 credits per generate request.
Components are currently 20 credits each.
LLM calls are currently 5 credits each.

Note that this is subject to change in the future.

The GET /status and POST /assets/create endpoints are not subject to charges, but are subject to quotas.

If a request fails, you will be refunded the credits for that request.

Quotas

Quotas and Rate limits for API usage are subject to change at any time. Please check back here for the latest information.

Generation Quotas

Currently, the POST Generate and Components endpoints are subject to the following rate limits:

max 8 generation or components per minute

Status Quotas

The GET /status endpoint is subject to the following rate limits:

12 requests per minute (eg. min 5 seconds between requests)