Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ChargerDojo","colors":{"primary":"#2e7d32","light":"#4caf50","dark":"#1b5e20"},"navbar":{"links":[{"href":"mailto:support@chargerdojo.com","label":"Support"}],"primary":{"type":"button","label":"Open the app","href":"https://chargerdojo.com"}},"footer":{"socials":{"website":"https://chargerdojo.com"}},"contextual":{"options":["copy","view","claude","chatgpt"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chargerdojo","hasAudioNarration":false,"actualSubdomain":"chargerdojo","customDomains":["docs.chargerdojo.com"],"gitSource":{"type":"github","owner":"chargerdojo","repo":"dojo","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae548b7822a76f502b5f663","collectionId":"4614f20b-829f-4206-857e-bd739529a612","liveDeploymentHistoryId":"6ae548b7822a76f502b5f663","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae548b7822a76f502b5f663","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API reference","count":22},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Journeys","count":8},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Connections","count":5},{"language":"default","tag":"Reports","count":5},{"language":"default","tag":"Testing","count":3},{"language":"default","tag":"Changelog","count":1},{"language":"default","tag":"Usage","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/journeys/preview-a-journey-plan-before-running-it","slug":"/api-reference/journeys/preview-a-journey-plan-before-running-it","pageMetadata":{"title":"Preview a journey plan","description":"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journeys/preview","href":"/api-reference/journeys/preview-a-journey-plan-before-running-it","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\"\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":"Preview a journey plan","description":"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journeys/preview","href":"/api-reference/journeys/preview-a-journey-plan-before-running-it","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"journeys_post_journeys_preview","tags":["Journeys"],"summary":"Preview a journey plan before running it","description":"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.","x-mint":{"metadata":{"title":"Preview a journey plan"}},"security":["08155f67-3586-408e-96fd-b4b529d6bffc"],"requestBody":"d3735ad6-717e-4e89-85fb-08b4b5e20d8a","responses":{"200":"668e8d44-476b-4edf-8508-617d1cbcf8b3","400":"a5976030-99b6-4a5d-83e9-9782710f7096","401":"74b57d2f-dda4-4553-afa0-8f65f1ac7c72","404":"9573f2da-1810-41ce-b4ff-467ea7d7ff92","500":"b4474c5d-3075-41ac-9820-c376085dcf96"},"x-success-status":200,"method":"post","type":"path","servers":["bc4b8cb7-4a81-4b9b-bc02-a87c9788c09a"],"path":"/testing/journeys/preview","baseUrlOptions":["https://chargerdojo.com/api/v1"],"title":"Preview a journey plan before running it","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["schemaVersion","journey","targetId","roleUnderTest","journeyPack","topology","ocpiVersion","clock","session","completion","seed"],"additionalProperties":false,"properties":{"schemaVersion":{"type":"integer","enum":[1],"isRequired":true,"uniqueKey":"schemaVersion","typeLabel":"enum\u003cinteger>"},"journey":{"type":"string","enum":["first-successful-charge","rough-session","charger-reset","partner-connection","catalogue-trust","remote-start-stop","live-price-parking","reservation","cdr-desk","offline-catch-up","hub-routed-charge","book-arrive-charge","direct-terminal-payment","smart-charging-control","hub-connection-status","invalid-charging-data","roaming-hub-identity","roaming-hub-relay","custom"],"isRequired":true,"uniqueKey":"journey","typeLabel":"enum\u003cstring>"},"targetId":{"type":"string","minLength":1,"maxLength":64,"isRequired":true,"uniqueKey":"targetId","typeLabel":"string"},"roleUnderTest":{"type":"string","enum":["CPO","EMSP","PTP","OTHER","SCSP","HUB"],"isRequired":true,"uniqueKey":"roleUnderTest","typeLabel":"enum\u003cstring>"},"journeyPack":{"type":"string","enum":["core-charging","foundation","catalogue","commands","billing","recovery","hub","booking","direct-payment","charging-profiles","hub-client-info","negative","roaming-hub"],"isRequired":true,"uniqueKey":"journeyPack","typeLabel":"enum\u003cstring>"},"topology":{"type":"object","additionalProperties":false,"properties":{"kind":{"type":"string","enum":["direct","hub"],"default":"direct","uniqueKey":"topology.kind","typeLabel":"enum\u003cstring>"},"profile":{"type":"string","enum":["core-ocpi","gireve-2.2.1","plugsurfing-roam-2.2.1"],"default":"core-ocpi","uniqueKey":"topology.profile","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"topology","typeLabel":"object"},"ocpiVersion":{"type":"string","enum":["2.1.1","2.2","2.2.1","2.3.0"],"isRequired":true,"uniqueKey":"ocpiVersion","typeLabel":"enum\u003cstring>"},"clock":{"type":"object","required":["mode","durationSeconds"],"additionalProperties":false,"properties":{"mode":{"type":"string","enum":["real","accelerated"],"isRequired":true,"uniqueKey":"clock.mode","typeLabel":"enum\u003cstring>"},"durationSeconds":{"type":"integer","minimum":60,"maximum":172800,"isRequired":true,"uniqueKey":"clock.durationSeconds","typeLabel":"integer"},"accelerationFactor":{"type":"integer","minimum":1,"maximum":3600,"uniqueKey":"clock.accelerationFactor","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"clock","typeLabel":"object"},"session":{"type":"object","required":["cadenceSeconds","strategy","updates"],"additionalProperties":false,"properties":{"cadenceSeconds":{"type":"integer","minimum":1,"maximum":86400,"isRequired":true,"uniqueKey":"session.cadenceSeconds","typeLabel":"integer"},"strategy":{"type":"string","enum":["put-only","put-and-patch"],"isRequired":true,"uniqueKey":"session.strategy","typeLabel":"enum\u003cstring>"},"updates":{"type":"array","minItems":1,"maxItems":4,"items":{"type":"string","enum":["kwh","total_cost","status","charging_periods"],"uniqueKey":"session.updates.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"session.updates","typeLabel":"enum\u003cstring>[]"},"jitterSeconds":{"type":"integer","minimum":0,"maximum":3600,"default":0,"uniqueKey":"session.jitterSeconds","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"session","typeLabel":"object"},"completion":{"type":"object","additionalProperties":false,"properties":{"cdrDelaySeconds":{"type":"integer","minimum":0,"maximum":172800,"default":0,"uniqueKey":"completion.cdrDelaySeconds","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"completion","typeLabel":"object"},"seed":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"seed","typeLabel":"string"},"pairedTargetId":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"pairedTargetId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"schemaVersion":1,"targetId":"\u003cstring>","topology":{"kind":"direct","profile":"core-ocpi"},"clock":{"durationSeconds":86430,"accelerationFactor":1800},"session":{"cadenceSeconds":43200,"updates":[],"jitterSeconds":0},"completion":{"cdrDelaySeconds":0},"seed":"\u003cstring>","pairedTargetId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"668e8d44-476b-4edf-8508-617d1cbcf8b3":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["success","data"],"properties":{"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","required":["planId","planHash","runAllowed","plan"],"properties":{"planId":{"type":"string","isRequired":true,"uniqueKey":"data.planId","typeLabel":"string"},"planHash":{"type":"string","isRequired":true,"uniqueKey":"data.planHash","typeLabel":"string"},"runAllowed":{"type":"boolean","isRequired":true,"uniqueKey":"data.runAllowed","typeLabel":"boolean"},"plan":{"type":"object","description":"Compiled plan summary with stages and preflight. Carries `ignoredDisturbances` when the manifest names a disturbance this journey accepts and does not use.","isRequired":true,"uniqueKey":"data.plan","typeLabel":"object"},"expiresInSeconds":{"type":"integer","uniqueKey":"data.expiresInSeconds","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","description":"Paging, on the operations that return a list.","properties":{"limit":{"type":"integer","uniqueKey":"meta.limit","typeLabel":"integer"},"skip":{"type":"integer","uniqueKey":"meta.skip","typeLabel":"integer"},"nextCursor":{"type":"string","uniqueKey":"meta.nextCursor","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"planId":"\u003cstring>","planHash":"\u003cstring>","runAllowed":true,"plan":{},"expiresInSeconds":123},"meta":{"limit":123,"skip":123,"nextCursor":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a5976030-99b6-4a5d-83e9-9782710f7096":{"description":"Malformed input","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"capability":{"type":"string","enum":["external-endpoints","ci-handoff","saved-presets","roaming-hub-identity","load-testing","direct-payment","bookings","scheduled-runs","roaming-hub-relay","partner-profiles"],"uniqueKey":"capability","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","required":["id","used","cap"],"properties":{"id":{"type":"string","enum":["connections","run-concurrency"],"isRequired":true,"uniqueKey":"limit.id","typeLabel":"enum\u003cstring>"},"used":{"type":"integer","isRequired":true,"uniqueKey":"limit.used","typeLabel":"integer"},"cap":{"type":"integer","isRequired":true,"uniqueKey":"limit.cap","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","status":"error","code":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","capability":"external-endpoints","limit":{"id":"connections","used":123,"cap":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"74b57d2f-dda4-4553-afa0-8f65f1ac7c72":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"capability":{"type":"string","enum":["external-endpoints","ci-handoff","saved-presets","roaming-hub-identity","load-testing","direct-payment","bookings","scheduled-runs","roaming-hub-relay","partner-profiles"],"uniqueKey":"capability","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","required":["id","used","cap"],"properties":{"id":{"type":"string","enum":["connections","run-concurrency"],"isRequired":true,"uniqueKey":"limit.id","typeLabel":"enum\u003cstring>"},"used":{"type":"integer","isRequired":true,"uniqueKey":"limit.used","typeLabel":"integer"},"cap":{"type":"integer","isRequired":true,"uniqueKey":"limit.cap","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","status":"error","code":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","capability":"external-endpoints","limit":{"id":"connections","used":123,"cap":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"9573f2da-1810-41ce-b4ff-467ea7d7ff92":{"description":"Not found, or owned by another account","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"capability":{"type":"string","enum":["external-endpoints","ci-handoff","saved-presets","roaming-hub-identity","load-testing","direct-payment","bookings","scheduled-runs","roaming-hub-relay","partner-profiles"],"uniqueKey":"capability","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","required":["id","used","cap"],"properties":{"id":{"type":"string","enum":["connections","run-concurrency"],"isRequired":true,"uniqueKey":"limit.id","typeLabel":"enum\u003cstring>"},"used":{"type":"integer","isRequired":true,"uniqueKey":"limit.used","typeLabel":"integer"},"cap":{"type":"integer","isRequired":true,"uniqueKey":"limit.cap","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","status":"error","code":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","capability":"external-endpoints","limit":{"id":"connections","used":123,"cap":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"b4474c5d-3075-41ac-9820-c376085dcf96":{"description":"Error","content":{"application/json":{"schema":{"type":"object","required":["success","message"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"capability":{"type":"string","enum":["external-endpoints","ci-handoff","saved-presets","roaming-hub-identity","load-testing","direct-payment","bookings","scheduled-runs","roaming-hub-relay","partner-profiles"],"uniqueKey":"capability","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","required":["id","used","cap"],"properties":{"id":{"type":"string","enum":["connections","run-concurrency"],"isRequired":true,"uniqueKey":"limit.id","typeLabel":"enum\u003cstring>"},"used":{"type":"integer","isRequired":true,"uniqueKey":"limit.used","typeLabel":"integer"},"cap":{"type":"integer","isRequired":true,"uniqueKey":"limit.cap","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"\u003cstring>","status":"error","code":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","capability":"external-endpoints","limit":{"id":"connections","used":123,"cap":123}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"08155f67-3586-408e-96fd-b4b529d6bffc":{"apiKey":{"type":"http","scheme":"bearer","description":"A cdojo_... API key created in the app under Settings.","scopes":[],"schemeName":"apiKey"}}},"servers":{"bc4b8cb7-4a81-4b9b-bc02-a87c9788c09a":{"url":"https://chargerdojo.com/api/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A cdojo_... API key created in the app under Settings.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A cdojo_... API key created in the app under Settings.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi/public-api.json"},"subdomain":"chargerdojo","siteName":"ChargerDojo","title":"Preview a journey plan - ChargerDojo","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T06:31:58.883Z","originalFileLocation":"api-reference/journeys/preview-a-journey-plan-before-running-it.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=\"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ChargerDojo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/chargerdojo/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/chargerdojo/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/chargerdojo/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/chargerdojo/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview a journey plan - ChargerDojo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ChargerDojo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chargerdojo.mintlify.app/_mintlify/api/og/v2?division=Journeys\u0026amp;title=Preview+a+journey+plan\u0026amp;description=Compile+a+journey+into+a+runnable+plan+and+save+it+without+running+it%2C+so+you+can+read+the+stages+and+the+preflight+before+anything+reaches+your+partner.\u0026amp;theme=c0bfa893092812bd23cb353f\u0026amp;signature=ed0150d07e9fd3c505270e19921cc37f8434b88d56435e84d748a80d5f5be2ea\">\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=\"Preview a journey plan - ChargerDojo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chargerdojo.mintlify.app/_mintlify/api/og/v2?division=Journeys\u0026amp;title=Preview+a+journey+plan\u0026amp;description=Compile+a+journey+into+a+runnable+plan+and+save+it+without+running+it%2C+so+you+can+read+the+stages+and+the+preflight+before+anything+reaches+your+partner.\u0026amp;theme=c0bfa893092812bd23cb353f\u0026amp;signature=ed0150d07e9fd3c505270e19921cc37f8434b88d56435e84d748a80d5f5be2ea\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/chargerdojo/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ChargerDojo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2e7d32\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/journeys/preview-a-journey-plan-before-running-it.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.chargerdojo.com/#organization\",\"name\":\"ChargerDojo\",\"url\":\"https://docs.chargerdojo.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.chargerdojo.com#website\",\"name\":\"ChargerDojo\",\"url\":\"https://docs.chargerdojo.com\",\"publisher\":{\"@id\":\"https://docs.chargerdojo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it#webpage\",\"url\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it\",\"name\":\"Preview a journey plan\",\"description\":\"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\",\"dateModified\":\"2026-10-30T06:31:58.883Z\",\"isPartOf\":{\"@id\":\"https://docs.chargerdojo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.chargerdojo.com/api-reference/connections/list-owned-connections\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Journeys\",\"item\":\"https://docs.chargerdojo.com/api-reference/journeys/browse-the-journey-catalogue-for-a-target\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Preview a journey plan\",\"item\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it#apireference\",\"headline\":\"Preview a journey plan\",\"name\":\"Preview a journey plan\",\"description\":\"Compile a journey into a runnable plan and save it without running it, so you can read the stages and the preflight before anything reaches your partner.\",\"url\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it\",\"mainEntityOfPage\":{\"@id\":\"https://docs.chargerdojo.com/api-reference/journeys/preview-a-journey-plan-before-running-it#webpage\"},\"dateModified\":\"2026-10-30T06:31:58.883Z\",\"publisher\":{\"@id\":\"https://docs.chargerdojo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.chargerdojo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ChargerDojo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ChargerDojo","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"ChargerDojo documentation","href":"/index"},{"title":"What you can do without paying","href":"/guide/what-is-free"},{"title":"Plans and pricing","href":"/guide/plans"},{"title":"Connect a coding agent","href":"/guide/connect-a-coding-agent"},{"title":"Quickstart: your first run from the command line","href":"/guide/quickstart"},{"title":"Create an API key","href":"/guide/create-an-api-key"},{"title":"API overview","href":"/api/index"}]},{"group":"Guides","pages":[{"title":"Automate ChargerDojo","href":"/guide/index"},{"title":"Connect a partner endpoint","href":"/guide/connect-a-partner"},{"title":"Let a partner register with you","href":"/guide/let-a-partner-register"},{"title":"Connect a local endpoint","href":"/guide/connect-a-local-endpoint"},{"title":"Use the connector","href":"/guide/use-the-connector"},{"title":"Run a conformance suite","href":"/guide/run-a-suite"},{"title":"Read your report","href":"/guide/read-your-report"},{"title":"Check a payload","href":"/guide/check-a-payload"},{"title":"Share a report with your partner","href":"/guide/share-a-report"},{"title":"Work with a colleague","href":"/guide/work-with-a-colleague"},{"title":"Run a charging journey","href":"/guide/run-a-charging-journey"},{"title":"Author a custom journey","href":"/guide/author-a-scenario"},{"title":"Test a roaming hub","href":"/guide/test-a-roaming-hub"},{"title":"Glossary","href":"/guide/glossary"},{"title":"Troubleshooting","href":"/guide/troubleshooting"}]},{"group":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"group":"API reference","pages":[{"group":"Connections","pages":[{"title":"List owned connections","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /connections","href":"/api-reference/connections/list-owned-connections"},{"title":"Create a partner endpoint","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /connections","href":"/api-reference/connections/create-a-partner-endpoint"},{"title":"Run the credentials handshake","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /connections/{id}/register","href":"/api-reference/connections/run-the-ocpi-credentials-handshake-for-an-owned-connection"},{"title":"Change a connection's address","deprecated":null,"version":null,"openapi":"/openapi/public-api.json put /connections/{id}/address","href":"/api-reference/connections/change-a-connections-address"},{"title":"Read one owned connection","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /connections/{id}","href":"/api-reference/connections/read-one-owned-connection"}]},{"group":"Testing","pages":[{"title":"List runnable conformance suites","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/suites","href":"/api-reference/testing/list-runnable-conformance-suites"},{"title":"Start a conformance run","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/runs","href":"/api-reference/testing/start-a-conformance-run-against-an-owned-connection"},{"title":"Send an OCPI command","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/command","href":"/api-reference/testing/send-one-bounded-ocpi-command-through-an-owned-registered-connection"}]},{"group":"Reports","pages":[{"title":"List run reports","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/runs","href":"/api-reference/reports/list-owned-run-reports-conformance-and-journeys"},{"title":"Read a run report","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/runs/{id}","href":"/api-reference/reports/read-one-owned-report-optionally-long-polling-an-active-run"},{"title":"Delete a report you own","deprecated":null,"version":null,"openapi":"/openapi/public-api.json delete /testing/runs/{id}","href":"/api-reference/reports/delete-a-report-you-own"},{"title":"Share a report","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/runs/{id}/share","href":"/api-reference/reports/issue-a-public-share-token-for-an-owned-report"},{"title":"Revoke a report share token","deprecated":null,"version":null,"openapi":"/openapi/public-api.json delete /testing/runs/{id}/share","href":"/api-reference/reports/revoke-the-public-share-token-of-an-owned-report"}]},{"group":"Usage","pages":[{"title":"Read plan limits and usage","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /usage","href":"/api-reference/usage/read-the-key-owners-plan-limits-and-current-usage"}]},{"group":"Journeys","pages":[{"title":"Browse the journey catalogue","description":"List the charging journey templates, packs and custom journeys available for a target, with the OCPI versions each one supports.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/journeys","href":"/api-reference/journeys/browse-the-journey-catalogue-for-a-target"},{"title":"Preview a journey plan","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journeys/preview","href":"/api-reference/journeys/preview-a-journey-plan-before-running-it"},{"title":"Start a journey run","description":"Start a journey run from a previewed plan. Pass an Idempotency-Key so a retried request returns the original run instead of starting a second one.","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journey-runs","href":"/api-reference/journeys/start-a-journey-run-from-a-previewed-plan-idempotent"},{"title":"Read journey run status","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/journey-runs/{id}","href":"/api-reference/journeys/read-a-journey-runs-status-and-recovery-options"},{"title":"Cancel a journey run","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journey-runs/{id}/cancel","href":"/api-reference/journeys/cancel-a-journey-run-you-own"},{"title":"Apply a server-offered recovery decision","deprecated":null,"version":null,"openapi":"/openapi/public-api.json post /testing/journey-runs/{id}/recovery","href":"/api-reference/journeys/apply-a-server-offered-recovery-decision"},{"title":"Page journey run events","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/journey-runs/{id}/events","href":"/api-reference/journeys/page-a-journey-runs-events-by-sequence"},{"title":"Replay then follow run events over SSE","deprecated":null,"version":null,"openapi":"/openapi/public-api.json get /testing/journey-runs/{id}/stream","href":"/api-reference/journeys/replay-then-follow-run-events-over-sse"}]}]}]},"basePath":"","title":"Preview a journey plan - ChargerDojo","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}