The HTTP API is not available yet. Use the CLI or the MCP server.
The REST API is not available yet.When it ships, it will be an HTTP form of the same actions as the CLI and MCP: conversations, messages, questions, and contacts. It will not be a second product. This page will become an overview that links to each operation. Until then it has no endpoints and no examples.Use one of these today:
CLI
From a terminal, a coding agent, or CI with INBOX_SECRET_KEY.
MCP
From a chat app, at https://mcp.agentinbox.md.
Questions that have to wait are documented in Waiting for an answer. The CLI blocks. MCP calls inbox_wait.
Was this page helpful?
⌘I
{"docsConfig":{"theme":"linden","$schema":"https://mintlify.com/docs.json","name":"Agent Inbox","description":"An inbox for your agent on Telegram, Slack, and email. People write to it. The agent reads, asks, and waits for the answer.","colors":{"primary":"#ff5c30","light":"#ff5c30","dark":"#ff5c30"},"logo":{"light":"https://mintcdn.com/agentinbox/s8tqkg2OtHN8rJDj/logo/light.svg?fit=max\u0026auto=format\u0026n=s8tqkg2OtHN8rJDj\u0026q=85\u0026s=ca27b0f165550df4cc9093bf927a5560","dark":"https://mintcdn.com/agentinbox/s8tqkg2OtHN8rJDj/logo/dark.svg?fit=max\u0026auto=format\u0026n=s8tqkg2OtHN8rJDj\u0026q=85\u0026s=7267656328834fe4e996be9093022ec4"},"favicon":"https://mintcdn.com/agentinbox/lkB-JeAj0jos0wV3/favicon.svg?fit=max\u0026auto=format\u0026n=lkB-JeAj0jos0wV3\u0026q=85\u0026s=5d73857725f3a6d59c3c154881a2c8a6","seo":{"metatags":{"og:type":"website","twitter:card":"summary_large_image"},"indexing":"all"},"icons":{"library":"lucide"},"interaction":{"drilldown":true},"styling":{"latex":false},"background":{"color":{"light":"#fffaf9","dark":"#100b0c"}},"navigation":{"global":{"anchors":[{"anchor":"Agent Inbox","icon":"arrow-up-right","href":"https://www.agentinbox.md"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"agentinbox","hasAudioNarration":false,"actualSubdomain":"agentinbox","customDomains":["docs.agentinbox.md"],"gitSource":{"type":"github","owner":"novuhq","repo":"novu","deployBranch":"next","contentDirectory":"agent-inbox-docs","isPrivate":false,"mountPath":"","label":"","_id":"6ad8b73dda4f9d1dd19e8047"},"chroma":{"latestBuiltDeploymentHistoryId":"6ad9eaf5b052f87fe57e6c6b","collectionId":"6fcab9f1-7a3e-4838-a0b1-b91f3b84bf73","liveDeploymentHistoryId":"6ad9eaf5b052f87fe57e6c6b","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad9eaf5b052f87fe57e6c6b","clientVersion":"0.0.3926","searchFilterCounts":[{"language":"default","tag":"Docs","count":22},{"language":"default","tag":"Channels","count":5},{"language":"default","tag":"Inbox","count":5},{"language":"default","tag":"Set up","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Reference","count":3},{"language":"default","tag":"Account","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"reference/rest","slug":"/reference/rest","pageMetadata":{"title":"REST API","description":"The HTTP API is not available yet. Use the CLI or the MCP server.","tag":"Coming soon","href":"/reference/rest"},"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: \"The HTTP API is not available yet. Use the CLI or the MCP server.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components},{Card,Columns}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Columns)_missingMdxReference(`Columns`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The REST API is not available yet.`}),`\n`,_jsxs(_components.p,{children:[`When it ships, it will be an HTTP form of the same actions as the `,_jsx(_components.a,{href:`/reference/cli`,children:`CLI`}),` and `,_jsx(_components.a,{href:`/reference/mcp`,children:`MCP`}),`: conversations, messages, questions, and contacts. It will not be a second product. This page will become an overview that links to each operation. Until then it has no endpoints and no examples.`]}),`\n`,_jsx(_components.p,{children:`Use one of these today:`}),`\n`,_jsxs(Columns,{cols:2,children:[_jsx(Card,{title:`CLI`,icon:`terminal`,href:`/reference/cli`,children:_jsxs(_components.p,{children:[`From a terminal, a coding agent, or CI with `,_jsx(_components.code,{children:`INBOX_SECRET_KEY`}),`.`]})}),_jsx(Card,{title:`MCP`,icon:`bot`,href:`/reference/mcp`,children:_jsxs(_components.p,{children:[`From a chat app, at `,_jsx(_components.code,{children:`https://mcp.agentinbox.md`}),`.`]})})]}),`\n`,_jsxs(_components.p,{children:[`Questions that have to wait are documented in `,_jsx(_components.a,{href:`/waiting`,children:`Waiting for an answer`}),`. The CLI blocks. MCP calls `,_jsx(_components.code,{children:`inbox_wait`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"REST API","description":"The HTTP API is not available yet. Use the CLI or the MCP server.","tag":"Coming soon","href":"/reference/rest"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"agentinbox","siteName":"Agent Inbox","title":"REST API - Agent Inbox","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T09:10:27.963Z","originalFileLocation":"reference/rest.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=\"The HTTP API is not available yet. Use the CLI or the MCP server.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Agent Inbox\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_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/agentinbox/KofevYm7pTQYVf3s/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"REST API - Agent Inbox\">\u003cmeta data-mint-head property=\"og:description\" content=\"The HTTP API is not available yet. Use the CLI or the MCP server.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Agent Inbox\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentinbox.md/reference/rest\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agentinbox.mintlify.app/_mintlify/api/og/v2?division=Reference\u0026amp;title=REST+API\u0026amp;description=The+HTTP+API+is+not+available+yet.+Use+the+CLI+or+the+MCP+server.\u0026amp;theme=3b19bdd0404a4effa64cf427\u0026amp;signature=40e930fcdb52f4d5e9b2b650ee9b77046a0fc58d684813e13e9da1e632f53784\">\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=\"REST API - Agent Inbox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The HTTP API is not available yet. Use the CLI or the MCP server.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agentinbox.mintlify.app/_mintlify/api/og/v2?division=Reference\u0026amp;title=REST+API\u0026amp;description=The+HTTP+API+is+not+available+yet.+Use+the+CLI+or+the+MCP+server.\u0026amp;theme=3b19bdd0404a4effa64cf427\u0026amp;signature=40e930fcdb52f4d5e9b2b650ee9b77046a0fc58d684813e13e9da1e632f53784\">\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/agentinbox/KofevYm7pTQYVf3s/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Agent Inbox\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff5c30\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agentinbox.md/reference/rest\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/rest.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agentinbox.md/#organization\",\"name\":\"Agent Inbox\",\"url\":\"https://docs.agentinbox.md\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/agentinbox/s8tqkg2OtHN8rJDj/logo/light.svg?fit=max\u0026auto=format\u0026n=s8tqkg2OtHN8rJDj\u0026q=85\u0026s=ca27b0f165550df4cc9093bf927a5560\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agentinbox.md#website\",\"name\":\"Agent Inbox\",\"url\":\"https://docs.agentinbox.md\",\"publisher\":{\"@id\":\"https://docs.agentinbox.md/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agentinbox.md/reference/rest#webpage\",\"url\":\"https://docs.agentinbox.md/reference/rest\",\"name\":\"REST API\",\"description\":\"The HTTP API is not available yet. Use the CLI or the MCP server.\",\"dateModified\":\"2026-10-22T09:10:27.963Z\",\"isPartOf\":{\"@id\":\"https://docs.agentinbox.md#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentinbox.md/reference/rest#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentinbox.md/reference/rest#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Reference\",\"item\":\"https://docs.agentinbox.md/reference/cli\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"REST API\",\"item\":\"https://docs.agentinbox.md/reference/rest\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.agentinbox.md/reference/rest#article\",\"headline\":\"REST API\",\"name\":\"REST API\",\"description\":\"The HTTP API is not available yet. Use the CLI or the MCP server.\",\"url\":\"https://docs.agentinbox.md/reference/rest\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentinbox.md/reference/rest#webpage\"},\"dateModified\":\"2026-10-22T09:10:27.963Z\",\"publisher\":{\"@id\":\"https://docs.agentinbox.md/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agentinbox.md#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Agent Inbox\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Agent Inbox","nav":{"global":{"anchors":[{"anchor":"Agent Inbox","icon":"arrow-up-right","href":"https://www.agentinbox.md"}]},"tabs":[{"tab":"Docs","groups":[{"group":"Get started","icon":"rocket","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Quickstart","href":"/quickstart"},{"title":"Concepts","href":"/concepts"}]},{"group":"Set up","icon":"plug","pages":[{"title":"Create an inbox","href":"/setup"},{"title":"Account and claim","href":"/account"},{"title":"Connect a host","href":"/connect"},{"title":"Teach your coding agent","href":"/skills"}]},{"group":"Inbox","icon":"inbox","pages":[{"title":"Send a message","href":"/messages"},{"title":"Ask, approve, and choose","href":"/questions"},{"title":"Read the inbox","href":"/conversations"},{"title":"Waiting for an answer","href":"/waiting"},{"title":"Contacts","href":"/contacts"}]},{"group":"Channels","icon":"radio","pages":[{"title":"Channels","sidebarTitle":"Overview","href":"/channels"},{"title":"Telegram","href":"/channels/telegram"},{"title":"Slack","href":"/channels/slack"},{"title":"Email","href":"/channels/email"},{"title":"Coming next","tag":"Coming soon","href":"/channels/coming-next"}]},{"group":"Account","icon":"layout-dashboard","pages":[{"title":"Dashboard","href":"/dashboard"},{"title":"Who can reach the agent","sidebarTitle":"Who can reach","href":"/permissions"}]},{"group":"Reference","icon":"book-open","pages":[{"title":"CLI","href":"/reference/cli"},{"title":"MCP","description":"The hosted Agent Inbox MCP server: the URL, sign-in, and every tool.","href":"/reference/mcp"},{"title":"REST API","tag":"Coming soon","href":"/reference/rest"}]}]}]},"title":"REST API - Agent Inbox","buildId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","deploymentId":"dpl_9DauxEjb9gzCtcuhPQFbquJvx7FJ","dynamics":[],"chunks":[]}