Request

Response

    API Basics

    The Informed Design API is designed to be flexible and extensible, allowing developers to create custom workflows and integrate with other systems as needed. The concepts outlined in this section provide a foundation for understanding how the API works and how to leverage its capabilities effectively. By familiarizing themselves with these concepts, developers can better navigate the API and create powerful applications that meet their specific needs.

    As you explore the API, keep these concepts in mind, as they will help you understand the relationships between different elements and how to effectively use the API to achieve your goals.

    Key Concept Terminology

    ConceptDescription
    Product
    Represents the starting point for the Informed Design API.
    A product entity specifies meta information about an Informed Product

    Release
    A release is a specific version of a Product.
    It contains the design data, parameter definitions, rules and output settings/ options that are used to generate design output.

    Rules define the bounds, constraints and conditions of parameters that must be met for a Variant to be valid.
    For example, a rule might specify that a door cannot be wider than a certain size or that it must have a specific color.

    Variant
    A variant represents a variation of the Release of a Product.
    It defines a set of custom parameters that are used to generate design output.

    For example, a door with a specific size and color.
    A Variant is created by specifying the parameters and their values, which are then validated against the rules defined for the Product.

    Output
    An output is a design output that is generated based on the parameters defined in a Variant.
    It can be a 2D or 3D representation of the design, such as a drawing, model, Revit Family, or Thumbnail.

    Upload
    An upload allows users to upload the generated output to a specified location in the cloud - BIM360 or Forma.

    Element Flow

    The steps below outlines a typical workflow for using the Informed Design API.

    1. Create a Product: Use POST products to create a new Product. This is the starting point for the Informed Design API.
    2. Create a Release: Use POST releases to create a new Release - a version of the Product.
      • Upload Files for Release:
        1. Use POST get upload urls to obtain a list of URLs for uploading files.
        2. Upload the design data and Rules to the provided URLs. The design data is the Inventor model or part file containing the design data and parameter definitions. The Rules are defined using blockly code blocks, which specify the bounds, constraints, and conditions that must be met for a Variant to be valid.
        3. Use POST complete upload to mark the upload as complete.
    3. Create a Variant: Use POST variants to create a new Variant of a Release.
    4. Create Outputs: Use POST outputs to generate design outputs for the variant which was previously created.
      • Waiting for Completion: Output generation could take couple of minutes, you can leverage the callback (onProgress/ onComplete) moption to get notified on status changes and completion.
    5. Upload Outputs: Use POST uploads to upload outputs to a specific location.
      • Output upload can take couple of minutes, you can leverage the callback (onProgress/ onComplete) option to get notified on status changes and completion.
    6. Download Outputs: Use GET download urls to get the download URLs (short-lived) for the generated outputs.

      Note

      The download URLs are valid for 5 minutes and can be used to download the outputs to your local drive. Ensure you download them promptly to avoid expiration.