{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Friday","description":"Friday Studio is a desktop app for building AI workflows that run on your machine, on your schedule, with your data. Describe what you want in plain English, and Friday builds the agents, schedules, and connections. The result is a portable workspace.yml you can read, edit, and share. Start at /getting-started/quickstart or browse /core-concepts/agents.","colors":{"primary":"#002FF6","light":"#00A2FD","dark":"#002FF6"},"logo":{"light":"https://mintcdn.com/platform-hellofriday-ai/pFDsYhby1xqStMK5/logo/Friday_light.png?fit=max\u0026auto=format\u0026n=pFDsYhby1xqStMK5\u0026q=85\u0026s=5c8abf84d418faafe0e86af7b56ef0a1","dark":"https://mintcdn.com/platform-hellofriday-ai/pFDsYhby1xqStMK5/logo/Friday_dark.png?fit=max\u0026auto=format\u0026n=pFDsYhby1xqStMK5\u0026q=85\u0026s=51bc2b02abd93875f0f6de75d46ec639"},"favicon":"https://mintcdn.com/platform-hellofriday-ai/pFDsYhby1xqStMK5/images/favicon.png?fit=max\u0026auto=format\u0026n=pFDsYhby1xqStMK5\u0026q=85\u0026s=ac26221e2f534844140334ef5cdee413","api":{"openapi":"api-reference/openapi.json","playground":{"display":"simple"},"examples":{"languages":["bash","javascript","python","go"],"autogenerate":true},"mdx":{"server":"http://localhost:18080"}},"navbar":{"links":[{"href":"https://hellofriday.ai","label":"Friday"}]},"footer":{"socials":{"github":"https://github.com/friday-platform","x":"https://x.com/HelloFridayAI","linkedin":"https://www.linkedin.com/company/hello-friday-ai","website":"https://hellofriday.ai","discord":"https://discord.com/invite/uczJyp5FMH","medium":"https://medium.com/friday-ai","bluesky":"https://bsky.app/profile/fridayai.bsky.social"}},"search":{"prompt":"Search docs..."},"seo":{"metatags":{"og:site_name":"Friday Agent Studio \u0026 Toolkit Documentation"}},"integrations":{"gtm":{"tagId":"GTM-WKFQFCTM"},"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"star","href":"/changelog"},{"anchor":"Join our community","icon":"discord","href":"https://discord.com/invite/uczJyp5FMH"},{"anchor":"GitHub","icon":"github","href":"https://github.com/friday-platform"},{"anchor":"Contact us","icon":"envelope","href":"/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"platform-hellofriday-ai","hasAudioNarration":false,"actualSubdomain":"platform-hellofriday-ai","customDomains":["docs.hellofriday.ai"],"gitSource":{"type":"github","owner":"friday-platform","repo":"docs.hellofriday.ai","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae94ab4ae4e45b47d927a7d:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Reference","count":33},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Agent SDK","count":17},{"language":"default","tag":"Python","count":16},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Core concepts","count":10},{"language":"default","tag":"Communicators","count":5},{"language":"default","tag":"Spaces","count":5},{"language":"default","tag":"Getting started","count":4},{"language":"default","tag":"Signals","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"global.css","content":"a.group.w-full span.text-gray-500.truncate{display:none!important}"},{"filePath":"style.css","content":".text-base,.accordion-group summary,.accordion-group .prose,#content-area div.mdx-content.prose{\u0026{font-size:0.875rem;line-height:165%}}code{font-size:12px;line-height:1.25rem}#content-area div.mdx-content.prose{blockquote.sr-only + span[data-as=\"p\"] {\n margin-block: 0;\n }}.prose :where(h2):not(:where([class~=\"not-prose\"],[class~=\"not-prose\"] *)){margin-top:2rem;margin-bottom:0.75rem}#navigation-items{\u0026>ul,\u0026>div{margin-block-start:1.25rem}}#sidebar-group{a,\n button {\n padding-block: 0.25rem;\n }}#table-of-contents{a {\n padding-block: 0.125rem;\n }}"}],"page":{"pagePath":"api-reference/spaces/register-a-space","slug":"/api-reference/spaces/register-a-space","pageMetadata":{"title":"Register a space","description":"Register a space by providing the path to a directory containing a `workspace.yml` file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/add","href":"/api-reference/spaces/register-a-space","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Register a space by providing the path to a directory containing a \", _jsx(_components.code, {\n children: \"workspace.yml\"\n }), \" file.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Register a space","description":"Register a space by providing the path to a directory containing a `workspace.yml` file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/add","href":"/api-reference/spaces/register-a-space","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Register a space","description":"Register a space by providing the path to a directory containing a `workspace.yml` file.","operationId":"addWorkspace","tags":["Spaces"],"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST http://localhost:18080/api/workspaces/add \\\n -H 'Content-Type: application/json' \\\n -d '{\"path\": \"/path/to/my-space\"}'"}],"requestBody":"cd21b93f-df0b-4c8b-ba68-22c3d590e1c7","responses":{"200":"8e494ca9-52b5-436c-91fd-3c367fbee488"},"method":"post","type":"path","servers":["091f597c-9621-466e-8210-779134c73202"],"security":[],"path":"/api/workspaces/add","baseUrlOptions":["http://localhost:18080"],"title":"Register a space","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X POST http://localhost:18080/api/workspaces/add \\\n -H 'Content-Type: application/json' \\\n -d '{\"path\": \"/path/to/my-space\"}'"}],"requestExampleLanguages":["bash","javascript","python","go"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["path"],"properties":{"path":{"type":"string","description":"Absolute path to the space directory containing workspace.yml","example":"/data/spaces/my-space","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"name":{"type":"string","description":"Optional display name override","uniqueKey":"name","typeLabel":"string"},"description":{"type":"string","description":"Optional description override","uniqueKey":"description","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"path":"/data/spaces/my-space","name":"\u003cstring>","description":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8e494ca9-52b5-436c-91fd-3c367fbee488":{"description":"Space registered","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"abc123","uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","example":"my-space","uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","example":"active","uniqueKey":"status","typeLabel":"string"},"path":{"type":"string","uniqueKey":"path","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"created":{"type":"boolean","uniqueKey":"created","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"abc123","name":"my-space","status":"active","path":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","created":true}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"091f597c-9621-466e-8210-779134c73202":{"url":"http://localhost:18080","description":"Local Friday daemon"}}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"platform-hellofriday-ai","siteName":"Friday","title":"Register a space - Friday","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-01T09:17:43.870Z","originalFileLocation":"api-reference/spaces/register-a-space.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=\"Register a space by providing the path to a directory containing a workspace.yml file.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Friday\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Register a space - Friday\">\u003cmeta data-mint-head property=\"og:description\" content=\"Register a space by providing the path to a directory containing a workspace.yml file.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Friday Agent Studio \u0026amp; Toolkit Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://platform-hellofriday-ai.mintlify.site/_mintlify/api/og/v2?division=Spaces\u0026amp;title=Register+a+space\u0026amp;description=Register+a+space+by+providing+the+path+to+a+directory+containing+a+%60workspace.yml%60+file.\u0026amp;theme=7cfc1d124158bb8d49bb75de\u0026amp;signature=5617e6d1cba34501fb69b52c2a5047170aabe6108d615803fdf7f61fc5d1c5a3\">\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=\"Register a space - Friday\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Register a space by providing the path to a directory containing a workspace.yml file.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://platform-hellofriday-ai.mintlify.site/_mintlify/api/og/v2?division=Spaces\u0026amp;title=Register+a+space\u0026amp;description=Register+a+space+by+providing+the+path+to+a+directory+containing+a+%60workspace.yml%60+file.\u0026amp;theme=7cfc1d124158bb8d49bb75de\u0026amp;signature=5617e6d1cba34501fb69b52c2a5047170aabe6108d615803fdf7f61fc5d1c5a3\">\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/platform-hellofriday-ai/WpP1mu9I9Gul4MgH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Friday\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#002FF6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/spaces/register-a-space.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hellofriday.ai/#organization\",\"name\":\"Friday\",\"url\":\"https://docs.hellofriday.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/platform-hellofriday-ai/pFDsYhby1xqStMK5/logo/Friday_light.png?fit=max\u0026auto=format\u0026n=pFDsYhby1xqStMK5\u0026q=85\u0026s=5c8abf84d418faafe0e86af7b56ef0a1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hellofriday.ai#website\",\"name\":\"Friday\",\"url\":\"https://docs.hellofriday.ai\",\"publisher\":{\"@id\":\"https://docs.hellofriday.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space#webpage\",\"url\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space\",\"name\":\"Register a space\",\"description\":\"Register a space by providing the path to a directory containing a workspace.yml file.\",\"dateModified\":\"2026-05-01T09:17:43.870Z\",\"isPartOf\":{\"@id\":\"https://docs.hellofriday.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.hellofriday.ai/reference/signals/http\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.hellofriday.ai/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Spaces\",\"item\":\"https://docs.hellofriday.ai/api-reference/spaces/list-spaces\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Register a space\",\"item\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space#apireference\",\"headline\":\"Register a space\",\"name\":\"Register a space\",\"description\":\"Register a space by providing the path to a directory containing a workspace.yml file.\",\"url\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hellofriday.ai/api-reference/spaces/register-a-space#webpage\"},\"dateModified\":\"2026-05-01T09:17:43.870Z\",\"publisher\":{\"@id\":\"https://docs.hellofriday.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hellofriday.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Friday\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Friday\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/spaces/register-a-space.md","siteName":"Friday","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"star","href":"/changelog"},{"anchor":"Join our community","icon":"discord","href":"https://discord.com/invite/uczJyp5FMH"},{"anchor":"GitHub","icon":"github","href":"https://github.com/friday-platform"},{"anchor":"Contact us","icon":"envelope","href":"/contact"}]},"groups":[{"group":"Getting started","expanded":true,"pages":[{"title":"Friday Studio","href":"/index"},{"title":"Quick Start","href":"/getting-started/quickstart"},{"title":"Spaces","href":"/getting-started/spaces"},{"title":"Communicators","href":"/getting-started/communicators"}]},{"group":"Core concepts","pages":[{"title":"Architecture","href":"/core-concepts/architecture"},{"title":"Agents","href":"/core-concepts/agents"},{"title":"Jobs","href":"/core-concepts/jobs"},{"title":"Signals","href":"/core-concepts/signals"},{"title":"MCP Tools","href":"/core-concepts/mcp"},{"title":"Skills","href":"/core-concepts/skills"},{"title":"Memory","href":"/core-concepts/memory"},{"title":"Communicators","href":"/core-concepts/communicators"},{"title":"Spaces","href":"/core-concepts/spaces"},{"title":"API","href":"/core-concepts/api"}]},{"group":"Guides","pages":[{"title":"Using Friday Studio","href":"/guides/friday-studio"},{"title":"Testing Agents","href":"/guides/agent-tester"},{"title":"Inspecting Jobs","href":"/guides/job-inspector"},{"group":"Communicators","pages":[{"title":"Slack","href":"/guides/communicators/slack"},{"title":"Discord","href":"/guides/communicators/discord"},{"title":"Telegram","href":"/guides/communicators/telegram"},{"title":"WhatsApp","href":"/guides/communicators/whatsapp"},{"title":"Microsoft Teams","href":"/guides/communicators/teams"}]},{"title":"Sharing Spaces","href":"/guides/sharing-spaces"},{"title":"Call Friday from your app","href":"/guides/integrate-with-your-app"}]},{"group":"Agent SDK","pages":[{"title":"Agent SDK","href":"/sdk/overview"},{"group":"Python","pages":[{"title":"Overview","href":"/sdk/python"},{"title":"Quickstart","href":"/sdk/quickstart"},{"title":"How agents work","href":"/sdk/how-agents-work"},{"group":"Guides","pages":[{"title":"Generate text and objects","href":"/sdk/guides/call-llms"},{"title":"Fetch HTTP APIs","href":"/sdk/guides/make-http-requests"},{"title":"Call MCP tools","href":"/sdk/guides/use-mcp-tools"},{"title":"Extract structured data","href":"/sdk/guides/handle-structured-input"},{"title":"Emit progress events","href":"/sdk/guides/stream-progress"}]},{"group":"Reference","pages":[{"title":"@agent Decorator","href":"/sdk/python-reference/agent-decorator"},{"title":"AgentContext","href":"/sdk/python-reference/agent-context"},{"title":"ctx.llm","href":"/sdk/python-reference/llm-capability"},{"title":"ctx.http","href":"/sdk/python-reference/http-capability"},{"title":"ctx.tools","href":"/sdk/python-reference/tools-capability"},{"title":"ctx.stream","href":"/sdk/python-reference/stream-capability"},{"title":"Result Types","href":"/sdk/python-reference/result-types"},{"title":"Parse Utilities","href":"/sdk/python-reference/parse-utilities"}]}]}]},{"group":"Reference","pages":[{"group":"Signals","pages":[{"title":"HTTP","href":"/reference/signals/http"},{"title":"Schedule","href":"/reference/signals/schedule"},{"title":"Filesystem","href":"/reference/signals/fs-watch"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /health","href":"/api-reference/health/health-check"},{"title":"Get daemon status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/daemon/status","href":"/api-reference/health/get-daemon-status"}]},{"group":"Spaces","pages":[{"title":"List spaces","description":"List all registered spaces sorted by name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces","href":"/api-reference/spaces/list-spaces"},{"title":"Register a space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/add","href":"/api-reference/spaces/register-a-space"},{"title":"Create a space","description":"Create a new space from a configuration object. Creates the directory and files.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/create","href":"/api-reference/spaces/create-a-space"},{"title":"Get space details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/workspaces/{workspaceId}","href":"/api-reference/spaces/get-space-details"},{"title":"Delete a space","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/workspaces/{workspaceId}","href":"/api-reference/spaces/delete-a-space"}]},{"group":"Chat","pages":[{"title":"Send a chat message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/{workspaceId}/chat","href":"/api-reference/chat/send-a-chat-message"}]},{"group":"Signals","pages":[{"title":"Trigger a signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/workspaces/{workspaceId}/signals/{signalId}","href":"/api-reference/signals/trigger-a-signal"}]},{"group":"Sessions","pages":[{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/sessions","href":"/api-reference/sessions/list-sessions"},{"title":"Get session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/sessions/{id}","href":"/api-reference/sessions/get-session"},{"title":"Cancel session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/sessions/{id}","href":"/api-reference/sessions/cancel-session"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents","href":"/api-reference/agents/list-agents"},{"title":"Get agent details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/agents/{id}","href":"/api-reference/agents/get-agent-details"}]},{"group":"Artifacts","pages":[{"title":"List artifacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/artifacts","href":"/api-reference/artifacts/list-artifacts"},{"title":"Get artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/artifacts/{id}","href":"/api-reference/artifacts/get-artifact"},{"title":"Delete artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/artifacts/{id}","href":"/api-reference/artifacts/delete-artifact"},{"title":"Upload file as artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/artifacts/upload","href":"/api-reference/artifacts/upload-file-as-artifact"}]},{"group":"Configuration","pages":[{"title":"Get environment config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/config/env","href":"/api-reference/configuration/get-environment-config"},{"title":"Update environment config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/config/env","href":"/api-reference/configuration/update-environment-config"}]}]},{"title":"workspace.yml reference","href":"/reference/workspace-schema"},{"title":"CLI","href":"/reference/cli"}]},{"group":"Resources","pages":[{"title":"Security","href":"/security"}]}]},"basePath":"","title":"Register a space - Friday","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-BIYvYBgk.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}