The Work API publishes its contract as OpenAPI 3.1 at /v1/openapi.json, with an interactive reference at /v1/reference. Only the versioned /v1 surface is in it. Full reference pages generated from the released contract are tracked in the Work docs issue.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Worksong","description":"Documentation for Worksong: agents, conversations, tasks and Work.","colors":{"primary":"#00A344","light":"#00C752","dark":"#00A344"},"logo":{"light":"https://mintcdn.com/worksong/tw1YN_Zq6cC3i5u_/logo/light.svg?fit=max\u0026auto=format\u0026n=tw1YN_Zq6cC3i5u_\u0026q=85\u0026s=b1c02a5c8d79d76ce8588d803cf80be6","dark":"https://mintcdn.com/worksong/tw1YN_Zq6cC3i5u_/logo/dark.svg?fit=max\u0026auto=format\u0026n=tw1YN_Zq6cC3i5u_\u0026q=85\u0026s=e897bd133333ff9c832774bdfeccecb7","href":"/"},"favicon":"https://mintcdn.com/worksong/tw1YN_Zq6cC3i5u_/favicon.png?fit=max\u0026auto=format\u0026n=tw1YN_Zq6cC3i5u_\u0026q=85\u0026s=561b6eac402a3b0ee518dd32e76a19c8","styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"worksong","hasAudioNarration":false,"actualSubdomain":"worksong","customDomains":["docs.worksong.ai"],"gitSource":{"type":"github","owner":"worksong-ai","repo":"docs","deployBranch":"main","contentDirectory":"site","isPrivate":true,"mountPath":"","label":"","_id":"6ad9dd772668d2d859de42ef"},"chroma":{"latestBuiltDeploymentHistoryId":"6ad9fe902668d2d859e1ab2c","collectionId":"6c30a38c-1efc-475f-b9cb-0f05a1f4c108","liveDeploymentHistoryId":"6ad9fe902668d2d859e1ab2c","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ada11f4ea294acc1137eeb2","clientVersion":"0.0.3926","searchFilterCounts":[{"language":"default","tag":"Worksong","count":9},{"language":"default","tag":"Work","count":5},{"language":"default","tag":"Developers","count":3},{"language":"default","tag":"Start here","count":3},{"language":"default","tag":"Reference","count":3},{"language":"default","tag":"Admin and security","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/work-api","slug":"/api/work-api","pageMetadata":{"title":"Work API","description":"Where to get the OpenAPI contract for Work.","component":"work","visibility":"public","verified":"code","source":["worksong-ai/Boardy:src/Boardy.Api/Program.cs@6775786"],"href":"/api/work-api"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Where to get the OpenAPI contract for Work.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`The Work API publishes its contract as OpenAPI 3.1 at `,_jsx(_components.code,{children:`/v1/openapi.json`}),`, with an interactive reference at `,_jsx(_components.code,{children:`/v1/reference`}),`. Only the versioned `,_jsx(_components.code,{children:`/v1`}),` surface is in it. Full reference pages generated from the released contract are tracked in `,_jsx(_components.a,{href:`https://github.com/worksong-ai/docs/issues/4`,children:`the Work docs issue`}),`.`]})}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":"Work API","description":"Where to get the OpenAPI contract for Work.","component":"work","visibility":"public","verified":"code","source":["worksong-ai/Boardy:src/Boardy.Api/Program.cs@6775786"],"href":"/api/work-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"worksong","siteName":"Worksong","title":"Work API - Worksong","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T12:16:32.693Z","originalFileLocation":"api/work-api.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=\"Where to get the OpenAPI contract for Work.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Worksong\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_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/worksong/8xN9XJyVzyDoOcmT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Work API - Worksong\">\u003cmeta data-mint-head property=\"og:description\" content=\"Where to get the OpenAPI contract for Work.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Worksong\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.worksong.ai/api/work-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://worksong.mintlify.app/_mintlify/api/og/v2?division=Developers\u0026amp;title=Work+API\u0026amp;description=Where+to+get+the+OpenAPI+contract+for+Work.\u0026amp;theme=4323a68dc2fbe92e7da601b5\u0026amp;signature=dd913be42ce0278b9215503ff9b88d7e92b1cac7693e8274f06dffd9b28e7dfb\">\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=\"Work API - Worksong\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Where to get the OpenAPI contract for Work.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://worksong.mintlify.app/_mintlify/api/og/v2?division=Developers\u0026amp;title=Work+API\u0026amp;description=Where+to+get+the+OpenAPI+contract+for+Work.\u0026amp;theme=4323a68dc2fbe92e7da601b5\u0026amp;signature=dd913be42ce0278b9215503ff9b88d7e92b1cac7693e8274f06dffd9b28e7dfb\">\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/worksong/8xN9XJyVzyDoOcmT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Worksong\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00A344\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.worksong.ai/api/work-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/work-api.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.worksong.ai/#organization\",\"name\":\"Worksong\",\"url\":\"https://docs.worksong.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/worksong/tw1YN_Zq6cC3i5u_/logo/light.svg?fit=max\u0026auto=format\u0026n=tw1YN_Zq6cC3i5u_\u0026q=85\u0026s=b1c02a5c8d79d76ce8588d803cf80be6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.worksong.ai#website\",\"name\":\"Worksong\",\"url\":\"https://docs.worksong.ai\",\"publisher\":{\"@id\":\"https://docs.worksong.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.worksong.ai/api/work-api#webpage\",\"url\":\"https://docs.worksong.ai/api/work-api\",\"name\":\"Work API\",\"description\":\"Where to get the OpenAPI contract for Work.\",\"dateModified\":\"2026-10-22T12:16:32.693Z\",\"isPartOf\":{\"@id\":\"https://docs.worksong.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.worksong.ai/api/work-api#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.worksong.ai/api/work-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Developers\",\"item\":\"https://docs.worksong.ai/api/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Work API\",\"item\":\"https://docs.worksong.ai/api/work-api\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.worksong.ai/api/work-api#article\",\"headline\":\"Work API\",\"name\":\"Work API\",\"description\":\"Where to get the OpenAPI contract for Work.\",\"url\":\"https://docs.worksong.ai/api/work-api\",\"mainEntityOfPage\":{\"@id\":\"https://docs.worksong.ai/api/work-api#webpage\"},\"dateModified\":\"2026-10-22T12:16:32.693Z\",\"publisher\":{\"@id\":\"https://docs.worksong.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.worksong.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Worksong\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Worksong","nav":{"global":null,"groups":[{"group":"Start here","pages":[{"title":"Worksong documentation","href":"/index"},{"title":"What is Worksong?","href":"/getting-started/what-is-worksong"},{"title":"Concepts","href":"/getting-started/concepts"}]},{"group":"Worksong","pages":[{"title":"Agents","href":"/worksong/agents"},{"title":"Conversations and Groups","href":"/worksong/conversations-and-groups"},{"title":"Tasks","href":"/worksong/tasks"},{"title":"Approvals","href":"/worksong/approvals"},{"title":"Routines and memory","href":"/worksong/routines-and-memory"},{"title":"Connections, Skills and Tool servers","href":"/worksong/connections-skills-tool-servers"},{"title":"Secrets","href":"/worksong/secrets"},{"title":"Computer","href":"/worksong/computer"},{"title":"Files and projects","href":"/worksong/files-and-projects"}]},{"group":"Work","pages":[{"title":"Work overview","href":"/work/overview"},{"title":"Boards, columns and items","href":"/work/boards-and-items"},{"title":"Automations, gates and Agents","href":"/work/automations-gates-agents"},{"title":"Templates","href":"/work/templates"},{"title":"Search in Work","href":"/work/search"}]},{"group":"Developers","pages":[{"title":"API overview","href":"/api/overview"},{"title":"Worksong API","description":"Status of the Worksong API reference.","href":"/api/worksong-api"},{"title":"Work API","href":"/api/work-api"}]},{"group":"Admin and security","pages":[{"title":"Security and permissions","description":"What protects your data and what you control.","href":"/admin/security-and-permissions"}]},{"group":"Reference","pages":[{"title":"Glossary","href":"/reference/glossary"},{"title":"FAQ","href":"/reference/faq"},{"title":"Release notes","href":"/releases/index"}]}]},"title":"Work API - Worksong","buildId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","deploymentId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","dynamics":[],"chunks":[]}