API Details

1. What programming languages and frameworks are supported by ShapeDiver's APIs?

ShapeDiver provides SDKs for JavaScript (TypeScript), .NET, Python, and PHP,  allowing integration with various frameworks. On top of these SDKs, we also provide an OpenAPI specification of our APIs, allowing SDKs to be auto-generated for further languages.

2. Are SDKs or code examples available to help with API integration?

Yes, SDKs and code examples are available.
- 3D Viewer: https://help.shapediver.com/doc/viewer
- APIs and SDKs: https://help.shapediver.com/doc/apis-and-sdks
- GitHub: https://github.com/shapediver

3. Is there a rate limit on API usage, and how does it affect my application?

Depending on the plan you are subscribed to, your account is given a certain computation priority. If the overall rate of computation requests exceeds the current capacity of the ShapeDiver backend system you are using, requests will be prioritized according to this computation priority and rate limited. Typically, this is the case for a short time only because the backend system scales up and down according to demand. Most of our SDKs handle the rate-limiting reply for you.  

Can I integrate ShapeDiver into my backend without using the default viewer (headless integration)?

Yes, you can interact with ShapeDiver directly using our Geometry Backend API. Read more about it here.

What is the Viewer API, and what can I use it for?

The Viewer API allows you to control and customize the 3D viewer embedded in your applications. Read more about it here.

What other APIs are available?

You can use the Geometry API to perform the same kind of actions as our 3D viewer. The Platform API allows you to interact with your account on the ShapeDiver platform. Find more information about these APIs here.

What is the Platform API, and what can I use it for?

The Platform API allows you to programmatically manage models, users, and other resources. Read more about it here.