Masterpiece X SDK Setup

The Masterpiecex SDK provides convenient access to the Masterpiecex REST API from any Python 3.8+ or Nodejs application. The library includes type definitions for all request params and response fields, and offers both synchronous and asynchronous clients powered by httpx.

Installation

The SDK can be installed directly from package managers like pipy (python) or npm (nodejs)

pip install mpx-genai-sdk

npm install mpx-genai-sdk

Client Initialization and Connection Testing

To use the SDK, first initialize the client. Note that you can set your API KEY to the MPX_SDK_BEARER_TOKEN = <your api key> environment variable, or set it directly in code.

import os
from mpx_genai_sdk import Masterpiecex

client = Masterpiecex() # assuming the MPX_SDK_BEARER_TOKEN is set in your environment
# client = Masterpiecex(bearer_token=<Your API Key>) # only needed if environment var not set
# While you can provide a bearer_token keyword argument, we recommend using python-dotenv to add
# MPX_SDK_BEARER_TOKEN="My API Key" to your .env file so that your API_KEY
# is not stored in source control.

# Test the connection and authentication
connection_test = client.connection_test.retrieve()
print(connection_test)

import Masterpiecex from 'mpx-genai-sdk';
// use this if `MPX_SDK_BEARER_TOKEN = <Your API Key>` is set in the environment - recommended
const client = new Masterpiecex();

// use the following to inject the API Key directly - 
// const client = new Masterpiecex({
//  bearerToken: <Your API Key>
// });

async function main() {
  const connectionTest = await client.connectionTest.retrieve();
  console.log(connectionTest);
}

main();

Returns

200: Welcome to Masterpiece X!

📘
Please note in the examples that follow, we assume you have provided your API Key as an environment variable, either using a properly loaded .env file or through a server secret.
If you do not use an environment variable, simply provide the API Key when creating the client as the bearer_token parameter.

MPX_SDK_BEARER_TOKEN = <your API Key>

client = Masterpiecex(bearer_token=<Your API Key>)

client = Masterpiecex({bearerToken: <Your API Key>});

Getting the Output

Most calls are asynchronous. You will be given a requestId to identify your request. Use this id to poll for the current status using the client.status.retrieve(requestid) function.