Endpoint Catalog

This page lists currently implemented route paths by domain and points to the curated interactive pages in this docs set. Paths below are relative to the selected API base. The original origin retains standard solar runs; maintained plant and hybrid workflows use /v2. See API Reference for server selection. Source-file imports for native solar preparation use POST /v2/projects/import, and native studies require the explicit hybrid selector on submission and rerun.

System

Method	Path	Notes
`GET`	`/health`	Service health status (DB, queue, monitoring).

Auth

Method	Path	Notes
`POST`	`/auth/token`	Exchange workspace/user API keys for JWT. Try it
`GET`	`/auth/workspaces`	List workspaces for Supabase-authenticated user. Try it
`POST`	`/auth/exchange-supabase`	Exchange Supabase token for Daly JWT. Try it

Users and Workspaces

Method	Path	Notes
`POST`	`/users`	Create user (returns plaintext API key once).
`GET`	`/users/workspaces`	List workspaces for current user.
`GET`	`/workspaces`	List workspaces visible in current context.
`POST`	`/workspaces`	Create workspace (returns plaintext API key once).
`GET`	`/workspaces/{workspace_id}`	Get workspace metadata.
`PUT`	`/workspaces/{workspace_id}`	Update workspace metadata.
`DELETE`	`/workspaces/{workspace_id}`	Delete workspace.
`GET`	`/workspaces/{workspace_id}/users`	List workspace users.
`GET`	`/workspaces/{workspace_id}/settings`	Get workspace settings. Try it
`PUT`	`/workspaces/{workspace_id}/settings`	Replace workspace settings.
`PATCH`	`/workspaces/{workspace_id}/settings`	Deep-merge patch workspace settings. Try it

Organizations

Method	Path	Notes
`GET`	`/organizations/{organization_id}`	Get organization.
`PATCH`	`/organizations/{organization_id}`	Update organization metadata.
`GET`	`/organizations/{organization_id}/users`	List organization users.
`PATCH`	`/organizations/{organization_id}/users/{user_id}`	Update org user role.
`GET`	`/organizations/{organization_id}/workspaces`	List org workspaces.
`POST`	`/organizations/{organization_id}/workspaces`	Create workspace in organization.
`POST`	`/organizations/{organization_id}/invites`	Create organization invite. Try it
`GET`	`/organizations/{organization_id}/invites`	List org invites.
`POST`	`/organizations/{organization_id}/invites/accept`	Accept organization invite by token. Try it

Core Resource Libraries

Method	Path	Notes
`GET`	`/locations`	List locations.
`POST`	`/locations`	Create location (with enrichment).
`GET`	`/locations/{location_id}`	Get location.
`DELETE`	`/locations/{location_id}`	Delete location.
`GET`	`/weatherdata`	List weather datasets.
`POST`	`/weatherdata`	Create weather dataset from arrays.
`GET`	`/weatherdata/{weather_data_id}`	Get weather dataset with arrays.
`DELETE`	`/weatherdata/{weather_data_id}`	Delete weather dataset.
`GET`	`/modules`	List modules.
`POST`	`/modules`	Upload `.pan` file and parse module.
`POST`	`/modules/json`	Create module from JSON body.
`GET`	`/modules/{module_id}`	Get module.
`DELETE`	`/modules/{module_id}`	Delete module.
`GET`	`/inverters`	List inverters.
`POST`	`/inverters`	Upload `.ond` file and parse inverter.
`POST`	`/inverters/json`	Create inverter from JSON body.
`GET`	`/inverters/{inverter_id}`	Get inverter.
`DELETE`	`/inverters/{inverter_id}`	Delete inverter.

Projects, Layouts, and Shading

