Cube by CSM

Cube by CSM Documentation

Getting Started:

Obtaining an API Key

Log in and navigate to your user profile on the CSM Webapp (opens in a new tab) to generate an API key that we will use to make API requests.

We have a Python PIP package as well as REST API endpoints available for your integration.

Python Package

To use the CSM AI Python package, you can install it using PIP.

The documentation for this package can be found at python-docs.csm.ai (opens in a new tab)

pip install csm-ai

Follow along with the PIP package Quick Start (opens in a new tab) guide to get started.

REST API

All requests will be sent to the base URL https://api.csm.ai/, and you will need to include your API key in the header of each request for authentication purposes.

headers = {
  'x-api-key': USER_API_KEY,
}

Additional Features:

Webhooks

Webhooks for real-time notifications are supported for Image To 3D sessions. To set up a webhook for your Image To 3D jobs, visit the My Profile (opens in a new tab) page on the CSM Webapp.

The expected endpoint is a URL that accepts a POST request with a JSON object in the body. The JSON object should have the following fields:

{
  "type": "type of event",
  "payload": {
    // payload of the event
  }
}

Your endpoint should respond with a 200 status code to indicate that the webhook was received successfully. For more details, visit the webhooks (opens in a new tab) section of the documentation.

Credits

New users automatically receive 1 free credit upon signup. Credits are universal and can be used for all CSM services. You can check the credit cost of each service on the plans page (opens in a new tab).

Credits FAQ

  • Do credits expire?
    No, credits do not expire.

  • How do I get more credits?
    Each paid subscription plan comes with a certain number of credits, refilled at the beginning of every month.

    Maker - 100 credits per month
    Creative Pro - 400 credits per month

    Credits can be purchased on an as-needed basis for $0.20 USD per credit. Once you use all credits on Maker and Creative Pro tiers, you revert back to Tinkerer.

    To purchase additional credits or upgrade your subscription, visit the plans page (opens in a new tab) on the CSM Webapp.

  • What is the refund policy on unused credits?
    Unfortunately, we do not offer refunds for credits or subscriptions. Please perform a thorough evaluation before making a purchase, as transactions are irreversible once complete.

  • Can I cancel my plan?
    You can cancel your subscription anytime. Your account will remain on the same tier until the end of the month, at which point it will revert to Tinkerer (free).

  • Can I upgrade my plan?
    You are free to upgrade your subscription at any time, and the changes will take effect immediately.

  • What are the licenses on the assets generated?
    If you're on the Creative Pro tier, you retain full ownership of all assets generated during your subscription period. For other tiers, assets are provided under a CC BY 4.0 license (opens in a new tab).

  • Where can I check my remaining credits?
    You can check your account's remaining credits by going to your profile page on the CSM Webapp (opens in a new tab).

0 Quick Primer