Skip to main content

Endpoint Catalog

This page lists currently implemented route paths by domain and points to the curated interactive pages in this docs set.

System

MethodPathNotes
GET/healthService health status (DB, queue, monitoring).

Auth

MethodPathNotes
POST/auth/tokenExchange workspace/user API keys for JWT. Try it
GET/auth/workspacesList workspaces for Supabase-authenticated user. Try it
POST/auth/exchange-supabaseExchange Supabase token for Daly JWT. Try it

Users and Workspaces

MethodPathNotes
POST/usersCreate user (returns plaintext API key once).
GET/users/workspacesList workspaces for current user.
GET/workspacesList workspaces visible in current context.
POST/workspacesCreate 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}/usersList workspace users.
GET/workspaces/{workspace_id}/settingsGet workspace settings. Try it
PUT/workspaces/{workspace_id}/settingsReplace workspace settings.
PATCH/workspaces/{workspace_id}/settingsDeep-merge patch workspace settings. Try it

Organizations

MethodPathNotes
GET/organizations/{organization_id}Get organization.
PATCH/organizations/{organization_id}Update organization metadata.
GET/organizations/{organization_id}/usersList organization users.
PATCH/organizations/{organization_id}/users/{user_id}Update org user role.
GET/organizations/{organization_id}/workspacesList org workspaces.
POST/organizations/{organization_id}/workspacesCreate workspace in organization.
POST/organizations/{organization_id}/invitesCreate organization invite. Try it
GET/organizations/{organization_id}/invitesList org invites.
POST/organizations/{organization_id}/invites/acceptAccept organization invite by token. Try it

Core Resource Libraries

MethodPathNotes
GET/locationsList locations.
POST/locationsCreate location (with enrichment).
GET/locations/{location_id}Get location.
DELETE/locations/{location_id}Delete location.
GET/weatherdataList weather datasets.
POST/weatherdataCreate weather dataset from arrays.
GET/weatherdata/{weather_data_id}Get weather dataset with arrays.
DELETE/weatherdata/{weather_data_id}Delete weather dataset.
GET/modulesList modules.
POST/modulesUpload .pan file and parse module.
POST/modules/jsonCreate module from JSON body.
GET/modules/{module_id}Get module.
DELETE/modules/{module_id}Delete module.
GET/invertersList inverters.
POST/invertersUpload .ond file and parse inverter.
POST/inverters/jsonCreate inverter from JSON body.
GET/inverters/{inverter_id}Get inverter.
DELETE/inverters/{inverter_id}Delete inverter.

Projects, Layouts, and Shading

MethodPathNotes
GET/projectsList projects.
POST/projectsCreate project.
POST/projects/importImport PVsyst package/files.
GET/projects/{project_id}Get project.
PUT/projects/{project_id}Update project.
DELETE/projects/{project_id}Delete project.
GET/layoutsList layouts.
POST/layoutsCreate layout (optionally with bulk data).
GET/layouts/{layout_id}Get layout details.
GET/layouts/{layout_id}/dataGet presigned layout data URL.
DELETE/layouts/{layout_id}Delete layout and associated data.
GET/shadingscenesList shading scenes.
POST/shadingscenesCreate shading scene from canonical JSON. Try it
POST/shadingscenes/importImport 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}/gcrCompute or return derived GCR properties for the scene.
GET/shadingscenes/{scene_id}/resultsGet consolidated shading results or a pending 200 payload.
GET/shadingscenes/{scene_id}/viewerGet the scene viewer payload or URL for client rendering.
DELETE/shadingscenes/{scene_id}Delete shading scene.
POST/shadingscenes/{scene_id}/refreshRe-run shading calculation.
POST/shadingscenes/{scene_id}/trackinginputsAttach 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

MethodPathNotes
POST/energymodelsRun energy model (sync default; use ?async=true to queue). Try it
GET/energymodelsList 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}/runRerun the currently saved JSON in place on the same row. Try it
DELETE/energymodels/{energy_model_id}Delete model run.
GET/tasksList tasks with filters and pagination.
GET/tasks/{task_id}Get task status/details. Try it
POST/tasks/{task_id}/cancelCancel pending/queued/running task.
GET/workflows/{workflow_id}Get parent workflow + child tasks. Try it

Chat Proxy

MethodPathNotes
GET/chat/conversationsList conversations via Bubba proxy.
GET/chat/conversations/{conversation_id}Get conversation messages.
POST/chat/messageSend chat message via Bubba proxy.

Utility and Legacy Endpoints

MethodPathNotes
POST/utils/upload-urlGenerate presigned S3 upload URL.
POST/utils/ghi-to-poaDeprecated utility endpoint.
POST/utils/soilingDeprecated utility endpoint.
POST/utils/sunpositionDeprecated utility endpoint.
POST/epmDeprecated alias for /energymodels.