Learn how to interact with Openlayer programmatically
The Reference section contains the technical specifications for using Openlayer programmatically.Unlike the guides in the Documentation section, this part does not
walk you through workflows. Instead, it provides the source of truth for:
Openlayer SDKs
Methods and their parameters.
Openlayer CLI
Commands and flags.
Openlayer REST API
Endpoints, schemas, and responses.
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Openlayer","colors":{"primary":"#592FEA","light":"#7A58EE","dark":"#7A58EE"},"logo":{"light":"https://mintcdn.com/openlayer-44/oDCORJdUN9f9cW5l/logo/logo-docs-brand.svg?fit=max\u0026auto=format\u0026n=oDCORJdUN9f9cW5l\u0026q=85\u0026s=ba6c0b778d2eacb6a216f9fb8caa7132","dark":"https://mintcdn.com/openlayer-44/oDCORJdUN9f9cW5l/logo/logo-docs-brand-dark.svg?fit=max\u0026auto=format\u0026n=oDCORJdUN9f9cW5l\u0026q=85\u0026s=7b5e924f18a184a4444ec36e2a23b061","href":"https://openlayer.com"},"favicon":"https://mintcdn.com/openlayer-44/kSF2u3BEB6ygCIR0/favicon.svg?fit=max\u0026auto=format\u0026n=kSF2u3BEB6ygCIR0\u0026q=85\u0026s=956d0871161771d155ff4903add290e5","api":{"openapi":["api-reference/openapi.yaml"],"playground":{"display":"none"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.openlayer.com/v1"}},"appearance":{"default":"system"},"background":{"color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"links":[{"href":"https://discord.gg/t6wS2g6MMB","label":"Community"},{"href":"https://app.openlayer.com/?login=true","label":"Log in"}],"primary":{"type":"button","label":"Get started","href":"https://app.openlayer.com/"}},"footer":{"socials":{"discord":"https://discord.gg/t6wS2g6MMB","linkedin":"https://www.linkedin.com/company/openlayerco","twitter":"https://twitter.com/openlayerco"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"integrations":{"mixpanel":{"projectToken":"401ce9e4de4663c33009eb3d140d3945"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openlayer-44","hasAudioNarration":false,"actualSubdomain":"openlayer-44","customDomains":["docs.openlayer.com"],"gitSource":{"type":"github","owner":"openlayer-ai","repo":"openlayer-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aec177ab4a9a5921893f321","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Documentation","count":197},{"language":"default","tag":"Tests","count":122},{"language":"default","tag":"Catalog","count":111},{"language":"default","tag":"Reference","count":91},{"language":"default","tag":"REST API","count":64},{"language":"default","tag":"Integrations","count":62},{"language":"default","tag":"Governance","count":35},{"language":"default","tag":"Observability","count":23},{"language":"default","tag":"CLI","count":19},{"language":"default","tag":"No-Code Platforms","count":18}]},"assistantConfig":{},"basePath":"","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":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":"Learn how to interact with Openlayer programmatically","href":"/api-reference/introduction"},"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: \"Learn how to interact with Openlayer programmatically\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Reference section contains the technical specifications for using Openlayer programmatically.`}),`\n`,_jsxs(_components.p,{children:[`Unlike the guides in the `,_jsx(_components.a,{href:`/introduction`,children:`Documentation section`}),`, this part does not\nwalk you through workflows. Instead, it provides the source of truth for:`]}),`\n`,_jsxs(CardGroup,{cols:3,children:[_jsx(Card,{title:`Openlayer SDKs`,icon:`cuboid`,href:`/api-reference/sdk/overview`,children:_jsx(_components.p,{children:`Methods and their parameters.`})}),_jsx(Card,{title:`Openlayer CLI`,href:`/api-reference/cli/overview`,icon:`code`,children:_jsx(_components.p,{children:`Commands and flags.`})}),_jsx(Card,{title:`Openlayer REST API`,icon:`globe`,href:`/api-reference/rest/overview`,children:_jsx(_components.p,{children:`Endpoints, schemas, and responses.`})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":"Learn how to interact with Openlayer programmatically","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/openlayer-44/a85e4a0a43b4a6e9/.eslintrc.js"],"subdomain":"openlayer-44","siteName":"Openlayer","title":"Introduction - Openlayer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-25T17:14:55.116Z","originalFileLocation":"api-reference/introduction.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=\"Learn how to interact with Openlayer programmatically\">\u003cmeta data-mint-head name=\"application-name\" content=\"Openlayer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_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/openlayer-44/IrRZyBgLHpsjdPBT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Openlayer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn how to interact with Openlayer programmatically\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Openlayer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.openlayer.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openlayer-44.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Introduction\u0026amp;description=Learn+how+to+interact+with+Openlayer+programmatically\u0026amp;theme=079d59d752b48a504b621be5\u0026amp;signature=a81940aec5a4fe1a2bbea5868f06f546d5f595d5c1111b121f3e766e5cbfc001\">\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=\"Introduction - Openlayer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn how to interact with Openlayer programmatically\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openlayer-44.mintlify.site/_mintlify/api/og/v2?division=Reference\u0026amp;title=Introduction\u0026amp;description=Learn+how+to+interact+with+Openlayer+programmatically\u0026amp;theme=079d59d752b48a504b621be5\u0026amp;signature=a81940aec5a4fe1a2bbea5868f06f546d5f595d5c1111b121f3e766e5cbfc001\">\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/openlayer-44/IrRZyBgLHpsjdPBT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Openlayer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#592FEA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.openlayer.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.openlayer.com/#organization\",\"name\":\"Openlayer\",\"url\":\"https://docs.openlayer.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openlayer-44/oDCORJdUN9f9cW5l/logo/logo-docs-brand.svg?fit=max\u0026auto=format\u0026n=oDCORJdUN9f9cW5l\u0026q=85\u0026s=ba6c0b778d2eacb6a216f9fb8caa7132\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.openlayer.com#website\",\"name\":\"Openlayer\",\"url\":\"https://docs.openlayer.com\",\"publisher\":{\"@id\":\"https://docs.openlayer.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.openlayer.com/api-reference/introduction#webpage\",\"url\":\"https://docs.openlayer.com/api-reference/introduction\",\"name\":\"Introduction\",\"description\":\"Learn how to interact with Openlayer programmatically\",\"dateModified\":\"2025-09-25T17:14:55.116Z\",\"isPartOf\":{\"@id\":\"https://docs.openlayer.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.openlayer.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.openlayer.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Openlayer\",\"item\":\"https://docs.openlayer.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.openlayer.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.openlayer.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"description\":\"Learn how to interact with Openlayer programmatically\",\"url\":\"https://docs.openlayer.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.openlayer.com/api-reference/introduction#webpage\"},\"dateModified\":\"2025-09-25T17:14:55.116Z\",\"publisher\":{\"@id\":\"https://docs.openlayer.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.openlayer.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Openlayer\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Openlayer","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Reference","groups":[{"group":"Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"SDKs","pages":[{"title":"Overview","description":"Use the Openlayer SDKs to interact with Openlayer","href":"/api-reference/sdk/overview"},{"group":"Openlayer SDKs","pages":[{"title":"Python","href":"/api-reference/sdk/libraries/python"},{"title":"TypeScript","href":"/api-reference/sdk/libraries/typescript"},{"title":"Go","href":"/api-reference/sdk/libraries/go"},{"title":"Ruby","href":"/api-reference/sdk/libraries/ruby"},{"title":"Java","href":"/api-reference/sdk/libraries/java"}]}]},{"group":"CLI","pages":[{"title":"Overview","href":"/api-reference/cli/overview"},{"title":"CLI global options","href":"/api-reference/cli/global-options"},{"group":"Commands","pages":[{"title":"batch","href":"/api-reference/cli/commands/batch"},{"title":"data-sources","href":"/api-reference/cli/commands/data-sources"},{"title":"export","href":"/api-reference/cli/commands/export"},{"title":"help","href":"/api-reference/cli/commands/help"},{"title":"init","href":"/api-reference/cli/commands/init"},{"title":"inspect","href":"/api-reference/cli/commands/inspect"},{"title":"install","href":"/api-reference/cli/commands/install"},{"title":"link","href":"/api-reference/cli/commands/link"},{"title":"login","href":"/api-reference/cli/commands/login"},{"title":"metrics","href":"/api-reference/cli/commands/metrics"},{"title":"profile","href":"/api-reference/cli/commands/profile"},{"title":"projects","href":"/api-reference/cli/commands/projects"},{"title":"push","href":"/api-reference/cli/commands/push"},{"title":"tests","href":"/api-reference/cli/commands/tests"},{"title":"update","href":"/api-reference/cli/commands/update"},{"title":"validate","href":"/api-reference/cli/commands/validate"},{"title":"whoami","href":"/api-reference/cli/commands/whoami"}]}]},{"group":"REST API","pages":[{"title":"Overview","href":"/api-reference/rest/overview"},{"group":"Workspaces","pages":[{"title":"Retrieve workspace","openapi":"get /workspaces/{workspaceId}","href":"/api-reference/rest/workspaces/retrieve-workspace"},{"title":"Update workspace","openapi":"put /workspaces/{workspaceId}","href":"/api-reference/rest/workspaces/update-workspace"}]},{"group":"Invites and API keys","pages":[{"title":"List API keys","openapi":"get /workspaces/{workspaceId}/api-keys","href":"/api-reference/rest/api-keys/list-api-keys"},{"title":"Create API key","openapi":"post /workspaces/{workspaceId}/api-keys","href":"/api-reference/rest/api-keys/create-api-key"},{"title":"Retrieve API key","openapi":"get /workspaces/{workspaceId}/api-keys/{apiKeyId}","href":"/api-reference/rest/api-keys/retrieve-api-key"},{"title":"Update API key","openapi":"put /workspaces/{workspaceId}/api-keys/{apiKeyId}","href":"/api-reference/rest/api-keys/update-api-key"},{"title":"Delete API key","openapi":"delete /workspaces/{workspaceId}/api-keys/{apiKeyId}","href":"/api-reference/rest/api-keys/delete-api-key"},{"title":"Rotate API key","openapi":"post /workspaces/{workspaceId}/api-keys/{apiKeyId}/rotate","href":"/api-reference/rest/api-keys/rotate-api-key"},{"title":"Create invite","openapi":"post /workspaces/{workspaceId}/invites","href":"/api-reference/rest/invites/create-invite"},{"title":"List invites","openapi":"get /workspaces/{workspaceId}/invites","href":"/api-reference/rest/invites/list-invites"}]},{"group":"Projects","pages":[{"openapi":"get /projects","title":"List projects","href":"/api-reference/rest/projects/list-projects"},{"openapi":"post /projects","title":"Create project","href":"/api-reference/rest/projects/create-project"},{"openapi":"delete /projects/{projectId}","title":"Delete project","href":"/api-reference/rest/projects/delete-project"}]},{"group":"Tests","pages":[{"title":"Create test","openapi":"post /projects/{projectId}/tests","href":"/api-reference/rest/tests/create-test"},{"title":"List tests","openapi":"get /projects/{projectId}/tests","href":"/api-reference/rest/tests/list-tests"},{"title":"Update tests","openapi":"put /projects/{projectId}/tests","href":"/api-reference/rest/tests/update-tests"},{"title":"Evaluate test","openapi":"post /tests/{testId}/evaluate","href":"/api-reference/rest/tests/evaluate-test"},{"title":"List the test results for a test","openapi":"get /tests/{testId}/results","href":"/api-reference/rest/tests/list-test-results"}]},{"group":"Development","pages":[{"openapi":"post /storage/presigned-url","title":"Create an upload url","href":"/api-reference/rest/development/presigned-url"},{"openapi":"get /storage/presigned-url","title":"Retrieve a download url","href":"/api-reference/rest/development/retrieve-download-url"},{"openapi":"get /projects/{projectId}/versions","title":"List project commits","href":"/api-reference/rest/development/list-project-versions"},{"openapi":"get /versions/{projectVersionId}","title":"Retrieve project commit","href":"/api-reference/rest/development/retrieve-project-version"},{"openapi":"post /projects/{projectId}/versions","title":"Create project commit","href":"/api-reference/rest/development/create-project-version"},{"openapi":"get /versions/{projectVersionId}/results","title":"List commit test results","href":"/api-reference/rest/development/list-test-results"}]},{"group":"Monitoring","pages":[{"title":"Create data source","openapi":"post /projects/{projectId}/inference-pipelines","href":"/api-reference/rest/monitoring/create-inference-pipeline"},{"title":"List data sources","openapi":"get /projects/{projectId}/inference-pipelines","href":"/api-reference/rest/monitoring/list-inference-pipelines"},{"title":"Retrieve data source","openapi":"get /inference-pipelines/{inferencePipelineId}","href":"/api-reference/rest/monitoring/retrieve-inference-pipeline"},{"title":"Update data source","openapi":"put /inference-pipelines/{inferencePipelineId}","href":"/api-reference/rest/monitoring/update-inference-pipeline"},{"title":"Delete data source","openapi":"delete /inference-pipelines/{inferencePipelineId}","href":"/api-reference/rest/monitoring/delete-inference-pipeline"},{"title":"Publish records","openapi":"post /inference-pipelines/{inferencePipelineId}/data-stream","href":"/api-reference/rest/monitoring/stream-data"},{"title":"Retrieve record","openapi":"get /inference-pipelines/{inferencePipelineId}/rows/{inferenceId}","href":"/api-reference/rest/monitoring/retrieve-inference"},{"title":"Update record","openapi":"put /inference-pipelines/{inferencePipelineId}/rows","href":"/api-reference/rest/monitoring/update-inference"},{"title":"Delete record","openapi":"delete /inference-pipelines/{inferencePipelineId}/rows/{inferenceId}","href":"/api-reference/rest/monitoring/delete-inference"},{"title":"Bulk delete records","openapi":"post /inference-pipelines/{inferencePipelineId}/rows/delete","href":"/api-reference/rest/monitoring/bulk-delete-inferences"},{"title":"List data source test results","openapi":"get /inference-pipelines/{inferencePipelineId}/results","href":"/api-reference/rest/monitoring/list-test-results"},{"title":"List data source users","openapi":"post /inference-pipelines/{inferencePipelineId}/users","href":"/api-reference/rest/monitoring/list-inference-pipeline-users"},{"title":"List data source sessions","openapi":"post /inference-pipelines/{inferencePipelineId}/sessions","href":"/api-reference/rest/monitoring/list-inference-pipeline-sessions"},{"title":"List data source rows","openapi":"post /inference-pipelines/{inferencePipelineId}/rows","href":"/api-reference/rest/monitoring/list-inference-pipeline-rows"}]},{"group":"Governance","pages":[{"openapi":"get /workspaces/{workspaceId}/frameworks","title":"List frameworks","href":"/api-reference/rest/governance/list-frameworks"},{"openapi":"post /workspaces/{workspaceId}/frameworks","title":"Create a framework","href":"/api-reference/rest/governance/create-framework"},{"openapi":"get /frameworks/{frameworkId}","title":"Retrieve a framework","href":"/api-reference/rest/governance/retrieve-framework"},{"openapi":"put /frameworks/{frameworkId}","title":"Update a framework","href":"/api-reference/rest/governance/update-framework"},{"openapi":"post /frameworks/{frameworkId}/export","title":"Export a framework","href":"/api-reference/rest/governance/export-framework"},{"openapi":"get /frameworks/{frameworkId}/rules","title":"List a framework's rules","href":"/api-reference/rest/governance/list-framework-rules"},{"openapi":"get /frameworks/{frameworkId}/projects","title":"List a framework's projects","href":"/api-reference/rest/governance/list-framework-projects"},{"openapi":"get /frameworks/{frameworkId}/project-rule-stats","title":"List a framework's per-project compliance","href":"/api-reference/rest/governance/list-project-rule-stats"},{"openapi":"get /frameworks/{frameworkId}/documents","title":"List a framework's documents","href":"/api-reference/rest/governance/list-framework-documents"},{"openapi":"get /frameworks/{frameworkId}/documents/{documentId}","title":"Retrieve a framework document","href":"/api-reference/rest/governance/retrieve-framework-document"},{"openapi":"get /frameworks/{frameworkId}/sections/{sectionId}/rules","title":"List a section's rules","href":"/api-reference/rest/governance/list-section-rules"},{"openapi":"get /frameworks/{frameworkId}/subsections/{subsectionId}/rules","title":"List a subsection's rules","href":"/api-reference/rest/governance/list-subsection-rules"},{"openapi":"get /workspaces/{workspaceId}/rules","title":"List rules","href":"/api-reference/rest/governance/list-rules"},{"openapi":"post /workspaces/{workspaceId}/rules","title":"Create a rule","href":"/api-reference/rest/governance/create-rule"},{"openapi":"get /rules/{ruleId}","title":"Retrieve a rule","href":"/api-reference/rest/governance/retrieve-rule"},{"openapi":"put /rules/{ruleId}","title":"Update a rule","href":"/api-reference/rest/governance/update-rule"},{"openapi":"delete /rules/{ruleId}","title":"Delete a rule","href":"/api-reference/rest/governance/delete-rule"},{"openapi":"get /workspaces/{workspaceId}/rule-results","title":"List rule results","href":"/api-reference/rest/governance/list-rule-results"},{"openapi":"get /rule-results/{ruleResultId}","title":"Retrieve a rule result","href":"/api-reference/rest/governance/retrieve-rule-result"},{"openapi":"patch /rule-results/{ruleResultId}","title":"Update a rule result","href":"/api-reference/rest/governance/update-rule-result"},{"openapi":"get /rule-results/{ruleResultId}/evidence","title":"List a rule result's evidence","href":"/api-reference/rest/governance/list-rule-result-evidence"},{"openapi":"post /rule-results/{ruleResultId}/evidence","title":"Attach evidence to a rule result","href":"/api-reference/rest/governance/create-rule-result-evidence"},{"openapi":"get /workspaces/{workspaceId}/rule-stats","title":"Retrieve workspace compliance statistics","href":"/api-reference/rest/governance/retrieve-rule-stats"},{"openapi":"get /workspaces/{workspaceId}/rule-tags","title":"List rule tags","href":"/api-reference/rest/governance/list-rule-tags"}]},{"group":"Background tasks","pages":[{"openapi":"get /background-tasks/{taskId}","title":"Retrieve a background task","href":"/api-reference/rest/background-tasks/retrieve-background-task"}]}]}]}]},"basePath":"","title":"Introduction - Openlayer","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":[],"chunks":[]}