Welcome to infrared.city Docs

New Python SDK

The recommended way to run Infrared analyses is now the Python SDK. The Developer's Guide and API Reference below describe a legacy REST workflow and are no longer maintained.

This resource contains information and user guides regarding Infrared.city's:

• Python SDK — infrared.city/docs/sdk/ (recommended)
• Developer's Guide (deprecated) — legacy REST workflow guide
• API Reference (deprecated) — legacy v1 REST endpoints
• Connectors — Rhino, Grasshopper, and Revit plugins

Getting Started

Make sure you have an active Infrared.city account. Check out this step by step tutorial for more information.

API users

info

NOTE: In order to have access to our API you will need to have a Pro account.

After your Pro account is active you can create and manage your API Key from your account page.

Note that this action is available only from the account Admin.