Method	Path	Notes
`GET`	`/projects`	List projects.
`POST`	`/projects`	Create project.
`POST`	`/projects/import`	Import a supported external project package.
`GET`	`/projects/{project_id}`	Get project.
`PUT`	`/projects/{project_id}`	Update project.
`DELETE`	`/projects/{project_id}`	Delete project.
`GET`	`/layouts`	List layouts.
`POST`	`/layouts`	Create layout (optionally with bulk data).
`GET`	`/layouts/{layout_id}`	Get layout details.
`GET`	`/layouts/{layout_id}/data`	Get presigned layout data URL.
`DELETE`	`/layouts/{layout_id}`	Delete layout and associated data.
`GET`	`/shadingscenes`	List shading scenes.
`POST`	`/shadingscenes`	Create shading scene from canonical JSON. Try it
`POST`	`/shadingscenes/import`	Import shading scene from file upload. Try it
`GET`	`/shadingscenes/{scene_id}`	Get shading scene. Legacy compatibility query params are also supported: `returnshading=true`, `returnmodel=true`, and `returntableshading=true`.
`GET`	`/shadingscenes/{scene_id}/gcr`	Compute or return derived GCR properties for the scene.
`GET`	`/shadingscenes/{scene_id}/results`	Get consolidated shading results or a pending `200` payload.
`GET`	`/shadingscenes/{scene_id}/viewer`	Get the scene viewer payload or URL for client rendering.
`DELETE`	`/shadingscenes/{scene_id}`	Delete shading scene.
`POST`	`/shadingscenes/{scene_id}/refresh`	Re-run shading calculation.
`POST`	`/shadingscenes/{scene_id}/trackinginputs`	Attach tracker parameters to scene.

Compatibility note for older shading workflows:

returnshading=true adds a top-level legacy shadingResults payload with shading factors by sun position.
returnmodel=true adds the historical model payload with the Daly-compatible shadingScene JSON and trackerParamIndex.
returntableshading=true adds per-table shading factors grouped under shadingResults.shadingFactorsByTableId.
These flags are additive shims on GET /shadingscenes/{scene_id}. The authoritative modern endpoints for results and viewer data remain GET /shadingscenes/{scene_id}/results and GET /shadingscenes/{scene_id}/viewer.

Energy Model and Async Operations

Method	Path	Notes
`POST`	`/energymodels`	Run energy model (`sync` default; use `?async=true` to queue). Try it
`GET`	`/energymodels`	List energy models.
`GET`	`/energymodels/{energy_model_id}`	Get model run outputs or saved inputs with `include=inputs`. Try it
`PUT`	`/energymodels/{energy_model_id}`	Update the saved input JSON on the existing row. Try it
`POST`	`/energymodels/{energy_model_id}/run`	Rerun the currently saved JSON in place on the same row. Try it
`DELETE`	`/energymodels/{energy_model_id}`	Delete model run.
`GET`	`/tasks`	List tasks with filters and pagination.
`GET`	`/tasks/{task_id}`	Get task status/details. Try it
`POST`	`/tasks/{task_id}/cancel`	Cancel pending/queued/running task.
`GET`	`/workflows/{workflow_id}`	Get parent workflow + child tasks. Try it

Chat Proxy

Method	Path	Notes
`GET`	`/chat/conversations`	List conversations via Bubba proxy.
`GET`	`/chat/conversations/{conversation_id}`	Get conversation messages.
`POST`	`/chat/message`	Send chat message via Bubba proxy.

Utility and Legacy Endpoints

Method	Path	Notes
`POST`	`/utils/upload-url`	Generate presigned S3 upload URL.
`POST`	`/utils/ghi-to-poa`	Deprecated utility endpoint.
`POST`	`/utils/soiling`	Deprecated utility endpoint.
`POST`	`/utils/sunposition`	Deprecated utility endpoint.
`POST`	`/epm`	Deprecated alias for `/energymodels`.

Overview

Health

Authentication

Users

Workspaces

Organizations

Locations

Weather Data

Modules

Inverters

Layouts

Projects

Shading Scenes

Energy Models

Tasks & Workflows

Chat

Endpoint Catalog

Endpoint Catalog

System

Auth

Users and Workspaces

Organizations

Core Resource Libraries

Projects, Layouts, and Shading

Energy Model and Async Operations

Chat Proxy

Utility and Legacy Endpoints

​Endpoint Catalog

​System

​Auth

​Users and Workspaces

​Organizations

​Core Resource Libraries

​Projects, Layouts, and Shading

​Energy Model and Async Operations

​Chat Proxy

​Utility and Legacy Endpoints

Endpoint Catalog

System

Auth

Users and Workspaces

Organizations

Core Resource Libraries

Projects, Layouts, and Shading

Energy Model and Async Operations

Chat Proxy

Utility and Legacy Endpoints