The request was well-formed but was unable to be followed due to semantic errors.
Solution
This is an error to avoid sending invalid requests from the server to the client. If you see this error, it means that the request was malformed in some way.Please contact us via email if you see this error.
code
enum<string>
required
The error code related to the status code.
Available options:
UNPROCESSABLE_ENTITY
Example:
"UNPROCESSABLE_ENTITY"
message
string
required
A human readable message describing the issue.
requestId
string
required
The request id to be used for debugging and error reporting.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Nomos","colors":{"primary":"#1b1915","light":"#ffffff","dark":"#1b1915"},"logo":{"light":"https://mintcdn.com/riverslate/0nQqndf6SGR4MtUC/logo/light.svg?fit=max\u0026auto=format\u0026n=0nQqndf6SGR4MtUC\u0026q=85\u0026s=99c5d32286bf07989f99539ad1584d34","dark":"https://mintcdn.com/riverslate/0nQqndf6SGR4MtUC/logo/dark.svg?fit=max\u0026auto=format\u0026n=0nQqndf6SGR4MtUC\u0026q=85\u0026s=1e24faf333cc5cbbaa6454764020bc7d"},"favicon":"https://mintcdn.com/riverslate/i0UKnKz5dNnV7CMC/favicon.ico?fit=max\u0026auto=format\u0026n=i0UKnKz5dNnV7CMC\u0026q=85\u0026s=019f4931cf3d704bd7a11ab89eec374e","api":{"openapi":["openapi/openapi.chucky.json"]},"appearance":{"default":"light"},"background":{"color":{"light":"#f6f3f0","dark":"#21262c"}},"navbar":{"links":[{"href":"https://dashboard.nomos.energy","label":"Dashboard"}],"primary":{"type":"button","label":"Book Demo","href":"https://nomos.energy/demo"}},"footer":{"socials":{"website":"https://nomos.energy","linkedin":"https://www.linkedin.com/company/nomos-energy"}},"fonts":{"family":"Soehne","source":"https://qnsvr1iaztsgci9a.public.blob.vercel-storage.com/soehne-buch-d177Pah3KmnkO2UpYz4Ru0Yx4QcPU8.woff2","format":"woff2"},"contextual":{"options":["copy","view","claude","chatgpt","cursor",{"title":"Get Support","description":"Email our team about this page","icon":"life-ring","href":{"base":"mailto:support@nomos.energy","query":[{"key":"subject","value":"Docs question"},{"key":"body","value":"Page: $path\n\n"}]}}],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"riverslate","hasAudioNarration":false,"actualSubdomain":"riverslate","customDomains":["docs.nomos.energy"],"gitSource":{"type":"github","owner":"nomos-energy","repo":"monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae4bddef2f7375d4fd960ea","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":323},{"language":"default","tag":"Subscriptions","count":24},{"language":"default","tag":"Webhooks","count":23},{"language":"default","tag":"Invoices","count":20},{"language":"default","tag":"Usage","count":19},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Leads","count":16},{"language":"default","tag":"Plans","count":16},{"language":"default","tag":"Authentication","count":15},{"language":"default","tag":"Customers","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".light .navbar-link a,.light #search-bar-entry,.light #assistant-entry,.light button[aria-label=\"Toggle dark mode\"]{background-color:#ebe8e3!important}.light .navbar-link a:hover,.light #search-bar-entry:hover,.light #assistant-entry:hover,.light button[aria-label=\"Toggle dark mode\"]:hover{background-color:#e2ded9!important}.light #navbar>div.bg-background-light{background-color:#fdfbfa}.dark #navbar>div.bg-background-light{background-color:#000000}.dark #background-color{background-color:#0a0a0a}.light #pagination>a{background-color:#fdfbfa}.dark #pagination>a{background-color:#21262c}.light #page-context-menu button,.light [role=\"menu\"][aria-labelledby^=\"page-context-menu\"]{background-color:#fdfbfa}.dark #page-context-menu button,.dark [role=\"menu\"][aria-labelledby^=\"page-context-menu\"]{background-color:#21262c}#page-context-menu-button span{display:none}#page-context-menu{min-width:0;align-items:stretch}body:has(.is-home-page) #page-context-menu{display:none!important}body:has(.is-home-page) #pagination{display:none!important}.light details.expandable{background-color:#fdfbfa}.light div.bg-background-light:has(>div>.tryit-button){background-color:#fdfbfa}.light [data-component-part=\"version-select-content\"]{background-color:#fdfbfa}.light details.accordion{background-color:#fdfbfa}td code,th code{white-space:nowrap}.light .card{background-color:#fdfbfa}@font-face{font-family:\"Soehne\";src:url(\"/fonts/soehne-kraftig.woff2\") format(\"woff2\");font-weight:500 700;font-style:normal;font-display:swap}#navbar img[src*=\"logo\"],#navbar img[alt=\"light logo\"],#navbar img[alt=\"dark logo\"]{height:1.25rem;width:auto}h1,h2,h3,h4{font-weight:500!important}#navbar nav ul li a,.nav-tabs-item{font-weight:400!important}.nav-tabs-item{text-shadow:none!important}"}],"page":{"pagePath":"api-references/errors/UNPROCESSABLE_ENTITY","slug":"/api-references/errors/UNPROCESSABLE_ENTITY","pageMetadata":{"title":"UNPROCESSABLE_ENTITY","openapi-schema":"ErrUnprocessableEntity","description":null,"href":"/api-references/errors/UNPROCESSABLE_ENTITY"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`problem`,children:`Problem`}),`\n`,_jsx(_components.p,{children:`The request was well-formed but was unable to be followed due to semantic errors.`}),`\n`,_jsx(Heading,{level:`2`,id:`solution`,children:`Solution`}),`\n`,_jsx(_components.p,{children:`This is an error to avoid sending invalid requests from the server to the client. If you see this error, it means that the request was malformed in some way.`}),`\n`,_jsxs(_components.p,{children:[`Please contact us via `,_jsx(_components.a,{href:`mailto:support@nomos.energy`,children:`email`}),` if you see this error.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"UNPROCESSABLE_ENTITY","openapi-schema":"ErrUnprocessableEntity","description":null,"href":"/api-references/errors/UNPROCESSABLE_ENTITY"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Problem","slug":"problem","depth":2,"children":[]},{"title":"Solution","slug":"solution","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"code":{"type":"string","enum":["UNPROCESSABLE_ENTITY"],"description":"The error code related to the status code.","example":"UNPROCESSABLE_ENTITY","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY","isRequired":true,"uniqueKey":"docs","typeLabel":"string"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"code":"UNPROCESSABLE_ENTITY","message":"\u003cstring>","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY"}}},"originalFileLocation":"openapi/openapi.batman.json"},"subdomain":"riverslate","siteName":"Nomos","title":"UNPROCESSABLE_ENTITY - Nomos","navMaps":{"firstHrefInVersion":{"2026-09-08.gauss":{"href":"/api-references/errors/UNPROCESSABLE_ENTITY","matchLevel":0},"2026-05-27.curie":{"href":"/api-references/introduction","matchLevel":3},"2026-01-29.edison":{"href":"/api-references/introduction","matchLevel":3},"2025-12-16.batman":{"href":"/api-references/introduction","matchLevel":3},"2025-12-01.chucky":{"href":"/api-references/introduction","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T15:55:30.498Z","originalFileLocation":"api-references/errors/UNPROCESSABLE_ENTITY.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Nomos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"UNPROCESSABLE_ENTITY - Nomos\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nomos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://riverslate.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=UNPROCESSABLE_ENTITY\u0026amp;theme=9f06b09645d9ae8ac0235d4f\u0026amp;signature=c4cad8b1900f9c57526234e27c192de0541cdd9999aceace6220e969591592e2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"UNPROCESSABLE_ENTITY - Nomos\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://riverslate.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=UNPROCESSABLE_ENTITY\u0026amp;theme=9f06b09645d9ae8ac0235d4f\u0026amp;signature=c4cad8b1900f9c57526234e27c192de0541cdd9999aceace6220e969591592e2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nomos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1b1915\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nomos.energy/api-references/errors/UNPROCESSABLE_ENTITY\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/errors/UNPROCESSABLE_ENTITY.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nomos\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nomos\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-references/errors/UNPROCESSABLE_ENTITY.md","siteName":"Nomos","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","groups":[{"group":" ","pages":[{"title":"Nomos Documentation","sidebarTitle":"Home","mode":"wide","href":"/home"},{"title":"Quickstart","href":"/quickstart"}]},{"group":"Hosted Components","pages":[{"title":"Checkout","sidebarTitle":"Checkout","href":"/guides/hosted-checkout"},{"title":"Leads \u0026 Checkout Links","href":"/guides/leads"},{"title":"Customer Portal","href":"/guides/hosted-customer-portal"},{"title":"Portal Single Sign-On","href":"/guides/magic-link"},{"title":"Third-Party Login","sidebarTitle":"Third-party login","href":"/guides/third-party-oauth"}]},{"group":"Build your own","pages":[{"title":"Checkout","sidebarTitle":"Checkout","href":"/guides/checkout"},{"title":"Customer Portal","href":"/guides/customer-portal"},{"title":"AI agents","href":"/guides/ai-agents"}]},{"group":"Integration Guides","pages":[{"title":"Pricing Breakdown","sidebarTitle":"Pricing Breakdown","href":"/guides/pricing"},{"title":"Savings calculator methodology","sidebarTitle":"Savings calculator","href":"/guides/savings-calculator"},{"title":"Feed-in","sidebarTitle":"Feed-in","href":"/guides/feed-in"},{"title":"Smart Meter Installation Partnerships","href":"/guides/order-smart-meters"},{"title":"Grid Fee Reductions (§14a EnWG)","href":"/guides/grid-fee-reductions"},{"title":"Load Shifting and Optimization","href":"/guides/load-shifting"}]}]},{"tab":"API Reference","icon":"code","versions":[{"version":"2026-09-08.gauss","default":true,"groups":[{"group":" ","pages":[{"title":"API Reference","sidebarTitle":"Introduction","href":"/api-references/introduction"},{"title":"Authentication","href":"/api-references/authentication"},{"title":"Versioning","href":"/api-references/versioning"},{"title":"Pagination","href":"/api-references/pagination"},{"title":"Filtering","href":"/api-references/filtering"},{"title":"Errors","href":"/api-references/errors"},{"title":"Changelog","href":"/api-references/changelog"}]},{"group":"API Reference","pages":[{"group":"Plans","pages":[{"title":"Calculate a quote","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /plans/{id}/quote","href":"/api-reference/plans/calculate-a-quote"},{"title":"Calculate savings","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /plans/{id}/savings","href":"/api-reference/plans/calculate-savings"},{"title":"List plans","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /plans","href":"/api-reference/plans/list-plans"},{"title":"Retrieve a plan","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /plans/{id}","href":"/api-reference/plans/retrieve-a-plan"}]},{"group":"Leads","pages":[{"title":"Retrieve a lead","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /leads/{id}","href":"/api-reference/leads/retrieve-a-lead"},{"title":"Update a lead","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json patch /leads/{id}","href":"/api-reference/leads/update-a-lead"},{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /leads","href":"/api-reference/leads/list-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /leads","href":"/api-reference/leads/create-a-lead"}]},{"group":"Subscriptions","pages":[{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /subscriptions/{id}","href":"/api-reference/subscriptions/retrieve-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json patch /subscriptions/{id}","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Terminate a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /subscriptions/{id}/terminate","href":"/api-reference/subscriptions/terminate-a-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /subscriptions","href":"/api-reference/subscriptions/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /subscriptions","href":"/api-reference/subscriptions/create-a-subscription"}]},{"group":"Customers","pages":[{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /customers/{id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json patch /customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /customers","href":"/api-reference/customers/list-customers"}]},{"group":"Households","pages":[{"title":"List households","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /households","href":"/api-reference/households/list-households"},{"title":"Retrieve a household","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /households/{id}","href":"/api-reference/households/retrieve-a-household"}]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /assets","href":"/api-reference/assets/list-assets"},{"title":"Add an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /assets","href":"/api-reference/assets/add-an-asset"},{"title":"Retrieve an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /assets/{id}","href":"/api-reference/assets/retrieve-an-asset"},{"title":"Update an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json patch /assets/{id}","href":"/api-reference/assets/update-an-asset"},{"title":"Decommission an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /assets/{id}/decommission","href":"/api-reference/assets/decommission-an-asset"},{"title":"List the newest asset snapshots","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /asset-snapshots","href":"/api-reference/assets/list-the-newest-asset-snapshots"},{"title":"Send asset snapshots","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /asset-snapshots","href":"/api-reference/assets/send-asset-snapshots"},{"title":"Retrieve an asset schedule","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /assets/{id}/schedule","href":"/api-reference/assets/retrieve-an-asset-schedule"}]},{"group":"Usage","pages":[{"title":"Retrieve usage data","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /subscriptions/{id}/usage","href":"/api-reference/usage/retrieve-usage-data"},{"title":"List meter readings","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /meter-readings","href":"/api-reference/usage/list-meter-readings"},{"title":"Create a meter reading","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /meter-readings","href":"/api-reference/usage/create-a-meter-reading"}]},{"group":"Prices","pages":[{"title":"Retrieve a subscription price time series","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /subscriptions/{id}/prices","href":"/api-reference/prices/retrieve-a-subscription-price-time-series"}]},{"group":"Invoices","pages":[{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /invoices/{id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Retrieve an invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /invoices/{id}/file","href":"/api-reference/invoices/retrieve-an-invoice-pdf"}]},{"group":"Smart Meter Orders","pages":[{"title":"Retrieve a smart meter order","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /meter-orders/{id}","href":"/api-reference/smart-meter-orders/retrieve-a-smart-meter-order"},{"title":"List smart meter orders","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /meter-orders","href":"/api-reference/smart-meter-orders/list-smart-meter-orders"},{"title":"Create a smart meter order","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /meter-orders","href":"/api-reference/smart-meter-orders/create-a-smart-meter-order"}]},{"group":"Grid Fee Reductions","pages":[{"title":"List grid fee reductions","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /grid-fee-reductions","href":"/api-reference/grid-fee-reductions/list-grid-fee-reductions"},{"title":"Create a grid fee reduction","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /grid-fee-reductions","href":"/api-reference/grid-fee-reductions/create-a-grid-fee-reduction"},{"title":"Retrieve a grid fee reduction","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /grid-fee-reductions/{id}","href":"/api-reference/grid-fee-reductions/retrieve-a-grid-fee-reduction"}]},{"group":"Market Partners","pages":[{"title":"List market partners","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /market-partners","href":"/api-reference/market-partners/list-market-partners"}]},{"group":"Events","pages":[{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /events/{id}","href":"/api-reference/events/retrieve-an-event"}]},{"group":"Authentication","pages":[{"title":"Create a token","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /oauth/token","href":"/api-reference/authentication/create-a-token"},{"title":"Authorize","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json get /oauth/authorize","href":"/api-reference/authentication/authorize"},{"title":"Create a magic link (customer portal)","deprecated":null,"version":null,"openapi":"/openapi/openapi.gauss.json post /admin/magic_link","href":"/api-reference/authentication/create-a-magic-link-customer-portal"}]}]}]},{"version":"2026-05-27.curie","pages":[{"title":"2026-05-27.curie","href":"/api-references/introduction"}]},{"version":"2026-01-29.edison","pages":[{"title":"2026-01-29.edison","href":"/api-references/introduction"}]},{"version":"2025-12-16.batman","pages":[{"title":"2025-12-16.batman","href":"/api-references/introduction"}]},{"version":"2025-12-01.chucky","pages":[{"title":"2025-12-01.chucky","href":"/api-references/introduction"}]}]},{"tab":"Webhooks","icon":"webhook","groups":[{"group":" ","pages":[{"title":"Webhooks","sidebarTitle":"Introduction","href":"/webhooks/introduction"},{"title":"How to receive webhooks","href":"/webhooks/receiving"},{"title":"Verify webhook requests","href":"/webhooks/verify-requests"},{"title":"Retries","href":"/webhooks/retries"}]},{"group":"Subscriptions","pages":[{"title":"subscription.created","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-gray.svg","href":"/webhooks/events/subscription-created"},{"title":"subscription.confirmed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green-light.svg","href":"/webhooks/events/subscription-confirmed"},{"title":"subscription.activated","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green.svg","href":"/webhooks/events/subscription-activated"},{"title":"subscription.terminated","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red-light.svg","href":"/webhooks/events/subscription-terminated"},{"title":"subscription.ended","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red.svg","href":"/webhooks/events/subscription-ended"}]},{"group":"Invoices","pages":[{"title":"invoice.created","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-gray.svg","href":"/webhooks/events/invoice-created"},{"title":"invoice.paid","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green.svg","href":"/webhooks/events/invoice-paid"},{"title":"invoice.payment_failed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red-light.svg","href":"/webhooks/events/invoice-payment_failed"},{"title":"invoice.voided","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red.svg","href":"/webhooks/events/invoice-voided"},{"title":"invoice.uncollectible","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red.svg","href":"/webhooks/events/invoice-uncollectible"}]},{"group":"Meter Orders","pages":[{"title":"meter_order.created","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-gray.svg","href":"/webhooks/events/meter_order-created"},{"title":"meter_order.placed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-gray.svg","href":"/webhooks/events/meter_order-placed"},{"title":"meter_order.check_submitted","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-gray.svg","href":"/webhooks/events/meter_order-check_submitted"},{"title":"meter_order.check_reviewed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green-light.svg","href":"/webhooks/events/meter_order-check_reviewed"},{"title":"meter_order.scheduled","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green-light.svg","href":"/webhooks/events/meter_order-scheduled"},{"title":"meter_order.installed","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green-light.svg","href":"/webhooks/events/meter_order-installed"},{"title":"meter_order.activated","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-green.svg","href":"/webhooks/events/meter_order-activated"},{"title":"meter_order.blocked","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red-light.svg","href":"/webhooks/events/meter_order-blocked"},{"title":"meter_order.cancelled","icon":"https://mintlify.s3.us-west-1.amazonaws.com/riverslate/images/dot-red.svg","href":"/webhooks/events/meter_order-cancelled"}]}]}]},"basePath":"","title":"UNPROCESSABLE_ENTITY - Nomos","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}