To get started using the Metafold REST API you must have received an invitation to create an account on the Metafold platform. Please contact info@metafold3d.com if you have a business need that you think we can help with.

Client Libraries

We currently have client libraries for Python and Node.js that make interacting with the Metafold REST API much simpler.

Language Source
Python metafold-python
Node.js metafold-node

We recommend using one of these libraries to stay up-to-date with API changes and conveniently handle authentication.

Manual

You are otherwise free to make API requests in your HTTP client of choice, ensuring the following:

  • Parameters for GET requests are encoded as a query string in the URL, e.g. https://api.metafold3d.com/projects/1/assets/1?download=true
  • Parameters for POST/PATCH/PUT requests are encoded in the request body as application/json, or multipart/form-data for endpoints that receive file data.

You are also required to include an Authorization header in your request. This is typically handled for you by one of our client libraries. For more details please see Authentication.