An API key from frogbot deploy's sign-in, /api/cli/device/token, or the API keys page.
Path Parameters
id
string
required
The workspace's id.
Response
OK
id
string
name
string
slug
string
personalOf
string
The id of a users document.
businessFeatures
boolean
Business features: sharing apps with everyone in the workspace, and projects with their own people. On with Business or Platform access.
platformAccess
boolean
Never billed, with every Business feature: FrogBot staff, Trend, test workspaces and Enterprise contracts. Only Dojo staff can see or change it.
plan
enum<string>
Available options:
none,
pro,
business
subscriptionStatus
string
paidApps
number
currentPeriodEnd
string<date-time>
cancelAt
string<date-time>
stripeCustomerId
string
stripeSubscriptionId
string
stoppedEmailSentAt
string<date-time>
aiBalanceUSD
number
aiAutoRecharge
boolean
aiRechargeThresholdUSD
number
aiRechargeAmountUSD
number
previewMonth
string
previewMinutes
number
previewApps
number
activity
string
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"FrogBot Docs","colors":{"primary":"#030712","light":"#F9FAFB","dark":"#3acf6a"},"logo":{"light":"https://mintcdn.com/firmware/prHVb2uANIlbPHDH/logo/FrogBotLightGreen.svg?fit=max\u0026auto=format\u0026n=prHVb2uANIlbPHDH\u0026q=85\u0026s=ad1ffb4ad2d53579f9f0c67bde5033a7","dark":"https://mintcdn.com/firmware/prHVb2uANIlbPHDH/logo/FrogBotLongGreen.svg?fit=max\u0026auto=format\u0026n=prHVb2uANIlbPHDH\u0026q=85\u0026s=6ebbdbb9ac197c582d80008b34e22d97"},"favicon":"https://mintcdn.com/firmware/aHdoSdZ1qACOtxV9/favicon.svg?fit=max\u0026auto=format\u0026n=aHdoSdZ1qACOtxV9\u0026q=85\u0026s=5371dd67e09baeb06071f03c46251dcd","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://app.frogbot.ai/api"}},"background":{"color":{"light":"#F9FAFB","dark":"#090e1b"}},"navbar":{"links":[{"href":"https://github.com/frogbotai/frogbot","type":"github"},{"icon":"discord","href":"https://discord.gg/JBZF7syAnU","label":"Discord"},{"href":"https://x.com/cgilly2fast","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.frogbot.ai"}},"footer":{"socials":{"x":"https://x.com/frogbotai","discord":"https://discord.com/invite/JBZF7syAnU","youtube":"https://www.youtube.com/@frogbotai","linkedin":"https://www.linkedin.com/company/frogbotai","github":"https://github.com/frogbotai/frogbot"}},"styling":{"codeblocks":{"theme":"tokyo-night"},"latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"firmware","hasAudioNarration":false,"actualSubdomain":"firmware","customDomains":["docs.frogbot.ai"],"gitSource":{"type":"github","owner":"frogbotai","repo":"frogbot","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6b0286156d5fca11cbfa6416","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"General","count":197},{"language":"default","tag":"Dojo","count":150},{"language":"default","tag":"API reference","count":120},{"language":"default","tag":"Features","count":91},{"language":"default","tag":"Basics","count":56},{"language":"default","tag":"Fields","count":35},{"language":"default","tag":"Ecosystem","count":29},{"language":"default","tag":"Apps","count":25},{"language":"default","tag":"Hosted AI (app.frogbot.ai)","count":21},{"language":"default","tag":"Plugins","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark #sidebar-content a,.dark #sidebar-content button{color:#d1d5db!important}.dark #sidebar-content a:hover,.dark #sidebar-content button:hover{color:#f9fafb!important}.dark .sidebar-group-header{color:#e5e7eb}.dark #content-area,.dark #content-area p,.dark #content-area li,.dark #content-area span:not(:where(pre,code) span),.dark #content-area [data-as=\"p\"],.dark .prose :where(p,li,span):not(:where(code,code *)){color:#cbd5e1!important}.dark .prose{--tw-prose-invert-body: #cbd5e1;--tw-prose-invert-lead: #cbd5e1;--tw-prose-invert-bullets: #64748b;--tw-prose-invert-counters: #94a3b8;--tw-prose-invert-quotes: #e2e8f0;--tw-prose-invert-captions: #94a3b8;--tw-prose-invert-headings: #f8fafc;--tw-prose-invert-bold: #f8fafc}.dark [data-component-part=\"card-content\"],.dark [data-component-part=\"card-content\"] *{color:#cbd5e1!important}.dark #table-of-contents a{color:#cbd5e1}.dark #table-of-contents a:hover{color:#f1f5f9}.dark #content-area h1,.dark #content-area h2,.dark #content-area h3,.dark #content-area h4,.dark #content-area h1 *,.dark #content-area h2 *,.dark #content-area h3 *,.dark #content-area h4 *,.dark [data-component-part=\"card-title\"]{color:#f8fafc!important}.prompt{background-color:#fff!important;border-color:rgb(var(--gray-950) / 0.1)!important;color:rgb(var(--gray-700))!important}.dark .prompt{background-color:rgb(var(--background-dark))!important;border-color:rgb(255 255 255 / 0.1)!important;color:#cbd5e1!important}.prompt [data-component-part=\"prompt-action-copy-button\"]{background-color:rgb(var(--primary-dark))!important;border-color:transparent!important}.prompt [data-component-part=\"prompt-action-copy-button\"]:hover{background-color:rgb(var(--primary-dark) / 0.9)!important}.prompt [data-component-part=\"prompt-action-copy-button\"],.prompt [data-component-part=\"prompt-action-copy-button\"] *,.dark #content-area .prompt [data-component-part=\"prompt-action-copy-button\"] *{color:#fff!important}"}]}
{"page":{"pagePath":"api-reference/workspaces/read-a-workspace","slug":"/api-reference/workspaces/read-a-workspace","pageMetadata":{"title":"Read a workspace","description":null,"deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}","href":"/api-reference/workspaces/read-a-workspace","autogeneratedByOpenApi":true},"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":{"codeStyling":{"theme":"tokyo-night"},"config":{},"pageMetadata":{"title":"Read a workspace","description":null,"deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}","href":"/api-reference/workspaces/read-a-workspace","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Workspaces"],"summary":"Read a workspace","x-access":"Whoever its access rules allow","parameters":["b2312797-33b3-4e29-82eb-10d41b056e07"],"responses":{"200":"f39abf6f-248d-4878-925b-15a851900652","400":"12ec8d5c-a227-4a70-a84a-dfcb33936097","401":"04327dfc-8d77-4099-a40d-e969c4e72688","403":"94219cbc-7306-4046-a988-836445cb316c","404":"aa06ba22-3188-4bec-98cc-8a510fdc8a6e"},"method":"get","type":"path","servers":["22e53e27-e3ad-493f-a850-e4320d5f4026"],"security":["ee8a2448-4300-4c4b-8365-1b87c37e26fe"],"path":"/api/workspaces/{id}","baseUrlOptions":["https://dojo.frogbot.ai"],"title":"Read a workspace","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"b2312797-33b3-4e29-82eb-10d41b056e07":{"name":"id","in":"path","required":true,"description":"The workspace's id.","schema":{"type":"string","isRequired":true,"description":"The workspace's id.","uniqueKey":"","typeLabel":"string"}}},"responses":{"f39abf6f-248d-4878-925b-15a851900652":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"slug":{"type":"string","uniqueKey":"slug","typeLabel":"string"},"personalOf":{"type":"string","description":"The id of a users document.","uniqueKey":"personalOf","typeLabel":"string"},"businessFeatures":{"type":"boolean","description":"Business features: sharing apps with everyone in the workspace, and projects with their own people. On with Business or Platform access.","uniqueKey":"businessFeatures","typeLabel":"boolean"},"platformAccess":{"type":"boolean","description":"Never billed, with every Business feature: FrogBot staff, Trend, test workspaces and Enterprise contracts. Only Dojo staff can see or change it.","uniqueKey":"platformAccess","typeLabel":"boolean"},"plan":{"type":"string","enum":["none","pro","business"],"uniqueKey":"plan","typeLabel":"enum\u003cstring>"},"subscriptionStatus":{"type":"string","uniqueKey":"subscriptionStatus","typeLabel":"string"},"paidApps":{"type":"number","uniqueKey":"paidApps","typeLabel":"number"},"currentPeriodEnd":{"type":"string","format":"date-time","uniqueKey":"currentPeriodEnd","typeLabel":"string\u003cdate-time>"},"cancelAt":{"type":"string","format":"date-time","uniqueKey":"cancelAt","typeLabel":"string\u003cdate-time>"},"stripeCustomerId":{"type":"string","uniqueKey":"stripeCustomerId","typeLabel":"string"},"stripeSubscriptionId":{"type":"string","uniqueKey":"stripeSubscriptionId","typeLabel":"string"},"stoppedEmailSentAt":{"type":"string","format":"date-time","uniqueKey":"stoppedEmailSentAt","typeLabel":"string\u003cdate-time>"},"aiBalanceUSD":{"type":"number","uniqueKey":"aiBalanceUSD","typeLabel":"number"},"aiAutoRecharge":{"type":"boolean","uniqueKey":"aiAutoRecharge","typeLabel":"boolean"},"aiRechargeThresholdUSD":{"type":"number","uniqueKey":"aiRechargeThresholdUSD","typeLabel":"number"},"aiRechargeAmountUSD":{"type":"number","uniqueKey":"aiRechargeAmountUSD","typeLabel":"number"},"previewMonth":{"type":"string","uniqueKey":"previewMonth","typeLabel":"string"},"previewMinutes":{"type":"number","uniqueKey":"previewMinutes","typeLabel":"number"},"previewApps":{"type":"number","uniqueKey":"previewApps","typeLabel":"number"},"activity":{"type":"string","uniqueKey":"activity","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","slug":"\u003cstring>","personalOf":"\u003cstring>","businessFeatures":true,"platformAccess":true,"plan":"none","subscriptionStatus":"\u003cstring>","paidApps":123,"currentPeriodEnd":"2023-11-07T05:31:56Z","cancelAt":"2023-11-07T05:31:56Z","stripeCustomerId":"\u003cstring>","stripeSubscriptionId":"\u003cstring>","stoppedEmailSentAt":"2023-11-07T05:31:56Z","aiBalanceUSD":123,"aiAutoRecharge":true,"aiRechargeThresholdUSD":123,"aiRechargeAmountUSD":123,"previewMonth":"\u003cstring>","previewMinutes":123,"previewApps":123,"activity":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"12ec8d5c-a227-4a70-a84a-dfcb33936097":{"description":"`invalid_request`","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"data":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"errors.items.[INDEX].data.code","typeLabel":"string"},"url":{"type":"string","description":"Where a person takes the next step, such as paying.","uniqueKey":"errors.items.[INDEX].data.url","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","data":{"code":"\u003cstring>","url":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"04327dfc-8d77-4099-a40d-e969c4e72688":{"description":"`unauthorized`","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"data":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"errors.items.[INDEX].data.code","typeLabel":"string"},"url":{"type":"string","description":"Where a person takes the next step, such as paying.","uniqueKey":"errors.items.[INDEX].data.url","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","data":{"code":"\u003cstring>","url":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"94219cbc-7306-4046-a988-836445cb316c":{"description":"`forbidden`","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"data":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"errors.items.[INDEX].data.code","typeLabel":"string"},"url":{"type":"string","description":"Where a person takes the next step, such as paying.","uniqueKey":"errors.items.[INDEX].data.url","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","data":{"code":"\u003cstring>","url":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"aa06ba22-3188-4bec-98cc-8a510fdc8a6e":{"description":"`not_found`","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"data":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"errors.items.[INDEX].data.code","typeLabel":"string"},"url":{"type":"string","description":"Where a person takes the next step, such as paying.","uniqueKey":"errors.items.[INDEX].data.url","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].data","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","data":{"code":"\u003cstring>","url":"\u003cstring>"}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ee8a2448-4300-4c4b-8365-1b87c37e26fe":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or the API keys page.","scopes":[],"schemeName":"apiKey"}}},"servers":{"22e53e27-e3ad-493f-a850-e4320d5f4026":{"url":"https://dojo.frogbot.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or the API keys page.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from `frogbot deploy`'s sign-in, `/api/cli/device/token`, or the API keys page.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"https://dojo.frogbot.ai/api/openapi.json"},"subdomain":"firmware","siteName":"FrogBot Docs","title":"Read a workspace - FrogBot Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-21T21:48:31.469Z","originalFileLocation":"api-reference/workspaces/read-a-workspace.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=\"application-name\" content=\"FrogBot Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_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/firmware/Ps915ZXHYrrkIUCA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Read a workspace - FrogBot Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"FrogBot Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firmware.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Read+a+workspace\u0026amp;theme=430f5e2de55d8139ea1632e6\u0026amp;signature=cfef1286020d5223453aa2cead04444bce3997214e1c17269757e9458328792f\">\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=\"Read a workspace - FrogBot Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firmware.mintlify.site/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Read+a+workspace\u0026amp;theme=430f5e2de55d8139ea1632e6\u0026amp;signature=cfef1286020d5223453aa2cead04444bce3997214e1c17269757e9458328792f\">\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/firmware/Ps915ZXHYrrkIUCA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"FrogBot Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#030712\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/workspaces/read-a-workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.frogbot.ai/#organization\",\"name\":\"FrogBot Docs\",\"url\":\"https://docs.frogbot.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/firmware/prHVb2uANIlbPHDH/logo/FrogBotLightGreen.svg?fit=max\u0026auto=format\u0026n=prHVb2uANIlbPHDH\u0026q=85\u0026s=ad1ffb4ad2d53579f9f0c67bde5033a7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.frogbot.ai#website\",\"name\":\"FrogBot Docs\",\"url\":\"https://docs.frogbot.ai\",\"publisher\":{\"@id\":\"https://docs.frogbot.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace#webpage\",\"url\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace\",\"name\":\"Read a workspace\",\"dateModified\":\"2026-11-21T21:48:31.469Z\",\"isPartOf\":{\"@id\":\"https://docs.frogbot.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.frogbot.ai/api-reference/sign-in/start-a-device-sign-in\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspaces\",\"item\":\"https://docs.frogbot.ai/api-reference/workspaces/list-workspaces\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Read a workspace\",\"item\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace#apireference\",\"headline\":\"Read a workspace\",\"name\":\"Read a workspace\",\"url\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.frogbot.ai/api-reference/workspaces/read-a-workspace#webpage\"},\"dateModified\":\"2026-11-21T21:48:31.469Z\",\"publisher\":{\"@id\":\"https://docs.frogbot.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.frogbot.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"FrogBot Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"FrogBot Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/workspaces/read-a-workspace.md","siteName":"FrogBot Docs","nav":{"global":{},"tabs":[{"tab":"General","pages":[{"title":"General","href":""}]},{"tab":"Dojo","groups":[{"group":"Guides","pages":[{"title":"Dojo","href":"/dojo/overview"},{"title":"Sign in","href":"/dojo/sign-in"},{"title":"Deploy","href":"/dojo/deploy"},{"title":"Share","href":"/dojo/share"},{"title":"Environment variables","href":"/dojo/env-vars"},{"title":"Custom domains","href":"/dojo/domains"},{"title":"Billing","href":"/dojo/billing"},{"title":"API keys","href":"/dojo/api-keys"},{"title":"CLI","href":"/dojo/cli"}]},{"group":"API reference","pages":[{"group":"Sign-in","pages":[{"title":"Start a device sign-in","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/cli/device/code","href":"/api-reference/sign-in/start-a-device-sign-in"},{"title":"Collect the API key a device sign-in made","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/cli/device/token","href":"/api-reference/sign-in/collect-the-api-key-a-device-sign-in-made"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","description":null,"deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Read a workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}","href":"/api-reference/workspaces/read-a-workspace"},{"title":"Update a workspace","description":null,"deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/workspaces/{id}","href":"/api-reference/workspaces/update-a-workspace"},{"title":"List members","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/members","href":"/api-reference/workspaces/list-members"},{"title":"Create a member","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/members","href":"/api-reference/workspaces/create-a-member"},{"title":"Read a member","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/members/{id}","href":"/api-reference/workspaces/read-a-member"},{"title":"Delete a member","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/members/{id}","href":"/api-reference/workspaces/delete-a-member"},{"title":"Update a member","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/members/{id}","href":"/api-reference/workspaces/update-a-member"},{"title":"Change a workspace member's role","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces/{id}/members/{member}/role","href":"/api-reference/workspaces/change-a-workspace-members-role"},{"title":"Remove a workspace member","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/workspaces/{id}/members/{member}","href":"/api-reference/workspaces/remove-a-workspace-member"},{"title":"Leave a workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces/{id}/leave","href":"/api-reference/workspaces/leave-a-workspace"},{"title":"Hand over workspace ownership","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces/{id}/owner","href":"/api-reference/workspaces/hand-over-workspace-ownership"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces/{id}/delete","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"List activity","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}/activity","href":"/api-reference/workspaces/list-activity"},{"title":"List a workspace's members","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/members/workspace/{workspace}","href":"/api-reference/workspaces/list-a-workspaces-members"},{"title":"Invite people to a workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/members/workspace/{workspace}/invite","href":"/api-reference/workspaces/invite-people-to-a-workspace"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/projects","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/projects","href":"/api-reference/projects/create-a-project"},{"title":"Read a project","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/projects/{id}","href":"/api-reference/projects/read-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/projects/{id}","href":"/api-reference/projects/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/projects/{id}","href":"/api-reference/projects/update-a-project"},{"title":"List project shares","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/project-shares","href":"/api-reference/projects/list-project-shares"},{"title":"Read a project share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/project-shares/{id}","href":"/api-reference/projects/read-a-project-share"},{"title":"Delete a project share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/project-shares/{id}","href":"/api-reference/projects/delete-a-project-share"},{"title":"Update a project share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/project-shares/{id}","href":"/api-reference/projects/update-a-project-share"},{"title":"List a project's people","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/projects/{id}/sharing","href":"/api-reference/projects/list-a-projects-people"},{"title":"Share a project with people","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/projects/{id}/invite","href":"/api-reference/projects/share-a-project-with-people"},{"title":"Leave a project","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/projects/{id}/sharing/me","href":"/api-reference/projects/leave-a-project"},{"title":"Read a project's Danger zone","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/projects/{id}/danger","href":"/api-reference/projects/read-a-projects-danger-zone"},{"title":"Move a project to another workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/projects/{id}/move","href":"/api-reference/projects/move-a-project-to-another-workspace"},{"title":"Hand a project over to someone else","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/projects/{id}/handover","href":"/api-reference/projects/hand-a-project-over-to-someone-else"}]},{"group":"Apps","pages":[{"title":"List apps","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps","href":"/api-reference/apps/list-apps"},{"title":"Create an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps","href":"/api-reference/apps/create-an-app"},{"title":"Read an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{id}","href":"/api-reference/apps/read-an-app"},{"title":"Delete an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/apps/{id}","href":"/api-reference/apps/delete-an-app"},{"title":"Update an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/apps/{id}","href":"/api-reference/apps/update-an-app"},{"title":"Read an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/cli","href":"/api-reference/apps/read-an-app-1"},{"title":"Read a running app's logs","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/logs","href":"/api-reference/apps/read-a-running-apps-logs"},{"title":"Read an app's AI spend and its process","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/usage","href":"/api-reference/apps/read-an-apps-ai-spend-and-its-process"},{"title":"Read an app's free preview","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/preview","href":"/api-reference/apps/read-an-apps-free-preview"},{"title":"Stop an app's free preview","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/preview/stop","href":"/api-reference/apps/stop-an-apps-free-preview"},{"title":"Keep a free preview","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/preview/keep","href":"/api-reference/apps/keep-a-free-preview"},{"title":"Read an app's Danger zone","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{id}/danger","href":"/api-reference/apps/read-an-apps-danger-zone"},{"title":"Move an app to Trash","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/trash","href":"/api-reference/apps/move-an-app-to-trash"},{"title":"Restore an app from Trash","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/restore","href":"/api-reference/apps/restore-an-app-from-trash"},{"title":"Delete an app for good","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/delete-permanently","href":"/api-reference/apps/delete-an-app-for-good"},{"title":"Move an app to another workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/move","href":"/api-reference/apps/move-an-app-to-another-workspace"},{"title":"Hand an app over to someone else","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/handover","href":"/api-reference/apps/hand-an-app-over-to-someone-else"},{"title":"Stop an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/stop","href":"/api-reference/apps/stop-an-app"},{"title":"Start a stopped app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/start","href":"/api-reference/apps/start-a-stopped-app"},{"title":"Restart an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/restart","href":"/api-reference/apps/restart-an-app"},{"title":"Read a handover","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/handovers/{id}/details","href":"/api-reference/apps/read-a-handover"},{"title":"Accept a handover","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/handovers/{id}/accept","href":"/api-reference/apps/accept-a-handover"},{"title":"Cancel or decline a handover","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/handovers/{id}/cancel","href":"/api-reference/apps/cancel-or-decline-a-handover"},{"title":"Remove everyone outside the new workspace","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/handovers/{id}/remove-access","href":"/api-reference/apps/remove-everyone-outside-the-new-workspace"},{"title":"List apps in Trash","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/trash","href":"/api-reference/apps/list-apps-in-trash"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/templates","href":"/api-reference/templates/list-templates"},{"title":"Read a template","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/templates/{id}","href":"/api-reference/templates/read-a-template"},{"title":"Read an app's template","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/template","href":"/api-reference/templates/read-an-apps-template"},{"title":"Save an app as a template","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/template","href":"/api-reference/templates/save-an-app-as-a-template"},{"title":"Price a template's new app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/templates/{id}/offer","href":"/api-reference/templates/price-a-templates-new-app"},{"title":"Use a template","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/templates/{id}/use","href":"/api-reference/templates/use-a-template"},{"title":"Get a template's image","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/templates/{id}/screenshot","href":"/api-reference/templates/get-a-templates-image"},{"title":"Replace a template's image","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json put /api/templates/{id}/screenshot","href":"/api-reference/templates/replace-a-templates-image"}]},{"group":"Sharing","pages":[{"title":"List app shares","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/app-shares","href":"/api-reference/sharing/list-app-shares"},{"title":"Read an app share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/app-shares/{id}","href":"/api-reference/sharing/read-an-app-share"},{"title":"Delete an app share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/app-shares/{id}","href":"/api-reference/sharing/delete-an-app-share"},{"title":"Update an app share","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/app-shares/{id}","href":"/api-reference/sharing/update-an-app-share"},{"title":"List an app's people","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{id}/sharing","href":"/api-reference/sharing/list-an-apps-people"},{"title":"Share an app with people","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/invite","href":"/api-reference/sharing/share-an-app-with-people"},{"title":"Leave an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/apps/{id}/sharing/me","href":"/api-reference/sharing/leave-an-app"},{"title":"Ask for access to an app","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{id}/request-access","href":"/api-reference/sharing/ask-for-access-to-an-app"},{"title":"List apps shared with you","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/shared","href":"/api-reference/sharing/list-apps-shared-with-you"}]},{"group":"Deployments","pages":[{"title":"List deployments","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/deployments","href":"/api-reference/deployments/list-deployments"},{"title":"Read a deployment","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/deployments/{id}","href":"/api-reference/deployments/read-a-deployment"},{"title":"List an app's deployments","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/deployments","href":"/api-reference/deployments/list-an-apps-deployments"},{"title":"Deploy a new version","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/deployments","href":"/api-reference/deployments/deploy-a-new-version"},{"title":"Start uploading an app's source","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/deployments/source-uploads","href":"/api-reference/deployments/start-uploading-an-apps-source"},{"title":"Deploy an uploaded source","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/deployments/from-upload","href":"/api-reference/deployments/deploy-an-uploaded-source"},{"title":"Download the live version's source","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/source","href":"/api-reference/deployments/download-the-live-versions-source"},{"title":"Get a link to download an app's source","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/source-link","href":"/api-reference/deployments/get-a-link-to-download-an-apps-source"},{"title":"Roll back to an earlier version","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/deployments/{id}/rollback","href":"/api-reference/deployments/roll-back-to-an-earlier-version"},{"title":"Read an app's repo link","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/repo","href":"/api-reference/deployments/read-an-apps-repo-link"},{"title":"Connect a repo","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json put /api/apps/{app}/repo","href":"/api-reference/deployments/connect-a-repo"},{"title":"Disconnect a repo","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json delete /api/apps/{app}/repo","href":"/api-reference/deployments/disconnect-a-repo"},{"title":"List the repos a sign-in can connect","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/repo/repos","href":"/api-reference/deployments/list-the-repos-a-sign-in-can-connect"},{"title":"Get a link to connect GitHub","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/repo/github/link","href":"/api-reference/deployments/get-a-link-to-connect-github"},{"title":"List failed deploys","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/deployments/failed","href":"/api-reference/deployments/list-failed-deploys"},{"title":"Follow a deployment's build log","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/deployments/{id}/logs","href":"/api-reference/deployments/follow-a-deployments-build-log"},{"title":"Read a deployment's build log","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/deployments/{id}/log-lines","href":"/api-reference/deployments/read-a-deployments-build-log"},{"title":"Cancel a deployment","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/deployments/{id}/cancel","href":"/api-reference/deployments/cancel-a-deployment"},{"title":"Get the key environment variables are sealed to","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/cli/sealing-key","href":"/api-reference/deployments/get-the-key-environment-variables-are-sealed-to"}]},{"group":"Environment variables","pages":[{"title":"List an app's environment variables","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/keys","href":"/api-reference/environment-variables/list-an-apps-environment-variables"},{"title":"Set or remove an app's environment variables","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json put /api/apps/{app}/keys","href":"/api-reference/environment-variables/set-or-remove-an-apps-environment-variables"}]},{"group":"Domains","pages":[{"title":"Check an app's custom domain","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/domain","href":"/api-reference/domains/check-an-apps-custom-domain"},{"title":"Set or remove an app's custom domain","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json put /api/apps/{app}/domain","href":"/api-reference/domains/set-or-remove-an-apps-custom-domain"}]},{"group":"Data","pages":[{"title":"Start uploading an app's data","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/data-uploads","href":"/api-reference/data/start-uploading-an-apps-data"},{"title":"Finish an app's large uploads","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/apps/{app}/data-uploads/complete","href":"/api-reference/data/finish-an-apps-large-uploads"},{"title":"Download an app's data","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/data","href":"/api-reference/data/download-an-apps-data"},{"title":"Get a link to download an app's data","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/apps/{app}/data-link","href":"/api-reference/data/get-a-link-to-download-an-apps-data"}]},{"group":"Billing","pages":[{"title":"Read a workspace's plan","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}/billing","href":"/api-reference/billing/read-a-workspaces-plan"},{"title":"Get the link that pays for apps","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/billing/checkout","href":"/api-reference/billing/get-the-link-that-pays-for-apps"},{"title":"Get the link to manage billing","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/billing/portal","href":"/api-reference/billing/get-the-link-to-manage-billing"},{"title":"Get the link that adds AI funds","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/billing/ai-checkout","href":"/api-reference/billing/get-the-link-that-adds-ai-funds"},{"title":"Turn AI auto-recharge on or off","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/billing/ai-auto-recharge","href":"/api-reference/billing/turn-ai-auto-recharge-on-or-off"},{"title":"Read the workspace's AI funds and auto-recharge","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/billing/ai","href":"/api-reference/billing/read-the-workspaces-ai-funds-and-auto-recharge"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Read an API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/api-keys/{id}","href":"/api-reference/api-keys/read-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json patch /api/api-keys/{id}","href":"/api-reference/api-keys/update-an-api-key"},{"title":"List a workspace's API keys","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/workspaces/{id}/api-keys","href":"/api-reference/api-keys/list-a-workspaces-api-keys"},{"title":"Revoke a workspace's API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/workspaces/{id}/api-keys/{key}/revoke","href":"/api-reference/api-keys/revoke-a-workspaces-api-key"},{"title":"Disconnect an agent","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/mcp-connections/{id}/disconnect","href":"/api-reference/api-keys/disconnect-an-agent"},{"title":"Make an API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/api-keys/mint","href":"/api-reference/api-keys/make-an-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/api-keys/{id}/revoke","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Count the keys an API key made","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/api-keys/{id}/minted-count","href":"/api-reference/api-keys/count-the-keys-an-api-key-made"},{"title":"Replace an API key","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json post /api/api-keys/{id}/rotate","href":"/api-reference/api-keys/replace-an-api-key"},{"title":"List your signed-in devices","deprecated":null,"version":null,"openapi":"https://dojo.frogbot.ai/api/openapi.json get /api/api-keys/devices","href":"/api-reference/api-keys/list-your-signed-in-devices"}]}]},{"group":"Hosted AI (app.frogbot.ai)","pages":[{"group":"Hosted API","expanded":false,"pages":[{"title":"Intro","href":"/subscription-intro"},{"title":"API keys","href":"/api-keys"}]},{"group":"Pricing","expanded":false,"pages":[{"title":"Balance \u0026 Usage Pricing","href":"/balance-usage-pricing"}]},{"group":"Browser Agent MCP","expanded":false,"pages":[{"title":"Browser Agent MCP","href":"/browser-mcp"}]},{"group":"Agent providers","expanded":false,"pages":[{"title":"OpenCode","href":"/agents/opencode"},{"title":"Claude Code Router","href":"/agents/claude-code-router"},{"title":"Codex","href":"/agents/codex"},{"title":"Kilo Code","href":"/agents/kilo-code"}]},{"group":"Inference API","expanded":false,"pages":[{"title":"API reference","href":"/api-reference/index"},{"title":"Chat completions","api":"POST https://app.frogbot.ai/api/v1/chat/completions","href":"/api-reference/chat-completions"},{"title":"Messages","api":"POST https://app.frogbot.ai/api/v1/messages","href":"/api-reference/messages"},{"title":"Embeddings","api":"POST https://app.frogbot.ai/api/v1/embeddings","href":"/api-reference/embeddings"},{"title":"Rerank","api":"POST https://app.frogbot.ai/api/v1/rerank","href":"/api-reference/rerank"},{"title":"Audio transcriptions","api":"POST https://app.frogbot.ai/api/v1/audio/transcriptions","href":"/api-reference/audio-transcriptions"},{"title":"Audio speech","api":"POST https://app.frogbot.ai/api/v1/audio/speech","href":"/api-reference/audio-speech"},{"title":"Image generation","api":"POST https://app.frogbot.ai/api/v1/images/generations","href":"/api-reference/images-generations"},{"title":"Models","api":"GET https://app.frogbot.ai/api/v1/models","href":"/api-reference/models"},{"title":"Usage balance","api":"GET https://app.frogbot.ai/api/v1/quota","href":"/api-reference/quota"}]},{"group":"Deep Research API","expanded":false,"pages":[{"title":"Create deep research","api":"POST https://app.frogbot.ai/api/v1/research","href":"/api-reference/research-create"},{"title":"Get deep research","api":"GET https://app.frogbot.ai/api/v1/research/{id}","href":"/api-reference/research-get"},{"title":"List deep research","api":"GET https://app.frogbot.ai/api/v1/research","href":"/api-reference/research-list"}]}]}]}]},"basePath":"","title":"Read a workspace - FrogBot Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}