{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Versori User Documentation","colors":{"primary":"#6EB0D8","light":"#6EB0D8","dark":"#6EB0D8"},"logo":{"light":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af","dark":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark-white.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1568a99dadb6fa8dfc83009eba877497"},"favicon":"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=1765cb3e4363526dd85cf7c576a8f68f","api":{"openapi":["openapi/connect-api-v1.yaml","openapi/embedded-api-v1.yaml","openapi/organisations-api-v1.yaml","openapi/switchboard-api-v1alpha1.yaml","openapi/platform-api.yaml"],"playground":{"display":"interactive","proxy":false},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://platform.versori.com/api"]}},"background":{"decoration":"gradient","color":{"light":"#ffffff","dark":"#151919"}},"search":{"prompt":"Search the docs..."},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"versori","hasAudioNarration":false,"actualSubdomain":"versori","customDomains":["docs.versori.com"],"gitSource":{"type":"github","owner":"versori","repo":"user-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad09d9413e5d952c6a7407c","collectionId":"314b2d25-0631-41c2-aeae-fdf8104d942c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad09d9413e5d952c6a7407c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad09d9413e5d952c6a7407c","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API Reference","count":525},{"language":"default","tag":"Platform API","count":115},{"language":"default","tag":"Switchboard API","count":82},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"Connect API","count":41},{"language":"default","tag":"Organisations API","count":38},{"language":"default","tag":"Documentation","count":32},{"language":"default","tag":"projects","count":32},{"language":"default","tag":"User Guide","count":31},{"language":"default","tag":"CLI","count":27}]},"assistantConfig":{},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"#content-area.max-w-xl{max-width:64rem}.whitespace-pre-line{white-space:unset}"}],"page":{"pagePath":"latest/api-reference/platform-api/getting-started","slug":"/latest/api-reference/platform-api/getting-started","pageMetadata":{"title":"Getting Started","description":"Get started with the Versori Platform API.","href":"/latest/api-reference/platform-api/getting-started"},"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: \"Get started with the Versori Platform API.\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`TBA`})}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":"Getting Started","description":"Get started with the Versori Platform API.","href":"/latest/api-reference/platform-api/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"versori","siteName":"Versori User Documentation","title":"Getting Started - Versori User Documentation","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/latest/api-reference/platform-api/getting-started","matchLevel":0},"Legacy":{"href":"/legacy/welcome","matchLevel":4},"v2":{"href":"/v2/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T11:43:55.649Z","originalFileLocation":"latest/api-reference/platform-api/getting-started.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=\"Get started with the Versori Platform API.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting Started - Versori User Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started with the Versori Platform API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Versori User Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.versori.com/latest/api-reference/platform-api/getting-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Get+started+with+the+Versori+Platform+API.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=d8755646eb48a91e10c84df35502163ef5d2143e46ff58831a4fd37f14748194\">\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=\"Getting Started - Versori User Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started with the Versori Platform API.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://versori.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Getting+Started\u0026amp;description=Get+started+with+the+Versori+Platform+API.\u0026amp;theme=1ac70f2532992ffb34bd6aef\u0026amp;signature=d8755646eb48a91e10c84df35502163ef5d2143e46ff58831a4fd37f14748194\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/versori/JHvcKEOb4limbJz2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Versori User Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6EB0D8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.versori.com/latest/api-reference/platform-api/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/latest/api-reference/platform-api/getting-started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.versori.com/#organization\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/versori/PWNCaMS5nGiiWoff/logo/versori-logo-wordmark.svg?fit=max\u0026auto=format\u0026n=PWNCaMS5nGiiWoff\u0026q=85\u0026s=be10819ca139d000a6edaef35334c0af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.versori.com#website\",\"name\":\"Versori User Documentation\",\"url\":\"https://docs.versori.com\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.versori.com/latest/api-reference/platform-api/getting-started#webpage\",\"url\":\"https://docs.versori.com/latest/api-reference/platform-api/getting-started\",\"name\":\"Getting Started\",\"description\":\"Get started with the Versori Platform API.\",\"dateModified\":\"2026-01-23T11:43:55.649Z\",\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.versori.com/latest/api-reference/platform-api/getting-started#article\",\"headline\":\"Getting Started\",\"name\":\"Getting Started\",\"description\":\"Get started with the Versori Platform API.\",\"url\":\"https://docs.versori.com/latest/api-reference/platform-api/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://docs.versori.com/latest/api-reference/platform-api/getting-started#webpage\"},\"dateModified\":\"2026-01-23T11:43:55.649Z\",\"publisher\":{\"@id\":\"https://docs.versori.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.versori.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Versori User Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Versori User Documentation","nav":{"global":null,"versions":[{"version":"Latest","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/latest/home"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/latest/guides/getting-started/chat"}]},{"tab":"Run SDK","dropdowns":[{"dropdown":"Latest (0.4.x)","groups":[{"group":"Getting Started","expanded":true,"pages":[{"title":"Run SDK","sidebarTitle":"Introduction","href":"/latest/run-sdk/latest/introduction"},{"title":"Connections","href":"/latest/run-sdk/latest/connections"},{"group":"Workflows, Triggers and Tasks","pages":[{"title":"Workflows, Triggers and Tasks","sidebarTitle":"Overview","href":"/latest/run-sdk/latest/workflows"},{"title":"Inputs and outputs","href":"/latest/run-sdk/latest/workflows/inputs-outputs"},{"title":"Task Types","href":"/latest/run-sdk/latest/workflows/task-types"},{"title":"Background","href":"/latest/run-sdk/latest/workflows/background"},{"title":"Catch","href":"/latest/run-sdk/latest/workflows/catch"}]},{"title":"The Context Object","href":"/latest/run-sdk/latest/context"},{"title":"Durable Workflows","href":"/latest/run-sdk/latest/durable-workflows"}]},{"group":"Developers","pages":[{"title":"Developers Overview","sidebarTitle":"Overview","href":"/latest/run-sdk/latest/developers/overview"}]}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/latest/cli/introduction"}]},{"tab":"AI Tooling","pages":[{"title":"AI Tooling","href":"/latest/ai-tooling/cloud-agents"}]},{"tab":"API Reference","anchors":[{"anchor":"Overview","pages":[{"title":"Overview","href":"/latest/api-reference/getting-started"}]},{"anchor":"Platform API","icon":"cloud","pages":[{"title":"Getting Started","href":"/latest/api-reference/platform-api/getting-started"},{"group":"API Reference","pages":[{"group":"end_users","pages":[{"title":"Activates a User on an Environment.","description":"ActivateUser activates a user on an environment. This will create a new activation record for the user on the environment.\nConnections must be made for all environment systems to be successfully activated.\n","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/activations","href":"/api-reference/platform-api/end_users/activates-a-user-on-an-environment"},{"title":"List End Users","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/users","href":"/api-reference/platform-api/end_users/list-end-users"},{"title":"Create an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/users","href":"/api-reference/platform-api/end_users/create-an-end-user"},{"title":"Retrieve an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/users/{user_id}","href":"/api-reference/platform-api/end_users/retrieve-an-end-user"},{"title":"Delete an End User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/users/{user_id}","href":"/api-reference/platform-api/end_users/delete-an-end-user"}]},{"group":"execution_pools","pages":[{"title":"List available execution pools.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/execution-pools","href":"/api-reference/platform-api/execution_pools/list-available-execution-pools"}]},{"group":"projects","pages":[{"title":"List projects for organisation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects","href":"/api-reference/platform-api/projects/list-projects-for-organisation"},{"title":"Create new project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects","href":"/api-reference/platform-api/projects/create-new-project"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/get-project"},{"title":"Update Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/update-project"},{"title":"Delete Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}","href":"/api-reference/platform-api/projects/delete-project"},{"title":"Clone Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/clone","href":"/api-reference/platform-api/projects/clone-project"},{"title":"Clone Environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/clone","href":"/api-reference/platform-api/projects/clone-environment"},{"title":"Sync Environments","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/sync","href":"/api-reference/platform-api/projects/sync-environments"},{"title":"Get project variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/get-project-variables"},{"title":"Set the schema for the project variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/set-the-schema-for-the-project-variables"},{"title":"Patch the schema for the project's dynamic variables","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/projects/{project_id}/variables","href":"/api-reference/platform-api/projects/patch-the-schema-for-the-projects-dynamic-variables"},{"title":"Add sentiment data to project history","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/sentiment","href":"/api-reference/platform-api/projects/add-sentiment-data-to-project-history"},{"title":"Get Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/get-files"},{"title":"Update Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/update-files"},{"title":"Patch Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/projects/{project_id}/files","href":"/api-reference/platform-api/projects/patch-files"},{"title":"Change the execution pool of an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/environments/execution-pools","href":"/api-reference/platform-api/projects/change-the-execution-pool-of-an-environment"},{"title":"Call Integration","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/environments/call","href":"/api-reference/platform-api/projects/call-integration"},{"title":"Deploy Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/deploy","href":"/api-reference/platform-api/projects/deploy-project"},{"title":"Deploy Project Version","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/versions/{version_id}/deploy","href":"/api-reference/platform-api/projects/deploy-project-version"},{"title":"Start Test Container","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/testing/start","href":"/api-reference/platform-api/projects/start-test-container"},{"title":"Start test workflow","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/testing/trigger/{trigger_name}","href":"/api-reference/platform-api/projects/start-test-workflow"},{"title":"Validate Project Files","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/validate","href":"/api-reference/platform-api/projects/validate-project-files"},{"title":"Get Project Logs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/logs","href":"/api-reference/platform-api/projects/get-project-logs"},{"title":"Search project logs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/logs","href":"/api-reference/platform-api/projects/search-project-logs"},{"title":"List project traces","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/traces","href":"/api-reference/platform-api/projects/list-project-traces"},{"title":"Get Trace","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/traces/{trace_id}","href":"/api-reference/platform-api/projects/get-trace"},{"title":"Get integration flows","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/workflows","href":"/api-reference/platform-api/projects/get-integration-flows"},{"title":"Get integration flow by name","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/get-integration-flow-by-name"},{"title":"Update integration flow","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/update-integration-flow"},{"title":"Delete integration flow","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}/workflows/{flow_name}","href":"/api-reference/platform-api/projects/delete-integration-flow"},{"title":"Suspend Project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/suspend","href":"/api-reference/platform-api/projects/suspend-project"},{"title":"UpdateEnvironmentConfig updates the environment config for infrastructure.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/environments/{environment_id}/config","href":"/api-reference/platform-api/projects/updateenvironmentconfig-updates-the-environment-config-for-infrastructure"}]},{"group":"versions","pages":[{"title":"Lists versions for a project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/versions","href":"/api-reference/platform-api/versions/lists-versions-for-a-project"},{"title":"Create a new version for a project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/versions","href":"/api-reference/platform-api/versions/create-a-new-version-for-a-project"},{"title":"Get Files for a given version","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/versions/{version_id}/files","href":"/api-reference/platform-api/versions/get-files-for-a-given-version"}]},{"group":"connections","pages":[{"title":"List Connections","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/connections","href":"/api-reference/platform-api/connections/list-connections"},{"title":"Create a new connection.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/connections","href":"/api-reference/platform-api/connections/create-a-new-connection"},{"title":"Get a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/get-a-connection-by-id"},{"title":"Update a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/update-a-connection-by-id"},{"title":"Delete a Connection by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/connections/{connection_id}","href":"/api-reference/platform-api/connections/delete-a-connection-by-id"},{"title":"Link an existing connection to an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/connections/{connection_id}/link","href":"/api-reference/platform-api/connections/link-an-existing-connection-to-an-environment"},{"title":"Unlink a connection from an environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/connections/{connection_id}/link","href":"/api-reference/platform-api/connections/unlink-a-connection-from-an-environment"},{"title":"Retrieve the connection for the activations.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environment-systems/{env_system_id}/activations/{activation_id}","href":"/api-reference/platform-api/connections/retrieve-the-connection-for-the-activations"},{"title":"List static connections for project environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/connections","href":"/api-reference/platform-api/connections/list-static-connections-for-project-environment"},{"title":"Initialise OAuth 2.0 Connection","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/oauth2/initialise","href":"/api-reference/platform-api/connections/initialise-oauth-20-connection"},{"title":"Initialise OAuth 1.0 Connection","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/oauth1/initialise","href":"/api-reference/platform-api/connections/initialise-oauth-10-connection"}]},{"group":"automations","pages":[{"title":"List Automations","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations","href":"/api-reference/platform-api/automations/list-automations"},{"title":"Create a new automation.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations","href":"/api-reference/platform-api/automations/create-a-new-automation"},{"title":"List Automation Runs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/run","href":"/api-reference/platform-api/automations/list-automation-runs"},{"title":"Run an Automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/run","href":"/api-reference/platform-api/automations/run-an-automation"},{"title":"Get an Automation by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}","href":"/api-reference/platform-api/automations/get-an-automation-by-id"},{"title":"Update an Automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/automations/{automation_id}","href":"/api-reference/platform-api/automations/update-an-automation"},{"title":"List Recordings","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/recordings","href":"/api-reference/platform-api/automations/list-recordings"},{"title":"Create a recording for an automation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/recordings","href":"/api-reference/platform-api/automations/create-a-recording-for-an-automation"},{"title":"Get an Automation Run by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/runs/{run_id}","href":"/api-reference/platform-api/automations/get-an-automation-run-by-id"},{"title":"Get a recording by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}","href":"/api-reference/platform-api/automations/get-a-recording-by-id"},{"title":"Create a transcription for a recording","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/automations/{automation_id}/recordings/{recording_id}","href":"/api-reference/platform-api/automations/create-a-transcription-for-a-recording"}]},{"group":"schedulers","pages":[{"title":"List Schedulers","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/schedulers","href":"/api-reference/platform-api/schedulers/list-schedulers"},{"title":"Get a Scheduler by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}","href":"/api-reference/platform-api/schedulers/get-a-scheduler-by-id"}]},{"group":"API Reference","pages":[{"title":"Trigger a Scheduler once","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/environments/{environment_id}/schedulers/{scheduler_id}","href":"/api-reference/platform-api/trigger-a-scheduler-once"}]},{"group":"activations","pages":[{"title":"List Activations","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/activations","href":"/api-reference/platform-api/activations/list-activations"},{"title":"Retrieve an Activation by ID","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","href":"/api-reference/platform-api/activations/retrieve-an-activation-by-id"},{"title":"Delete an Activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}","href":"/api-reference/platform-api/activations/delete-an-activation"},{"title":"Set static variables for the static activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/environments/{environment_id}/variables","href":"/api-reference/platform-api/activations/set-static-variables-for-the-static-activation"},{"title":"Set dynamic variables for an activation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables","href":"/api-reference/platform-api/activations/set-dynamic-variables-for-an-activation"},{"title":"Set a dynamic variable by name","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/environments/{environment_id}/activations/{activation_id}/variables/{variable_name}","href":"/api-reference/platform-api/activations/set-a-dynamic-variable-by-name"},{"title":"List Activations for User","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/environment/{environment_id}/users/{external_user_id}/activations","href":"/api-reference/platform-api/activations/list-activations-for-user"}]},{"group":"systems","pages":[{"title":"Lists the systems for the organisation.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems","href":"/api-reference/platform-api/systems/lists-the-systems-for-the-organisation"},{"title":"Create a new system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems","href":"/api-reference/platform-api/systems/create-a-new-system"},{"title":"Get a system by ID.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/get-a-system-by-id"},{"title":"Update system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/update-system"},{"title":"Delete a system by ID.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}","href":"/api-reference/platform-api/systems/delete-a-system-by-id"},{"title":"Link system actions to project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/projects/{project_id}/actions-link","href":"/api-reference/platform-api/systems/link-system-actions-to-project"},{"title":"Link system triggers to project.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/projects/{project_id}/triggers-link","href":"/api-reference/platform-api/systems/link-system-triggers-to-project"},{"title":"List actions for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/actions","href":"/api-reference/platform-api/systems/list-actions-for-a-system"},{"title":"Create new actions for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/actions","href":"/api-reference/platform-api/systems/create-new-actions-for-a-system"},{"title":"Get an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/get-an-action-for-a-system"},{"title":"Update an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/update-an-action-for-a-system"},{"title":"Delete an action for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}/actions/{action_id}","href":"/api-reference/platform-api/systems/delete-an-action-for-a-system"},{"title":"List triggers for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/systems/{system_id}/triggers","href":"/api-reference/platform-api/systems/list-triggers-for-a-system"},{"title":"Create new triggers for a system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/systems/{system_id}/triggers","href":"/api-reference/platform-api/systems/create-new-triggers-for-a-system"},{"title":"Adds or updates an auth scheme for the system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","href":"/api-reference/platform-api/systems/adds-or-updates-an-auth-scheme-for-the-system"},{"title":"Deletes an auth scheme for the system.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/systems/{system_id}/auth-scheme-configs/{auth_scheme_config_id}","href":"/api-reference/platform-api/systems/deletes-an-auth-scheme-for-the-system"},{"title":"List project environment connection templates","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/{project_id}/connection-templates","href":"/api-reference/platform-api/systems/list-project-environment-connection-templates"},{"title":"Create a new connection template","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/projects/{project_id}/connection-templates","href":"/api-reference/platform-api/systems/create-a-new-connection-template"},{"title":"Remove a system from a project environment","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","href":"/api-reference/platform-api/systems/remove-a-system-from-a-project-environment"},{"title":"Remove a connection template","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/projects/{project_id}/connection-templates/{template_id}","href":"/api-reference/platform-api/systems/remove-a-connection-template"}]},{"group":"issues","pages":[{"title":"List Issues","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/issues","href":"/api-reference/platform-api/issues/list-issues"},{"title":"Create a new issue.","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/issues","href":"/api-reference/platform-api/issues/create-a-new-issue"},{"title":"Update an Issue","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml patch /o/{organisation_id}/issues/{issue_id}","href":"/api-reference/platform-api/issues/update-an-issue"}]},{"group":"notifications","pages":[{"title":"List notification channels for an organisation","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/notification_channels","href":"/api-reference/platform-api/notifications/list-notification-channels-for-an-organisation"},{"title":"Post o notification channels","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/notification_channels","href":"/api-reference/platform-api/notifications/post-o-notification_channels"},{"title":"Delete a notification channel","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /o/{organisation_id}/notification_channels/{channel_id}","href":"/api-reference/platform-api/notifications/delete-a-notification-channel"},{"title":"List notifications for a project","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /projects/{project_id}/notifications","href":"/api-reference/platform-api/notifications/list-notifications-for-a-project"},{"title":"Create a new project notification","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /projects/{project_id}/notifications","href":"/api-reference/platform-api/notifications/create-a-new-project-notification"},{"title":"Delete a project notification","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /projects/{project_id}/notifications/{notification_id}","href":"/api-reference/platform-api/notifications/delete-a-project-notification"}]},{"group":"metrics","pages":[{"title":"Get organisation metrics summary","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/metricssummary","href":"/api-reference/platform-api/metrics/get-organisation-metrics-summary"},{"title":"Get metrics summary for all projects","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/projects/metricssummary","href":"/api-reference/platform-api/metrics/get-metrics-summary-for-all-projects"}]},{"group":"kv store","pages":[{"title":"List all stores for an organization","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /o/{organisation_id}/store","href":"/api-reference/platform-api/kv-store/list-all-stores-for-an-organization"},{"title":"Create a new store","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /o/{organisation_id}/store","href":"/api-reference/platform-api/kv-store/create-a-new-store"},{"title":"Get a value by key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml get /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/get-a-value-by-key"},{"title":"Set a value for a key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/set-a-value-for-a-key"},{"title":"Delete a key","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /store/{store}/kv/{key}","href":"/api-reference/platform-api/kv-store/delete-a-key"},{"title":"Set multiple key-value pairs","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml put /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/set-multiple-key-value-pairs"},{"title":"Get multiple values by keys","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/get-multiple-values-by-keys"},{"title":"Delete multiple keys","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml delete /store/{store}/kv/batch","href":"/api-reference/platform-api/kv-store/delete-multiple-keys"},{"title":"List keys and values with filtering","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/list","href":"/api-reference/platform-api/kv-store/list-keys-and-values-with-filtering"},{"title":"Count entries matching selector","deprecated":null,"version":null,"openapi":"/openapi/platform-api.yaml post /store/{store}/kv/count","href":"/api-reference/platform-api/kv-store/count-entries-matching-selector"}]}]}]},{"anchor":"Organisations API","icon":"users","pages":[{"title":"Organisations API","href":"/latest/api-reference/organisations-api/getting-started"}]}]}]},{"version":"Legacy","pages":[{"title":"Legacy","href":"/legacy/welcome"}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/introduction"}]}]},"title":"Getting Started - Versori User Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}
