{
"errors": [
{
"status": "400",
"type": "VALIDATION",
"code": "BAD_REQUEST",
"title": "Bad Request",
"detail": "The request could not be understood by the server due to malformed syntax.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/validation-errors"
}
}
]
}
{
"errors": [
{
"status": "401",
"type": "AUTHENTICATION",
"code": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "The Authorization token is missing or invalid.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication"
}
}
]
}
{
"errors": [
{
"status": "403",
"type": "AUTHENTICATION",
"code": "FORBIDDEN",
"title": "Forbidden",
"detail": "You do not have permission to access this resource.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/authentication-errors"
}
}
]
}
{
"errors": [
{
"status": "404",
"type": "RESOURCE_NOT_FOUND",
"code": "NOT_FOUND",
"title": "Not Found",
"detail": "The requested resource could not be found.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors"
}
}
]
}
{
"errors": [
{
"status": "422",
"type": "VALIDATION",
"code": "INTERACTION_NOT_APPLICABLE",
"title": "Interaction Not Applicable",
"detail": "This vehicle doesn't have more than one battery capacity option, so there's nothing for the owner to choose. Read its capacity from the tractionbattery-nominalcapacity signal."
}
]
}
{
"errors": [
{
"status": "500",
"type": "SERVER",
"code": "INTERNAL",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/server-errors"
}
}
]
}
Interactions
Create a select-battery-capacity interaction
Creates a URL that takes the vehicle owner to Smartcar Connect to
choose the vehicle’s battery capacity. While the URL’s token is valid,
the owner isn’t asked to log in again. The token is valid until
expiresAt (30 days) at the latest. It may stop being valid earlier,
for example after the owner completes a selection or when a newer URL
is created for the same vehicle. After that the URL still works, but
the owner has to log in first.
Returns 422 if the vehicle has fewer than two capacity options, because
there’s nothing for the owner to choose.
{
"errors": [
{
"status": "400",
"type": "VALIDATION",
"code": "BAD_REQUEST",
"title": "Bad Request",
"detail": "The request could not be understood by the server due to malformed syntax.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/validation-errors"
}
}
]
}
{
"errors": [
{
"status": "401",
"type": "AUTHENTICATION",
"code": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "The Authorization token is missing or invalid.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication"
}
}
]
}
{
"errors": [
{
"status": "403",
"type": "AUTHENTICATION",
"code": "FORBIDDEN",
"title": "Forbidden",
"detail": "You do not have permission to access this resource.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/authentication-errors"
}
}
]
}
{
"errors": [
{
"status": "404",
"type": "RESOURCE_NOT_FOUND",
"code": "NOT_FOUND",
"title": "Not Found",
"detail": "The requested resource could not be found.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors"
}
}
]
}
{
"errors": [
{
"status": "422",
"type": "VALIDATION",
"code": "INTERACTION_NOT_APPLICABLE",
"title": "Interaction Not Applicable",
"detail": "This vehicle doesn't have more than one battery capacity option, so there's nothing for the owner to choose. Read its capacity from the tractionbattery-nominalcapacity signal."
}
]
}
{
"errors": [
{
"status": "500",
"type": "SERVER",
"code": "INTERNAL",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server.",
"links": {
"about": "https://smartcar.com/docs/errors/api-errors/v3/server-errors"
}
}
]
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"smartcar","colors":{"primary":"#3E577D","light":"#3E577D","dark":"#3E577D"},"logo":{"light":"https://mintcdn.com/smartcar-docs/YqcNJdgEDgXpXtEG/logo/light.png?fit=max\u0026auto=format\u0026n=YqcNJdgEDgXpXtEG\u0026q=85\u0026s=c8947958467fe403a12f769afada9b53","dark":"https://mintcdn.com/smartcar-docs/YqcNJdgEDgXpXtEG/logo/dark.png?fit=max\u0026auto=format\u0026n=YqcNJdgEDgXpXtEG\u0026q=85\u0026s=af6b6bcabc2fe0bc4bbd976ee5b71a36","href":"https://smartcar.com/"},"favicon":"https://mintcdn.com/smartcar-docs/NtuX9OSBHLxFwWIa/favicon.png?fit=max\u0026auto=format\u0026n=NtuX9OSBHLxFwWIa\u0026q=85\u0026s=de01fc4e56d5368d441e322ac50e3f81","api":{"playground":{"display":"interactive","proxy":false},"examples":{"prefill":true}},"navbar":{"links":[{"href":"https://dashboard.smartcar.com/login/","label":"Log in"},{"href":"https://dashboard.smartcar.com/signup/","label":"Sign up"}],"primary":{"type":"button","label":"Request a Demo","href":"https://smartcar.com/pricing/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/smartcar","github":"https://github.com/smartcar","facebook":"https://www.facebook.com/smartcar","instagram":"https://www.instagram.com/mysmartcar","x":"https://x.com/mysmartcar"},"links":[{"header":"Product","items":[{"label":"Vehicle signals","href":"https://smartcar.com/product/signals"},{"label":"Vehicle commands","href":"https://smartcar.com/product/commands"},{"label":"Compatible brands","href":"https://smartcar.com/product/compatible-vehicles"},{"label":"Connect","href":"https://smartcar.com/product/connect"},{"label":"Integrations","href":"https://smartcar.com/product/integrations"},{"label":"Global coverage","href":"https://smartcar.com/global"},{"label":"Teams","href":"https://smartcar.com/product/teams"},{"label":"Vehicle management","href":"https://smartcar.com/product/vehicle-management"},{"label":"Analytics","href":"https://smartcar.com/product/analytics"},{"label":"Pricing","href":"https://smartcar.com/pricing"},{"label":"Status","href":"https://status.smartcar.com/"},{"label":"Brand reliability","href":"https://brandreliability.smartcar.com/"},{"label":"Data security","href":"https://smartcar.com/data-security"}]},{"header":"Energy Solutions","items":[{"label":"DERMs","href":"https://smartcar.com/industries/derms-software"},{"label":"Virtual Power Plants (VPPs)","href":"https://smartcar.com/industries/virtual-power-plant"},{"label":"Utilities","href":"https://smartcar.com/utilities"},{"label":"Home energy management","href":"https://smartcar.com/industries/home-energy-management"},{"label":"EV charging networks","href":"https://smartcar.com/industries/ev-charging"},{"label":"Charge point operators","href":"https://smartcar.com/industries/charge-point-operator"},{"label":"E-mobility service providers","href":"https://smartcar.com/industries/e-mobility-service-providers"}]},{"header":"Solutions","items":[{"label":"Repair and maintenance","href":"https://smartcar.com/industries/repair-maintenance"},{"label":"Autocare software","href":"https://smartcar.com/industries/autocare-software"},{"label":"Auto dealership","href":"https://smartcar.com/industries/auto-dealership-software"},{"label":"Roadside assistance","href":"https://smartcar.com/industries/roadside-assistance"},{"label":"Vehicle history reports","href":"https://smartcar.com/industries/vehicle-history-reports"},{"label":"Small fleet management","href":"https://smartcar.com/industries/fleet-management"},{"label":"Car subscription service","href":"https://smartcar.com/industries/car-subscription-services"},{"label":"Car sharing","href":"https://smartcar.com/industries/car-sharing"},{"label":"Ride hailing","href":"https://smartcar.com/industries/ride-sharing"},{"label":"Car rentals","href":"https://smartcar.com/industries/car-rental"},{"label":"Auto insurance","href":"https://smartcar.com/industries/auto-insurance"},{"label":"Warranty software","href":"https://smartcar.com/industries/warranty-management-software"},{"label":"Road usage charge","href":"https://smartcar.com/industries/road-usage-charge"}]},{"header":"Resources","items":[{"label":"Customers","href":"https://smartcar.com/customers"},{"label":"Blog","href":"https://smartcar.com/blog"},{"label":"For vehicle owners","href":"https://smartcar.com/vehicle-owners"},{"label":"For automakers","href":"https://smartcar.com/automakers"},{"label":"Terms of service","href":"https://smartcar.com/legal/terms"},{"label":"Privacy policy","href":"https://smartcar.com/legal/privacy"},{"label":"End user privacy policy","href":"https://smartcar.com/legal/end-user-privacy"},{"label":"Acceptable use","href":"https://smartcar.com/legal/acceptable-use"},{"label":"Data processing","href":"https://smartcar.com/legal/dpa"},{"label":"Vulnerability disclosure program","href":"https://smartcar.com/vdp"},{"label":"mySmartcar","href":"https://my.smartcar.com"}]}]},"search":{"prompt":"✨ Ask Smartcar"},"integrations":{"koala":{"publicApiKey":"pk_3a64cc4d12d7b978edffae0afd143df5b291"},"ga4":{"measurementId":"G-QHNXS91VZC"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smartcar-docs","hasAudioNarration":false,"actualSubdomain":"smartcar-docs","customDomains":["smartcar.com"],"gitSource":{"type":"github","owner":"smartcar","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbe250d05dd52d1c87e7c2","collectionId":"4e81bf89-a564-4084-82d5-a2f1a4b41ad6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbe250d05dd52d1c87e7c2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbe250d05dd52d1c87e7c2","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API \u0026 Integrations Reference","count":147},{"language":"default","tag":"API 2.0 Reference (Legacy)","count":64},{"language":"default","tag":"Vehicle Data","count":48},{"language":"default","tag":"Help Center","count":36},{"language":"default","tag":"Getting Started","count":28},{"language":"default","tag":"Make Specific","count":27},{"language":"default","tag":"Introduction","count":26},{"language":"default","tag":"Tesla","count":26},{"language":"default","tag":"Webhooks","count":25},{"language":"default","tag":"Errors","count":20}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"llms-txt-v2","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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".hsfc-Form .hsfc-FieldLabel span:is(.dark *),.hsfc-Form .hsfc-RichText p:is(.dark *),.hsfc-PostSubmit .hsfc-RichText p:is(.dark *){color:#a0a1a2}.dark\\:text-primary-light:is(.dark *){color:#378ff0}.hsfc-FormWrapper .hsfc-Step .hsfc-Step__Content{padding:0 10px 20px;background-color:rgb(113 113 122/10%);border-radius:10px}.hsfc-FormWrapper .hsfc-Step .hsfc-Step__Content .hsfc-Row{margin-bottom:4px}.hsfc-FormWrapper .hsfc-Step .hsfc-Step__Content .hsfc-NavigationRow{margin-top:4px}.osano-cm-powered-by__link.osano-cm-link,.osano-cm-window__widget{display:none}.osano-cm-close svg{stroke:#fff!important}.osano-cm-dialog{font-family:Inter,ui-sans-serif,system-ui,sans-serif;border-radius:12px;box-shadow:0 -4px 24px rgba(0,0,0,.08);padding:20px 24px;background-color:#fff;color:#374151;border-top:1px solid #e5e7eb}.osano-cm-dialog__title{font-size:.9rem;font-weight:600;color:#111827;margin-bottom:6px}.osano-cm-dialog__description,.osano-cm-message{font-size:.825rem;color:#6b7280;line-height:1.5}.osano-cm-storage-policy{font-size:.825rem;line-height:1.5}.osano-cm-message:is(.dark *){color:#fff}.osano-cm-info a,.osano-cm-storage-policy{color:#3e577d}.osano-cm-button{font-family:Inter,ui-sans-serif,system-ui,sans-serif;font-size:.825rem;font-weight:500;border-radius:6px;padding:7px 14px;transition:opacity .15s ease}.osano-cm-button:hover{opacity:.85}.osano-cm-accept,.osano-cm-button--save,.osano-cm-save{background-color:#3e577d!important;color:#fff!important;border:0!important}.osano-cm-deny,.osano-cm-manage{background-color:transparent!important;color:#3e577d!important;border:1px solid #3e577d!important}.osano-cm-manage{border:0!important;padding-left:4px!important;padding-right:4px!important;text-decoration:underline;text-underline-offset:2px}.osano-cm-dialog:is(.dark *){background-color:#1f2937;color:#d1d5db;border-top-color:#374151;box-shadow:0 -4px 24px rgba(0,0,0,.3)}.osano-cm-dialog__title:is(.dark *){color:#f9fafb}.osano-cm-dialog__description:is(.dark *){color:#9ca3af}.osano-cm-info a:is(.dark *),.osano-cm-storage-policy:is(.dark *){color:#93b4d8}.osano-cm-deny:is(.dark *){color:#93b4d8!important;border-color:#93b4d8!important}.osano-cm-manage:is(.dark *){color:#93b4d8!important}.osano-cm-info{font-family:Inter,ui-sans-serif,system-ui,sans-serif;border-radius:0;box-shadow:0 -4px 24px rgba(0,0,0,.08);background-color:#fff;color:#374151;border-top:1px solid #e5e7eb;min-width:480px;overflow-y:visible}.osano-cm-header,.osano-cm-info-dialog-header{background-color:#fff!important}.osano-cm-info__title{font-size:.9rem;font-weight:600;color:#111827}.osano-cm-info__description,.osano-cm-info__list{font-size:.825rem;color:#6b7280;line-height:1.5}.osano-cm-toggle__switch{background-color:#e5e7eb!important;border-color:#3e577d!important}.osano-cm-toggle__input:checked+.osano-cm-toggle__switch{background-color:#3e577d!important;border-color:#3e577d!important}.osano-cm-toggle__input:checked+.osano-cm-toggle__switch::after{background-color:#e5e7eb!important}.osano-cm-info:is(.dark *){background-color:#1f2937;color:#d1d5db;border-top-color:#374151;box-shadow:0 -4px 24px rgba(0,0,0,.3)}.osano-cm-header:is(.dark *),.osano-cm-info-dialog-header:is(.dark *){background-color:#1f2937!important}.osano-cm-info__title:is(.dark *){color:#f9fafb}.osano-cm-info__description:is(.dark *),.osano-cm-info__list:is(.dark *){color:#9ca3af}.osano-cm-toggle__switch:is(.dark *){background-color:#374151!important}"}],"page":{"pagePath":"api-reference/create-a-select-battery-capacity-interaction","slug":"/api-reference/create-a-select-battery-capacity-interaction","pageMetadata":{"title":"Create a select-battery-capacity interaction","description":"Creates a URL that takes the vehicle owner to Smartcar Connect to\nchoose the vehicle's battery capacity. While the URL's token is valid,\nthe owner isn't asked to log in again. The token is valid until\n`expiresAt` (30 days) at the latest. It may stop being valid earlier,\nfor example after the owner completes a selection or when a newer URL\nis created for the same vehicle. After that the URL still works, but\nthe owner has to log in first.\n\nReturns 422 if the vehicle has fewer than two capacity options, because\nthere's nothing for the owner to choose.\n","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /interactions/select-battery-capacity","href":"/api-reference/create-a-select-battery-capacity-interaction","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Creates a URL that takes the vehicle owner to Smartcar Connect to\\nchoose the vehicle’s battery capacity. While the URL’s token is valid,\\nthe owner isn’t asked to log in again. The token is valid until\\n\", _jsx(_components.code, {\n children: \"expiresAt\"\n }), \" (30 days) at the latest. It may stop being valid earlier,\\nfor example after the owner completes a selection or when a newer URL\\nis created for the same vehicle. After that the URL still works, but\\nthe owner has to log in first.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Returns 422 if the vehicle has fewer than two capacity options, because\\nthere’s nothing for the owner to choose.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a select-battery-capacity interaction","description":"Creates a URL that takes the vehicle owner to Smartcar Connect to\nchoose the vehicle's battery capacity. While the URL's token is valid,\nthe owner isn't asked to log in again. The token is valid until\n`expiresAt` (30 days) at the latest. It may stop being valid earlier,\nfor example after the owner completes a selection or when a newer URL\nis created for the same vehicle. After that the URL still works, but\nthe owner has to log in first.\n\nReturns 422 if the vehicle has fewer than two capacity options, because\nthere's nothing for the owner to choose.\n","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /interactions/select-battery-capacity","href":"/api-reference/create-a-select-battery-capacity-interaction","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/smartcar-docs/079ff91450d16dd6/osano.js"],"openApiReferenceData":{"operation":{"operationId":"createSelectBatteryCapacityInteraction","summary":"Create a select-battery-capacity interaction","description":"Creates a URL that takes the vehicle owner to Smartcar Connect to\nchoose the vehicle's battery capacity. While the URL's token is valid,\nthe owner isn't asked to log in again. The token is valid until\n`expiresAt` (30 days) at the latest. It may stop being valid earlier,\nfor example after the owner completes a selection or when a newer URL\nis created for the same vehicle. After that the URL still works, but\nthe owner has to log in first.\n\nReturns 422 if the vehicle has fewer than two capacity options, because\nthere's nothing for the owner to choose.\n","security":["cc03785f-1ad6-4e48-8100-88a35db307fb"],"requestBody":"011afe8e-7ce2-4b1b-bb76-6e057dbef849","responses":{"201":"cb855b84-d368-4e54-a17c-24a58bbdbbeb","400":"e4019a80-6f7a-4050-a204-1a27155db9f3","401":"e59e85a8-1429-4f8d-b4f0-c581544eee2f","403":"1652f01e-f928-473f-81b1-d14a842667ae","404":"48043e80-78ef-489d-9972-930ed2b1da72","422":"96b44f0e-85e0-4624-938d-eba1079b6336","500":"b444213e-680b-4fbc-92b9-2f2742ff656f"},"method":"post","type":"path","servers":["03d4ea0c-9b02-4a24-9712-c7d30e8c95ba"],"path":"/interactions/select-battery-capacity","baseUrlOptions":["https://vehicle.api.smartcar.com/v3"],"title":"Create a select-battery-capacity interaction","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.data.attributes.vehicleId":"a6a425d6-c661-4b21-af7a-d6b75f80f3b0","body.data.attributes.userId":"1e258add-fb21-4293-b9ab-cf8a61f7a880","body.data.attributes.redirectUri":"https://example.com/smartcar/callback"}],"disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request for creating a select-battery-capacity interaction.","required":["data"],"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["vehicleId"],"additionalProperties":false,"properties":{"vehicleId":{"type":"string","description":"The vehicle whose battery capacity the owner will choose.","isRequired":true,"uniqueKey":"data.attributes.vehicleId","typeLabel":"string"},"userId":{"type":"string","description":"The user the vehicle is connected through. Required with an\napplication token. With a vehicle user token, the token's user is\nused and this field is ignored.\n","uniqueKey":"data.attributes.userId","typeLabel":"string"},"redirectUri":{"type":"string","format":"uri","description":"Where to send the owner when they finish. Must exactly match a redirect\nURI registered for the application in the Smartcar Dashboard. Defaults\nto the application's default redirect URI.\n","uniqueKey":"data.attributes.redirectUri","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"example":{"data":{"attributes":{"vehicleId":"a6a425d6-c661-4b21-af7a-d6b75f80f3b0","userId":"1e258add-fb21-4293-b9ab-cf8a61f7a880","redirectUri":"https://example.com/smartcar/callback"}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"attributes":{"vehicleId":"a6a425d6-c661-4b21-af7a-d6b75f80f3b0","userId":"1e258add-fb21-4293-b9ab-cf8a61f7a880","redirectUri":"https://example.com/smartcar/callback"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cb855b84-d368-4e54-a17c-24a58bbdbbeb":{"description":"Interaction created","content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["id","type","attributes","meta"],"properties":{"id":{"type":"string","description":"Unique identifier for this interaction (useful for support and log correlation).","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"type":{"type":"string","enum":["interaction"],"default":"interaction","isRequired":true,"uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"attributes":{"type":"object","required":["interactionType","url","expiresAt"],"properties":{"interactionType":{"type":"string","enum":["select-battery-capacity"],"isRequired":true,"uniqueKey":"data.attributes.interactionType","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"URL to send the person to. Treat it as opaque: it's a Connect URL\ntoday, but that may change.\n","isRequired":true,"uniqueKey":"data.attributes.url","typeLabel":"string\u003curi>"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.attributes.expiresAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.attributes","typeLabel":"object"},"meta":{"type":"object","required":["createdAt"],"properties":{"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.meta.createdAt","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.meta","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"example":{"data":{"id":"9f1c2b7e-3a4d-4e5f-8a9b-0c1d2e3f4a5b","type":"interaction","attributes":{"interactionType":"select-battery-capacity","url":"https://connect.smartcar.com/battery-capacity?token=REDACTED","expiresAt":"2026-11-07T18:00:00Z"},"meta":{"createdAt":"2026-10-08T18:00:00Z"}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"9f1c2b7e-3a4d-4e5f-8a9b-0c1d2e3f4a5b","type":"interaction","attributes":{"interactionType":"select-battery-capacity","url":"https://connect.smartcar.com/battery-capacity?token=REDACTED","expiresAt":"2026-11-07T18:00:00Z"},"meta":{"createdAt":"2026-10-08T18:00:00Z"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e4019a80-6f7a-4050-a204-1a27155db9f3":{"description":"400 Bad Request","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"400","type":"VALIDATION","code":"BAD_REQUEST","title":"Bad Request","detail":"The request could not be understood by the server due to malformed syntax.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/validation-errors"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"400","type":"VALIDATION","code":"BAD_REQUEST","title":"Bad Request","detail":"The request could not be understood by the server due to malformed syntax.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/validation-errors"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"e59e85a8-1429-4f8d-b4f0-c581544eee2f":{"description":"401 Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"401","type":"AUTHENTICATION","code":"UNAUTHORIZED","title":"Unauthorized","detail":"The Authorization token is missing or invalid.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"401","type":"AUTHENTICATION","code":"UNAUTHORIZED","title":"Unauthorized","detail":"The Authorization token is missing or invalid.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/authentication-errors#authentication"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"1652f01e-f928-473f-81b1-d14a842667ae":{"description":"403 Forbidden","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"403","type":"AUTHENTICATION","code":"FORBIDDEN","title":"Forbidden","detail":"You do not have permission to access this resource.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/authentication-errors"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"403","type":"AUTHENTICATION","code":"FORBIDDEN","title":"Forbidden","detail":"You do not have permission to access this resource.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/authentication-errors"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"48043e80-78ef-489d-9972-930ed2b1da72":{"description":"404 Not Found","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"404","type":"RESOURCE_NOT_FOUND","code":"NOT_FOUND","title":"Not Found","detail":"The requested resource could not be found.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"404","type":"RESOURCE_NOT_FOUND","code":"NOT_FOUND","title":"Not Found","detail":"The requested resource could not be found.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/resource-not-found-errors"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"96b44f0e-85e0-4624-938d-eba1079b6336":{"description":"422 Unprocessable Entity - the interaction doesn't apply to this vehicle","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"422","type":"VALIDATION","code":"INTERACTION_NOT_APPLICABLE","title":"Interaction Not Applicable","detail":"This vehicle doesn't have more than one battery capacity option, so there's nothing for the owner to choose. Read its capacity from the tractionbattery-nominalcapacity signal."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"422","type":"VALIDATION","code":"INTERACTION_NOT_APPLICABLE","title":"Interaction Not Applicable","detail":"This vehicle doesn't have more than one battery capacity option, so there's nothing for the owner to choose. Read its capacity from the tractionbattery-nominalcapacity signal."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"b444213e-680b-4fbc-92b9-2f2742ff656f":{"description":"500 Internal Server Error","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","minItems":1,"items":{"type":"object","required":["status","type","code","title","detail"],"properties":{"status":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].status","typeLabel":"string"},"type":{"type":"string","enum":["AUTHENTICATION","BILLING","COMPATIBILITY","CONNECTED_SERVICES_ACCOUNT","RATE_LIMIT","RESOURCE_NOT_FOUND","SERVER","UPSTREAM","VALIDATION","VEHICLE_STATE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resolution":{"type":"object","description":"Optional field providing guidance on how to resolve the error, if applicable. The structure of this object can vary based on the error type and is intended to provide actionable information to clients.","properties":{"type":{"type":"string","description":"The type of resolution recommended (e.g., \"RETRY_LATER\", \"CONTACT_SUPPORT\", etc.)","uniqueKey":"errors.items.[INDEX].resolution.type","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].resolution","typeLabel":"object"},"suggestedUserMessage":{"type":"string","description":"Optional field providing a user-friendly message that can be displayed to end-users, if applicable. This message is intended to be easily understandable and actionable for users who encounter the error.","uniqueKey":"errors.items.[INDEX].suggestedUserMessage","typeLabel":"string"},"links":{"type":"object","properties":{"about":{"type":"string","format":"uri","uniqueKey":"errors.items.[INDEX].links.about","typeLabel":"string\u003curi>"}},"uniqueKey":"errors.items.[INDEX].links","typeLabel":"object"},"meta":{"type":"object","properties":{"debug":{"type":"object","description":"Debug information for internal use, not intended for clients","properties":{"applicationId":{"type":"string","description":"The unique identifier for the application","uniqueKey":"errors.items.[INDEX].meta.debug.applicationId","typeLabel":"string"},"requestId":{"type":"string","description":"The unique identifier for the request","uniqueKey":"errors.items.[INDEX].meta.debug.requestId","typeLabel":"string"},"origin":{"type":"string","description":"The origin of the error","uniqueKey":"errors.items.[INDEX].meta.debug.origin","typeLabel":"string"}},"example":{"applicationId":"app_123abc","requestId":"req_456def","origin":"internal.com/path"},"uniqueKey":"errors.items.[INDEX].meta.debug","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].meta","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"status":"500","type":"SERVER","code":"INTERNAL","title":"Internal Server Error","detail":"An unexpected error occurred on the server.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/server-errors"}}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"status":"500","type":"SERVER","code":"INTERNAL","title":"Internal Server Error","detail":"An unexpected error occurred on the server.","links":{"about":"https://smartcar.com/docs/errors/api-errors/v3/server-errors"}}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"cc03785f-1ad6-4e48-8100-88a35db307fb":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT or opaque","description":"The Authorization header must be provided with a valid bearer token.\nExample: `Authorization: Bearer {token}`\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"03d4ea0c-9b02-4a24-9712-c7d30e8c95ba":{"url":"https://vehicle.api.smartcar.com/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT or opaque","description":"The Authorization header must be provided with a valid bearer token.\nExample: `Authorization: Bearer {token}`\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The Authorization header must be provided with a valid bearer token.\nExample: `Authorization: Bearer {token}`\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"specs/full-vehicle.yaml"},"subdomain":"smartcar-docs","siteName":"smartcar","title":"Create a select-battery-capacity interaction - smartcar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-23T22:40:29.663Z","originalFileLocation":"api-reference/create-a-select-battery-capacity-interaction.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=\"system\"}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=\"description\" content=\"Creates a URL that takes the vehicle owner to Smartcar Connect to choose the vehicle\u0026#x27;s battery capacity. While the URL\u0026#x27;s token is valid, the owner isn\u0026#x27;t asked to log in again. The token is valid until expiresAt (30 days) at the latest. It may stop being valid earlier, for example after the owner completes a selection or when a newer URL is created for the same vehicle. After that the URL still works, but the owner has to log in first. Returns 422 if the vehicle has fewer than two capacity options, because there\u0026#x27;s nothing for the owner to choose.\">\u003cmeta data-mint-head name=\"application-name\" content=\"smartcar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_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=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a select-battery-capacity interaction - smartcar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a URL that takes the vehicle owner to Smartcar Connect to choose the vehicle\u0026#x27;s battery capacity. While the URL\u0026#x27;s token is valid, the owner isn\u0026#x27;t asked to log in again. The token is valid until expiresAt (30 days) at the latest. It may stop being valid earlier, for example after the owner completes a selection or when a newer URL is created for the same vehicle. After that the URL still works, but the owner has to log in first. Returns 422 if the vehicle has fewer than two capacity options, because there\u0026#x27;s nothing for the owner to choose.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"smartcar\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smartcar-docs.mintlify.app/_mintlify/api/og/v2?division=Interactions\u0026amp;title=Create+a+select-battery-capacity+interaction\u0026amp;description=Creates+a+URL+that+takes+the+vehicle+owner+to+Smartcar+Connect+to%0Achoose+the+vehicle%27s+battery+capacity.+While+the+URL%27s+token+is+valid%2C%0Athe+owner+isn%27t+asked+t\u0026amp;theme=254a1f83924c8d0c1b4b5b15\u0026amp;signature=5606fc44f9ee1e414243af74608a2ffd7c98a1366c8c9f689a673f58f038bd41\">\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=\"Create a select-battery-capacity interaction - smartcar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a URL that takes the vehicle owner to Smartcar Connect to choose the vehicle\u0026#x27;s battery capacity. While the URL\u0026#x27;s token is valid, the owner isn\u0026#x27;t asked to log in again. The token is valid until expiresAt (30 days) at the latest. It may stop being valid earlier, for example after the owner completes a selection or when a newer URL is created for the same vehicle. After that the URL still works, but the owner has to log in first. Returns 422 if the vehicle has fewer than two capacity options, because there\u0026#x27;s nothing for the owner to choose.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smartcar-docs.mintlify.app/_mintlify/api/og/v2?division=Interactions\u0026amp;title=Create+a+select-battery-capacity+interaction\u0026amp;description=Creates+a+URL+that+takes+the+vehicle+owner+to+Smartcar+Connect+to%0Achoose+the+vehicle%27s+battery+capacity.+While+the+URL%27s+token+is+valid%2C%0Athe+owner+isn%27t+asked+t\u0026amp;theme=254a1f83924c8d0c1b4b5b15\u0026amp;signature=5606fc44f9ee1e414243af74608a2ffd7c98a1366c8c9f689a673f58f038bd41\">\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=\"/docs/mintlify-assets/_mintlify/favicons/smartcar-docs/mm2dBjYiMlWQ-TlV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"smartcar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3E577D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/create-a-select-battery-capacity-interaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://smartcar.com/#organization\",\"name\":\"smartcar\",\"url\":\"https://smartcar.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smartcar-docs/YqcNJdgEDgXpXtEG/logo/light.png?fit=max\u0026auto=format\u0026n=YqcNJdgEDgXpXtEG\u0026q=85\u0026s=c8947958467fe403a12f769afada9b53\"}},{\"@type\":\"WebSite\",\"@id\":\"https://smartcar.com/docs#website\",\"name\":\"smartcar\",\"url\":\"https://smartcar.com/docs\",\"publisher\":{\"@id\":\"https://smartcar.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction#webpage\",\"url\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction\",\"name\":\"Create a select-battery-capacity interaction\",\"description\":\"Creates a URL that takes the vehicle owner to Smartcar Connect to choose the vehicle's battery capacity. While the URL's token is valid, the owner isn't asked to log in again. The token is valid until expiresAt (30 days) at the latest. It may stop being valid earlier, for example after the owner completes a selection or when a newer URL is created for the same vehicle. After that the URL still works, but the owner has to log in first. Returns 422 if the vehicle has fewer than two capacity options, because there's nothing for the owner to choose.\",\"dateModified\":\"2026-10-23T22:40:29.663Z\",\"isPartOf\":{\"@id\":\"https://smartcar.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Interactions\",\"item\":\"https://smartcar.com/docs/api-reference/interactions/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a select-battery-capacity interaction\",\"item\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction#apireference\",\"headline\":\"Create a select-battery-capacity interaction\",\"name\":\"Create a select-battery-capacity interaction\",\"description\":\"Creates a URL that takes the vehicle owner to Smartcar Connect to choose the vehicle's battery capacity. While the URL's token is valid, the owner isn't asked to log in again. The token is valid until expiresAt (30 days) at the latest. It may stop being valid earlier, for example after the owner completes a selection or when a newer URL is created for the same vehicle. After that the URL still works, but the owner has to log in first. Returns 422 if the vehicle has fewer than two capacity options, because there's nothing for the owner to choose.\",\"url\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction\",\"mainEntityOfPage\":{\"@id\":\"https://smartcar.com/docs/api-reference/create-a-select-battery-capacity-interaction#webpage\"},\"dateModified\":\"2026-10-23T22:40:29.663Z\",\"publisher\":{\"@id\":\"https://smartcar.com/#organization\"},\"isPartOf\":{\"@id\":\"https://smartcar.com/docs#website\"}}]}\u003c/script>","siteName":"smartcar","nav":{"global":null,"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/introduction"}]},{"tab":"Connecting Vehicles","pages":[{"title":"Connecting Vehicles","href":"/connect/what-is-connect"}]},{"tab":"API \u0026 Integrations Reference","groups":[{"group":"Introduction","pages":[{"title":"Smartcar API Overview","sidebarTitle":"Overview","href":"/api-reference/intro"},{"title":"SDKs","href":"/api-reference/api-sdks"},{"title":"OpenAPI Specifications","sidebarTitle":"OpenAPI Specs","href":"/api-reference/openapi-specs"},{"title":"Permissions","href":"/api-reference/permissions"},{"group":"Errors","pages":[{"title":"Errors Overview","sidebarTitle":"Overview","href":"/api-reference/api-errors"},{"group":"Connect Errors","pages":[{"title":"Access Denied","href":"/errors/connect-errors/access-denied"},{"title":"Invalid Subscription","href":"/errors/connect-errors/invalid-subscription"},{"title":"Configuration","href":"/errors/connect-errors/configuration-error"},{"title":"No Vehicles","href":"/errors/connect-errors/no-vehicles"},{"title":"Server","href":"/errors/connect-errors/server-error"},{"title":"Vehicle Incompatible","href":"/errors/connect-errors/vehicle-incompatible"},{"title":"OEM Login Cancelled","href":"/errors/connect-errors/oem-login-cancelled"},{"title":"User returned to application","href":"/errors/connect-errors/returned-to-application"}]},{"group":"API Errors","pages":[{"title":"Authentication Errors","sidebarTitle":"Authentication","href":"/errors/api-errors/v3/authentication-errors"},{"title":"Billing Errors","sidebarTitle":"Billing","href":"/errors/api-errors/v3/billing-errors"},{"title":"Compatibility Errors","sidebarTitle":"Compatibility","href":"/errors/api-errors/v3/compatibility-errors"},{"title":"Connected Services Account Errors","sidebarTitle":"Connected Services Account","href":"/errors/api-errors/v3/connected-services-account-errors"},{"title":"Rate Limit Errors","sidebarTitle":"Rate Limit","href":"/errors/api-errors/v3/rate-limit-errors"},{"title":"Resource Not Found","href":"/errors/api-errors/v3/resource-not-found-errors"},{"title":"Server Errors","sidebarTitle":"Server","href":"/errors/api-errors/v3/server-errors"},{"title":"Upstream Errors","sidebarTitle":"Upstream","href":"/errors/api-errors/v3/upstream-errors"},{"title":"Validation Errors","sidebarTitle":"Validation","href":"/errors/api-errors/v3/validation-errors"},{"title":"Vehicle State Errors","sidebarTitle":"Vehicle State","href":"/errors/api-errors/v3/vehicle-state-errors"}]},{"title":"Testing Errors","href":"/errors/testing-errors"}]}]},{"group":"Authorization","pages":[{"title":"API Authentication Overview","sidebarTitle":"Overview","href":"/api-reference/authorization/overview"},{"title":"Application Access Token","sidebarTitle":"POST Access Token","openapi":"specs/auth.yaml POST /oauth2/token","playground":"none","href":"/api-reference/authorization/request-access-token"}]},{"group":"Connections","pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml get /connections","href":"/api-reference/list-connections"},{"title":"Get connection","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml get /connections/{connectionId}","href":"/api-reference/get-connection"},{"title":"Remove connection","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml delete /connections/{connectionId}","href":"/api-reference/remove-connection"},{"title":"Remove user","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml delete /users/{userId}","href":"/api-reference/remove-user"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","sidebarTitle":"Overview","tag":"NEW","href":"/integrations/webhooks/overview"},{"title":"Creating Webhooks","href":"/integrations/webhooks/creating-webhooks"},{"title":"Subscribing Vehicles","href":"/integrations/webhooks/subscribing-vehicles"},{"title":"Receiving Webhooks","href":"/integrations/webhooks/receiving-webhooks"},{"title":"Callback URI Verification","href":"/integrations/webhooks/callback-verification"},{"title":"Payload Verification","href":"/integrations/webhooks/payload-verification"},{"group":"Event Reference","pages":[{"title":"Event Reference Overview","sidebarTitle":"Overview","href":"/api-reference/webhooks/events/overview"},{"title":"VERIFY Event","href":"/api-reference/webhooks/events/verify"},{"title":"VEHICLE_STATE Event","href":"/api-reference/webhooks/events/vehicle-state"},{"title":"VEHICLE_ERROR Event","href":"/api-reference/webhooks/events/vehicle-error"}]},{"title":"Delivery Behavior","href":"/api-reference/webhooks/delivery-behavior"},{"group":"Best Practices","pages":[{"title":"Best Practices Overview","sidebarTitle":"Overview","href":"/integrations/webhooks/best-practices/overview"},{"title":"Architecture Patterns","href":"/integrations/webhooks/best-practices/architecture"},{"title":"Security","href":"/integrations/webhooks/best-practices/security"},{"title":"Reliability","href":"/integrations/webhooks/best-practices/reliability"},{"title":"Monitoring \u0026 Observability","sidebarTitle":"Monitoring","href":"/integrations/webhooks/best-practices/monitoring"},{"title":"Testing","href":"/integrations/webhooks/best-practices/testing"}]},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/specs/management.yaml get /subscriptions","href":"/api-reference/list-subscriptions"},{"title":"Create subscription","deprecated":null,"version":null,"openapi":"/specs/management.yaml post /subscriptions","href":"/api-reference/create-subscription"},{"title":"Get subscription","deprecated":null,"version":null,"openapi":"/specs/management.yaml get /subscriptions/{subscriptionId}","href":"/api-reference/get-subscription"},{"title":"Remove subscription","deprecated":null,"version":null,"openapi":"/specs/management.yaml delete /subscriptions/{subscriptionId}","href":"/api-reference/remove-subscription"},{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/specs/management.yaml get /webhooks","href":"/api-reference/list-webhooks"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/specs/management.yaml get /webhooks/{webhookId}","href":"/api-reference/get-webhook"}]},{"group":"Vehicle Data","pages":[{"title":"Get vehicle","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml get /vehicles/{vehicleId}","href":"/api-reference/get-vehicle"},{"title":"List signals","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml get /vehicles/{vehicleId}/signals","href":"/api-reference/list-signals"},{"title":"Get signal","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml get /vehicles/{vehicleId}/signals/{signalCode}","href":"/api-reference/get-signal"}]},{"group":"Vehicle Commands","pages":[{"title":"Commands Overview","sidebarTitle":"Overview","tag":"NEW","href":"/api-reference/commands/overview"},{"title":"Start charging","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/charge/start","href":"/api-reference/charging/start-charging"},{"title":"Stop charging","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/charge/stop","href":"/api-reference/charging/stop-charging"},{"title":"Set charge limit","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/charge/set-limit","href":"/api-reference/charging/set-charge-limit"},{"title":"Open charge port","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/charge-port/open","href":"/api-reference/charging/open-charge-port"},{"title":"Close charge port","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/charge-port/close","href":"/api-reference/charging/close-charge-port"},{"title":"Lock doors","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/security/lock","href":"/api-reference/security/lock-doors"},{"title":"Unlock doors","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/security/unlock","href":"/api-reference/security/unlock-doors"},{"title":"Set destination","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/commands/navigation/set-destination","href":"/api-reference/navigation/set-destination"},{"title":"Set daily charge schedule","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/charge-schedules/daily","href":"/api-reference/charge-schedules/set-daily-charge-schedule"},{"title":"Set weekly charge schedule","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/charge-schedules/weekly","href":"/api-reference/charge-schedules/set-weekly-charge-schedule"},{"title":"Set workweek charge schedule","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/charge-schedules/workweek","href":"/api-reference/charge-schedules/set-workweek-charge-schedule"},{"title":"Delete charge schedule","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml delete /vehicles/{vehicleId}/charge-schedules/{scheduleId}","href":"/api-reference/charge-schedules/delete-charge-schedule"}]},{"group":"Vehicle Settings","pages":[{"title":"Vehicle Settings Overview","sidebarTitle":"Overview","tag":"NEW","href":"/api-reference/settings/overview"},{"title":"Set nominal battery capacity","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /vehicles/{vehicleId}/settings/tractionbattery-nominalcapacity","href":"/api-reference/set-nominal-battery-capacity"}]},{"group":"Interactions","pages":[{"title":"Interactions Overview","sidebarTitle":"Overview","tag":"NEW","description":"Create URLs that send a vehicle owner through a Smartcar-hosted flow, such as selecting their vehicle's battery capacity.","href":"/api-reference/interactions/overview"},{"title":"Create a select-battery-capacity interaction","deprecated":null,"version":null,"openapi":"/specs/full-vehicle.yaml post /interactions/select-battery-capacity","href":"/api-reference/create-a-select-battery-capacity-interaction"}]},{"group":"Compatibility","pages":[{"title":"Compatibility API overview","description":"Vehicle compatibility data by make, model, region, and powertrain, updated daily from the Smartcar platform.","href":"/api-reference/compatibility-api-intro"},{"title":"Compatible Vehicles","sidebarTitle":"Compatible Vehicles","api":"GET https://compatibility.api.smartcar.com/v3/compatible-vehicles","href":"/api-reference/compatible-vehicles"}]},{"group":"API 2.0 Reference (Legacy)","pages":[{"group":"Integration Errors","pages":[{"title":"Authentication Errors","sidebarTitle":"Authentication","href":"/errors/api-errors/authentication-errors"},{"title":"Billing Errors","sidebarTitle":"Billing","href":"/errors/api-errors/billing-errors"},{"title":"Compatibility Errors","sidebarTitle":"Compatibility","href":"/errors/api-errors/compatibility-errors"},{"title":"Connected Services Account Errors","sidebarTitle":"Connected Services Account","href":"/errors/api-errors/connected-services-account-errors"},{"title":"Permission Errors","sidebarTitle":"Permission","href":"/errors/api-errors/permission-errors"},{"title":"Rate Limit Errors","sidebarTitle":"Rate Limit","href":"/errors/api-errors/rate-limit-errors"},{"title":"Resource Not Found","href":"/errors/api-errors/resource-not-found-errors"},{"title":"Server Errors","sidebarTitle":"Server","href":"/errors/api-errors/server-errors"},{"title":"Upstream Errors","sidebarTitle":"Upstream","href":"/errors/api-errors/upstream-errors"},{"title":"Validation Errors","sidebarTitle":"Validation","href":"/errors/api-errors/validation-errors"},{"title":"Vehicle State Errors","sidebarTitle":"Vehicle State","href":"/errors/api-errors/vehicle-state-errors"}]},{"group":"Webhooks","pages":[{"title":"Subscribe","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/subscribe-webhook"},{"title":"Unsubscribe","api":"DELETE https://api.smartcar.com/v2.0/vehicles/{id}/webhooks/{webhook_id}","href":"/api-reference/webhooks/unsubscribe-webhook"}]},{"group":"Vehicle Authorization \u0026 Permissions","pages":[{"title":"API Authentication Overview","sidebarTitle":"Overview","href":"/api-reference/authorization/overview"},{"title":"Auth Code Exchange","api":"POST https://auth.smartcar.com/oauth/token","href":"/api-reference/authorization/auth-code-exchange"},{"title":"Refreshing Access Tokens","sidebarTitle":"Access Token Refresh","api":"POST https://auth.smartcar.com/oauth/token","href":"/api-reference/authorization/refreshing-access-token"},{"title":"Permissions","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/permissions","playground":"none","href":"/api-reference/application-permissions"},{"title":"User","api":"GET https://api.smartcar.com/v2.0/user","playground":"none","href":"/api-reference/user"},{"title":"User Vehicles","api":"GET https://api.smartcar.com/v2.0/vehicles","playground":"none","href":"/api-reference/user-vehicles"}]},{"group":"Vehicle Data","pages":[{"title":"Vehicles API v2.0 Overview","sidebarTitle":"Overview","href":"/api-reference/v2-overview"},{"title":"Headers","href":"/api-reference/headers"},{"title":"Battery Capacity","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/battery/nominal_capacity","playground":"none","href":"/api-reference/get-nominal-capacity"},{"title":"Battery Level","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/battery","href":"/api-reference/evs/get-battery-level"},{"title":"Charge Limit","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/charge/limit","href":"/api-reference/evs/get-charge-limit"},{"title":"Charge Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/charge","href":"/api-reference/evs/get-charge-status"},{"title":"Diagnostic Trouble Codes","sidebarTitle":"Diagnostic Trouble Codes","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/diagnostics/dtcs","playground":"none","href":"/api-reference/get-dtcs"},{"title":"Fuel Tank","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/fuel","playground":"none","href":"/api-reference/get-fuel-tank"},{"title":"Location","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/location","playground":"none","href":"/api-reference/get-location"},{"title":"Lock Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/security","playground":"none","href":"/api-reference/get-lock-status"},{"title":"Odometer","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/odometer","playground":"none","href":"/api-reference/get-odometer"},{"title":"Oil Life","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/engine/oil","playground":"none","href":"/api-reference/get-engine-oil-life"},{"title":"Service History","sidebarTitle":"Service History","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/service/history","playground":"none","href":"/api-reference/get-service-records"},{"title":"System Status","sidebarTitle":"System Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/diagnostics/system_status","playground":"none","href":"/api-reference/get-system-status"},{"title":"Tire Pressure","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/tires/pressure","playground":"none","href":"/api-reference/get-tire-pressure"},{"title":"Vehicle Attributes","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}","playground":"none","href":"/api-reference/get-vehicle-info"},{"title":"VIN","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/vin","playground":"none","href":"/api-reference/get-vin"},{"title":"Batch","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/batch","playground":"none","href":"/api-reference/batch"},{"group":"Make Specific","pages":[{"title":"Make Specific Endpoints","tag":"Deprecated","sidebarTitle":"Make Specific","href":"/api-reference/about-brand-specific"},{"group":"Audi","pages":[{"title":"Audi: Charge Status","sidebarTitle":"Charge","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge","href":"/api-reference/audi/get-charge"}]},{"group":"Chevrolet and Cadillac","pages":[{"title":"Voltage","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/voltmeter","href":"/api-reference/gm/get-charge-voltmeter"},{"title":"Charge Completion Time","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/completion","href":"/api-reference/gm/get-charge-completion-time"}]},{"group":"BMW and MINI","pages":[{"title":"Charge Records","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/records","href":"/api-reference/bmw/get-charge-records"}]},{"group":"Nissan","pages":[{"title":"Charge Schedule","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule","href":"/api-reference/nissan/get-charge-schedule"}]},{"group":"Tesla","pages":[{"title":"Extended Vehicle Info","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/attributes","href":"/api-reference/tesla/get-ext-vehicle-info"},{"title":"User Access","sidebarTitle":"User Access","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/user/access","href":"/api-reference/tesla/get-user-access"},{"title":"Vehicle Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/status","href":"/api-reference/tesla/get-vehicle-status"},{"title":"Tesla: Battery Status","sidebarTitle":"Battery","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/battery","href":"/api-reference/tesla/get-battery"},{"title":"Tesla: Charge Status","sidebarTitle":"Charge","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge","href":"/api-reference/tesla/get-charge"},{"title":"Charge Completion Time","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/completion","href":"/api-reference/tesla/get-charge-completion-time"},{"title":"Charge Billing Records","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/records/billing","href":"/api-reference/tesla/get-charge-records-billing"},{"title":"Charge Schedule","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule","href":"/api-reference/tesla/get-charge-schedule"},{"title":"Charge Schedule","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule","href":"/api-reference/tesla/set-charge-schedule"},{"title":"Wattage","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/wattmeter","href":"/api-reference/tesla/get-charge-wattmeter"},{"title":"Voltage","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/voltmeter","href":"/api-reference/tesla/get-charge-voltmeter"},{"title":"Amperage","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/ammeter","href":"/api-reference/tesla/get-charge-ammeter"},{"title":"Exterior Temperature","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/thermometer/exterior","href":"/api-reference/tesla/get-exterior-temperature"},{"title":"Interior Temperature","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/thermometer/interior","href":"/api-reference/tesla/get-interior-temperature"},{"title":"Speed","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/speedometer","href":"/api-reference/tesla/get-speedometer"},{"title":"Cabin Climate","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/climate/cabin","href":"/api-reference/tesla/get-cabin"},{"title":"Defroster","api":"GET https://api.smartcar.com/v2.0/vehicles/{is}/{make}/climate/defroster","href":"/api-reference/tesla/get-defroster"},{"title":"Steering Heater","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/climate/steering_wheel","href":"/api-reference/tesla/get-steering-heater"},{"title":"Migration Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/migration","href":"/api-reference/tesla/get-migration-status"},{"title":"Virtual Key Status","api":"GET https://api.smartcar.com/v2.0/vehicles/{id}/{make}/virtual_key","href":"/api-reference/tesla/get-virtual-key-status"},{"title":"Charge Port","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/charge_port_door","href":"/api-reference/tesla/control-charge-port"}]}]}]}]},{"group":"Vehicle Commands (Legacy)","pages":[{"title":"Charge Limit","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/charge/limit","href":"/api-reference/evs/set-charge-limit"},{"title":"Start \u0026 Stop Charge","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/charge","href":"/api-reference/evs/control-charge"},{"title":"Lock \u0026 Unlock","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/security","playground":"none","href":"/api-reference/control-lock-unlock"},{"title":"Send Destination","api":"POST https://api.smartcar.com/v2.0/vehicles/{id}/navigation/destination","playground":"none","href":"/api-reference/send-destination-to-vehicle"}]},{"group":"Management API (Legacy)","pages":[{"title":"Management API Overview","href":"/api-reference/management-api-intro"},{"title":"Vehicle Connections","api":"GET https://management.smartcar.com/v2.0/management/connections","href":"/api-reference/management/get-vehicle-connections"},{"title":"Vehicle Connections","api":"DELETE https://management.smartcar.com/v2.0/management/connections","href":"/api-reference/management/delete-vehicle-connections"}]},{"group":"Compatibility API (Legacy)","pages":[{"title":"By VIN (Deprecated)","sidebarTitle":"By VIN","api":"GET https://api.smartcar.com/v2.0/compatibility","tag":"deprecated","href":"/api-reference/compatibility/by-vin"},{"title":"By Region and Make","api":"GET https://api.smartcar.com/v2.0/compatibility/matrix","href":"/api-reference/compatibility/by-region-and-make"}]}]},{"tab":"Vehicle Signals","pages":[{"title":"Vehicle Signals","href":"/api-reference/signals/schema"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/what-is-smartcar"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/latest"}]}]},"basePath":"","title":"Create a select-battery-capacity interaction - smartcar","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CLz2_Z5D.js","utils-7A5jZhOT.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BVWmkKuv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-4SOfrh0F.js","snippetPresets-CMc8KicP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ba9tX7z3.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Be8krXvv.js","shallow-CBC3K1uB.js","getApiPlaygroundDisplay-4tKcUAYo.js","CodeSnippet-C1Xa06ft.js","CodeSnippets-vqiz27A_.js","Page-DeQN5MDd.js","getPastedJson-NUwRfM32.js","icon-DkIVqWh9.js","MethodPill-qmhT7_wz.js","DuplicateIcon-_gWp1vhn.js","createIcon-NA1p_TVA.js","DynamicMarkdown-Bas9A7wq.js","SectionHeading-a1cS-24U.js","axios-vUo_bRtp.js","Markdown-D3ZTwq_a.js","clsx-BcghKhHb.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B66mVNPp.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DmooSyTN.js"]}