CSM.AI Documentation

How to get the API key?

Go to your profile page on 3d.csm.ai (opens in a new tab) and generate your API key.

We have Python pip package as well as REST APIs.

Python Package

The python package and the documentation can be accessed at python-docs.csm.ai (opens in a new tab)

pip install csm-ai

Here's a quick example for image-to-3D and text-to-3D: Quick Start (opens in a new tab)

How to use the API key with REST APIs?

Our base URL is - https://api.csm.ai/ (opens in a new tab)

You can use the API key in the header of the request as shown below:

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

Webhooks

We support webhooks for Image-To-3d. You can set up a webhook URL in your profile page on 3d.csm.ai (opens in a new tab) We expect a url that accept a POST request and the body of the request will be a JSON object with the following fields:

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

The response to the post request should have HTTP status code 200. You can read more about in the webhooks (opens in a new tab) section.

How do credits work

Whenever a user signs up, they get 100 free credits.

You can utilise credits across mutiple services provided by CSM.AI. Each service has a different credit cost.

You can check the credit cost of each service on the plans page (opens in a new tab)

Do credits expire?

No, credits do not expire.

How to get more credits?

Each paid subscription awards different credits per month.

Maker - 100 credits per month

Creative Pro - 400 credits per month

If you require additional generations per month beyond your subscription, you can either upgrade to the next tier or you can purchase extra for $0.20/credit.

Once you use all credits on Maker and Creative Pro tiers, then you revert back to Tinkerer.

Can I have a refund.

Unfortunately, we do not offer refunds for credits and subscriptions. We request you to do a thorough evaluation before making a purchase, as once a transaction is complete, we can't reverse it.

Can I cancel my subscription plan?

You can cancel your subscription anytime, but the cancellation tasks take effect at the end of the current billing cycle.

Can I upgrade my subscription 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 are on Creative Pro tier, then all the assets generated durng the subscription period are owned by you. Otherwise we grant you a CC by 4.0 (opens in a new tab) license.

How to check the remaining credits?

You can check the remaining credits by going to the profile page on 3d.csm.ai (opens in a new tab) as well as on the homepage.