Integrate API
The Integrate API provides a mechanism to store representations (e.g. geometry) from outside Forma itself. It can then be retrieved by other systems through the Element API and used in the product.
These APIs are accessible to your backend service with the two-legged token explained in the auth section.
Creating an element using the Integrate API
The API exposes endpoints to create and update individual elements as separate requests, or create and update multiple elements in a batch as a single request:
To store a large or binary representation, you need to upload it separately first:
This will give you a blobId, which you can refer to when creating/updating an element.
Example of body payload to create an element with a volume mesh representation (which must reference a valid uploaded GLB file):
{
"representations": {
"volumeMesh": {
"type": "linked",
"blobId": "<blobId-from-upload>"
}
}
}
Refer to the Forma Element Specification for further details about representations and data in elements.
The element reference (URN) retrieved after creating an element can then be used to add this element to the proposal, reference it from other elements, store in library, etc.