Artemis API Documentation
API v1 is being deprecated. Use v2 for new integrations. For existing integrations, see the migration guide and API Reference v1.
Integrate the Artemis home energy platform into your products to create proposals and designs, run credit and contract workflows, and sync your systems in real time.
Most partners use both integration surfaces:
- REST API v2: programmatic access to projects, equipment, financing, teams, users, and more. Authenticated with an API key. See the API Reference v2.
- Embeddable UI: embed the Artemis proposal and design editor directly in your
own site with an
<iframe>. See Iframe Integration.
API v2
Use /external/v2 for new REST integrations. Start with the
Quickstart; follow the v2 changelog for updates.
- Authentication: send your API key with each request. The associated user's permissions determine access.
- Pagination: project lists return
dataandpage.nextCursor. - Writes: use
Idempotency-KeyandIf-Matchwhere the operation requires them. - Webhooks: subscribe to resource notifications to keep your systems in sync. See Webhooks for setup and examples.
What you can build
- Proposals: create projects and generate branded proposals homeowners can review and act on online.
- System design: auto-design from the roof and fine-tune in the editor: solar, batteries, roofing, and home-energy upgrades.
- Financing: present loan, lease, and TPO options, submit credit applications, and track decisions.
- Contracts: send contracts for e-signature and receive the signed PDF the moment it completes.
- Home improvement: bundle HVAC, windows, roofing, insulation, and other upgrades.
- Automation: react to project, contract, and finance events in real time with webhooks.
Environments
Build and test in the isolated sandbox environment; promote to production when you're ready.
| Environment | REST API base URL | App / iframe base URL |
|---|---|---|
| Production | https://sales-api.artemis.solar | https://sales.artemis.solar |
| Sandbox | https://sales-sandbox-api.artemis.solar | https://sales-sandbox.artemis.solar |
Sandbox and production use separate API keys and separate data. A key issued for one environment will not work against the other.
Start here
- Get your API key. Create a key in Settings → API Keys if you have access, or request one from your Artemis administrator, then read Authentication & API Keys.
- Make your first call. Follow the Quickstart to create a project and receive your first webhook end to end.
- Learn the model. Skim Core Concepts to understand organizations, installers, teams, projects, and permissions.
- Go deeper. Embed the UI with Iframe Integration and react to changes with Webhooks.

