Whether the agent is currently within scheduled hours
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"TalkPilot","colors":{"primary":"#F97316","light":"#FB923C","dark":"#EA580C"},"favicon":"https://mintcdn.com/talkpilot-8db57f17/MqDjkG0yYrs67v1D/favicon.png?fit=max\u0026auto=format\u0026n=MqDjkG0yYrs67v1D\u0026q=85\u0026s=d074cec1c25b16ec2a71f2adeb67e60e","api":{"openapi":["openapi.yaml"]},"navbar":{"links":[{"href":"mailto:support@talkpilot.io","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.talkpilot.io"}},"footer":{"socials":{"website":"https://talkpilot.io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api/agents"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"talkpilot-8db57f17","hasAudioNarration":false,"actualSubdomain":"talkpilot-8db57f17","customDomains":["docs.talkpilot.io"],"gitSource":{"type":"github","owner":"wcmrg77","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4c9f4c97cf9d1412c6fda","collectionId":"2c6c4323-c31d-4fc1-85ef-7c14f0a1f770","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4c9f4c97cf9d1412c6fda"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae4c9f4c97cf9d1412c6fda","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":66},{"language":"default","tag":"Endpoint Reference","count":48},{"language":"default","tag":"Documentation","count":22},{"language":"default","tag":"Product Guide","count":16},{"language":"default","tag":"API Resources","count":11},{"language":"default","tag":"Knowledge Base","count":8},{"language":"default","tag":"Agents","count":7},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"Employees","count":5},{"language":"default","tag":"Forwarding Slots","count":5}]},"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":"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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agents/get-agent-status","slug":"/api-reference/agents/get-agent-status","pageMetadata":{"openapi":"get /v1/agents/{agentId}/status","title":"Get agent status","description":"Lightweight endpoint returning only the agent's active status and\nschedule, plus the computed `is_within_schedule`. Useful for monitoring\ndashboards.\n","href":"/api-reference/agents/get-agent-status"},"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: [\"Lightweight endpoint returning only the agent’s active status and\\nschedule, plus the computed \", _jsx(_components.code, {\n children: \"is_within_schedule\"\n }), \". Useful for monitoring\\ndashboards.\"]\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":{"openapi":"get /v1/agents/{agentId}/status","title":"Get agent status","description":"Lightweight endpoint returning only the agent's active status and\nschedule, plus the computed `is_within_schedule`. Useful for monitoring\ndashboards.\n","href":"/api-reference/agents/get-agent-status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAgentStatus","tags":["Agents"],"summary":"Get agent status","description":"Lightweight endpoint returning only the agent's active status and\nschedule, plus the computed `is_within_schedule`. Useful for monitoring\ndashboards.\n","parameters":["4a919730-1ed4-4a1d-9e72-5fe5af703d44"],"responses":{"200":"37a712b4-e397-46cc-a2e5-9f7f47df0837","401":"7f88fdf1-9f55-4320-abad-f2a92138ac8a","403":"029fcb16-bc1f-44ce-b850-bbe2959a7610","404":"42247a14-b0c5-40e5-b768-e71ccac240fe","429":"78290803-52cc-4ef5-bee4-ffe375d41b1a"},"method":"get","type":"path","servers":["7174c07b-3f6d-4587-860c-b159b3fceb86"],"security":["daeed687-106f-4e81-b970-a2ffa4b47569"],"path":"/v1/agents/{agentId}/status","baseUrlOptions":["https://api.talkpilot.io"],"title":"Get agent status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4a919730-1ed4-4a1d-9e72-5fe5af703d44":{"name":"agentId","in":"path","required":true,"description":"Agent UUID","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Agent UUID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"37a712b4-e397-46cc-a2e5-9f7f47df0837":{"description":"Agent status","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"is_active":{"type":"boolean","uniqueKey":"is_active","typeLabel":"boolean"},"schedule":{"oneOf":[{"type":"object","description":"Agent business hours. When set, the agent only accepts calls during\nthe specified time windows. Outside hours, calls go to the backup agent.\n","properties":{"timezone":{"type":"string","description":"IANA timezone identifier","example":"Europe/Berlin","uniqueKey":"schedule.oneOf.0.timezone","typeLabel":"string"},"rules":{"type":"array","items":{"type":"object","required":["days","start_time","end_time"],"properties":{"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].days.items.[INDEX]","typeLabel":"integer"},"description":"Days of week (0=Sunday, 1=Monday, ..., 6=Saturday)","example":[1,2,3,4,5],"isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].days","typeLabel":"integer[]"},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"Start time in HH:mm","example":"08:00","isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].start_time","typeLabel":"string"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"End time in HH:mm","example":"18:00","isRequired":true,"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX].end_time","typeLabel":"string"}},"uniqueKey":"schedule.oneOf.0.rules.items.[INDEX]","typeLabel":"object"},"uniqueKey":"schedule.oneOf.0.rules","typeLabel":"object[]"}},"uniqueKey":"schedule.oneOf.0","typeLabel":"object"},{"type":"null","description":"Agent business hours. When set, the agent only accepts calls during\nthe specified time windows. Outside hours, calls go to the backup agent.\n","properties":{"timezone":{"type":"string","description":"IANA timezone identifier","example":"Europe/Berlin"},"rules":{"type":"array","items":{"type":"object","required":["days","start_time","end_time"],"properties":{"days":{"type":"array","items":{"type":"integer","minimum":0,"maximum":6},"description":"Days of week (0=Sunday, 1=Monday, ..., 6=Saturday)","example":[1,2,3,4,5]},"start_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"Start time in HH:mm","example":"08:00"},"end_time":{"type":"string","pattern":"^\\d{2}:\\d{2}$","description":"End time in HH:mm","example":"18:00"}}}}},"uniqueKey":"schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule","typeLabel":"object | null"},"is_within_schedule":{"type":"boolean","description":"Whether the agent is currently within scheduled hours","uniqueKey":"is_within_schedule","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Rezeption Bot","is_active":true,"schedule":{"timezone":"Europe/Berlin","rules":[{"days":[1,2,3,4,5],"start_time":"08:00","end_time":"18:00"}]},"is_within_schedule":true},"examples":{"Example":{"title":"Example","value":{"id":"550e8400-e29b-41d4-a716-446655440000","name":"Rezeption Bot","is_active":true,"schedule":{"timezone":"Europe/Berlin","rules":[{"days":[1,2,3,4,5],"start_time":"08:00","end_time":"18:00"}]},"is_within_schedule":true}}},"exampleType":"examples"}},"exampleType":"examples"},"7f88fdf1-9f55-4320-abad-f2a92138ac8a":{"description":"Missing or invalid authentication","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Invalid or missing API key","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"029fcb16-bc1f-44ce-b850-bbe2959a7610":{"description":"Insufficient permissions (`FORBIDDEN`), or the agent is outside the key's\n`allowed_agent_ids` (`AGENT_NOT_ACCESSIBLE`)\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingPermission":{"title":"missingPermission","value":{"error":{"code":"FORBIDDEN","message":"API key lacks required permission: agents:write","request_id":"req_abc123"}}},"agentNotAccessible":{"title":"agentNotAccessible","value":{"error":{"code":"AGENT_NOT_ACCESSIBLE","message":"API key does not have access to this agent","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"42247a14-b0c5-40e5-b768-e71ccac240fe":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Agent not found","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Agent not found","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"},"78290803-52cc-4ef5-bee4-ffe375d41b1a":{"description":"Too many requests for this API key (60/minute or 1,000/hour by default)","headers":{"Retry-After":{"description":"Seconds to wait before retrying — 60 for the minute window, 3600 for the hour window","schema":{"type":"integer"}},"X-RateLimit-Limit":{"schema":{"type":"integer"}},"X-RateLimit-Remaining":{"schema":{"type":"integer"}},"X-RateLimit-Reset":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","UNAUTHORIZED","FORBIDDEN","AGENT_NOT_ACCESSIBLE","NOT_FOUND","CONFLICT","AGENT_HAS_NUMBER","POOL_EMPTY","NOT_POOL_NUMBER","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.details","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Try again in 60 seconds.","request_id":"req_abc123"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded. Try again in 60 seconds.","request_id":"req_abc123"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"daeed687-106f-4e81-b970-a2ffa4b47569":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","scopes":[],"schemeName":"apiKey"}}},"servers":{"7174c07b-3f6d-4587-860c-b159b3fceb86":{"url":"https://api.talkpilot.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","scopes":[],"schemeName":"apiKey"},"schema":{"title":"X-API-Key","type":"string","description":"API key for external access. Format: `tp_live_\u003c32-hex-chars>`.\nCreate keys in the TalkPilot Dashboard under Settings > API.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"talkpilot-8db57f17","siteName":"TalkPilot","title":"Get agent status - TalkPilot","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-07T14:45:44.039Z","originalFileLocation":"api-reference/agents/get-agent-status.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=\"Lightweight endpoint returning only the agent\u0026#x27;s active status and schedule, plus the computed is_within_schedule. Useful for monitoring dashboards.\">\u003cmeta data-mint-head name=\"application-name\" content=\"TalkPilot\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get agent status - TalkPilot\">\u003cmeta data-mint-head property=\"og:description\" content=\"Lightweight endpoint returning only the agent\u0026#x27;s active status and schedule, plus the computed is_within_schedule. Useful for monitoring dashboards.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"TalkPilot\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.talkpilot.io/api-reference/agents/get-agent-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://talkpilot-8db57f17.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+agent+status\u0026amp;description=Lightweight+endpoint+returning+only+the+agent%27s+active+status+and%0Aschedule%2C+plus+the+computed+%60is_within_schedule%60.+Useful+for+monitoring%0Adashboards.%0A\u0026amp;theme=91659bae7c7a4489b0dcb7f9\u0026amp;signature=a2b8ae0401a9f92f2983185fd94915fe41532cacbe988556d39aeaf645d2239d\">\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=\"Get agent status - TalkPilot\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Lightweight endpoint returning only the agent\u0026#x27;s active status and schedule, plus the computed is_within_schedule. Useful for monitoring dashboards.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://talkpilot-8db57f17.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Get+agent+status\u0026amp;description=Lightweight+endpoint+returning+only+the+agent%27s+active+status+and%0Aschedule%2C+plus+the+computed+%60is_within_schedule%60.+Useful+for+monitoring%0Adashboards.%0A\u0026amp;theme=91659bae7c7a4489b0dcb7f9\u0026amp;signature=a2b8ae0401a9f92f2983185fd94915fe41532cacbe988556d39aeaf645d2239d\">\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/talkpilot-8db57f17/Gfa90PUZyGdcNWpj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"TalkPilot\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F97316\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.talkpilot.io/api-reference/agents/get-agent-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/get-agent-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.talkpilot.io/#organization\",\"name\":\"TalkPilot\",\"url\":\"https://docs.talkpilot.io\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.talkpilot.io#website\",\"name\":\"TalkPilot\",\"url\":\"https://docs.talkpilot.io\",\"publisher\":{\"@id\":\"https://docs.talkpilot.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status#webpage\",\"url\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status\",\"name\":\"Get agent status\",\"description\":\"Lightweight endpoint returning only the agent's active status and schedule, plus the computed is_within_schedule. Useful for monitoring dashboards.\",\"dateModified\":\"2026-09-07T14:45:44.039Z\",\"isPartOf\":{\"@id\":\"https://docs.talkpilot.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint Reference\",\"item\":\"https://docs.talkpilot.io/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.talkpilot.io/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get agent status\",\"item\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status#apireference\",\"headline\":\"Get agent status\",\"name\":\"Get agent status\",\"description\":\"Lightweight endpoint returning only the agent's active status and schedule, plus the computed is_within_schedule. Useful for monitoring dashboards.\",\"url\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status\",\"mainEntityOfPage\":{\"@id\":\"https://docs.talkpilot.io/api-reference/agents/get-agent-status#webpage\"},\"dateModified\":\"2026-09-07T14:45:44.039Z\",\"publisher\":{\"@id\":\"https://docs.talkpilot.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.talkpilot.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"TalkPilot\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"TalkPilot","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api/agents"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Resources","pages":[{"title":"Agents","href":"/api/agents"},{"title":"Workflow","href":"/api/workflow"},{"title":"Tools","href":"/api/tools"},{"title":"Employees","href":"/api/employees"},{"title":"Contacts","href":"/api/contacts"},{"title":"Forwarding Slots","href":"/api/forwarding-slots"},{"title":"Knowledge Base","href":"/api/knowledge-base"},{"title":"Calls","href":"/api/calls"},{"title":"Performance","href":"/api/performance"},{"title":"Organizations","href":"/api/organization"},{"title":"API Keys","href":"/api/api-keys"}]},{"group":"Endpoint Reference","pages":[{"group":"Health","pages":[{"openapi":"get /v1/health","title":"Health check","href":"/api-reference/health/health-check"}]},{"group":"Agents","pages":[{"openapi":"get /v1/agents","title":"List agents","href":"/api-reference/agents/list-agents"},{"openapi":"post /v1/agents","title":"Create an agent","href":"/api-reference/agents/create-an-agent"},{"openapi":"get /v1/agents/{agentId}","title":"Get agent details","href":"/api-reference/agents/get-agent-details"},{"openapi":"patch /v1/agents/{agentId}","title":"Update agent settings","description":"Partially update an agent's configuration. Only include the fields\nyou want to change. Omitted fields remain unchanged.\n\n**Note:** `phone_number`, `organization_id`, `metadata` and `retention_days`\nare read-only via the API; `workflow` has its own endpoint.\n\n**This endpoint is strict:** any field that is not updatable (unknown or\nread-only) is rejected with `400 VALIDATION_ERROR`, one `details` entry per\nfield. The other `PATCH` endpoints ignore unknown fields.\n","href":"/api-reference/agents/update-agent-settings"},{"openapi":"get /v1/agents/{agentId}/status","title":"Get agent status","href":"/api-reference/agents/get-agent-status"},{"openapi":"post /v1/agents/{agentId}/phone-number","title":"Assign a phone number","description":"Assigns a free number from the TalkPilot number pool to the agent. The\nnumbers in the pool are already fully wired, so the agent answers calls\non the new number from the next call on.\n\n**Dashboard login only:** requires a JWT of a `super_admin` or `dev_admin`.\nAPI keys are rejected with `403 FORBIDDEN`, even with `agents:write`.\n\nThe only supported `source` is `pool`. An agent that already has a phone\nnumber gets `409 AGENT_HAS_NUMBER`; if no pool number is free, the\nresponse is `409 POOL_EMPTY`.\n\nThe number is also written to the agent's employees and forwarding\nslots (`agent_phone_number`), which is how call routing finds them at\nruntime.\n\nWhen the number is released (`DELETE`) or the agent is deleted later,\nthe number goes into a 90-day quarantine and then returns to the pool\nautomatically.\n","href":"/api-reference/agents/assign-a-phone-number"},{"openapi":"delete /v1/agents/{agentId}/phone-number","title":"Release a phone number","href":"/api-reference/agents/release-a-phone-number"}]},{"group":"Workflow","pages":[{"openapi":"get /v1/agents/{agentId}/workflow","title":"Get workflow","href":"/api-reference/workflow/get-workflow"},{"openapi":"put /v1/agents/{agentId}/workflow","title":"Replace workflow","href":"/api-reference/workflow/replace-workflow"}]},{"group":"Tools","pages":[{"openapi":"get /v1/agents/{agentId}/tools","title":"List agent tools","href":"/api-reference/tools/list-agent-tools"},{"openapi":"post /v1/agents/{agentId}/tools","title":"Create a tool","href":"/api-reference/tools/create-a-tool"},{"openapi":"get /v1/agents/{agentId}/tools/{toolId}","title":"Get a tool","href":"/api-reference/tools/get-a-tool"},{"openapi":"patch /v1/agents/{agentId}/tools/{toolId}","title":"Update a tool","href":"/api-reference/tools/update-a-tool"},{"openapi":"delete /v1/agents/{agentId}/tools/{toolId}","title":"Delete a tool","href":"/api-reference/tools/delete-a-tool"}]},{"group":"Employees","pages":[{"openapi":"get /v1/agents/{agentId}/employees","title":"List employees","href":"/api-reference/employees/list-employees"},{"openapi":"post /v1/agents/{agentId}/employees","title":"Create an employee","href":"/api-reference/employees/create-an-employee"},{"openapi":"get /v1/agents/{agentId}/employees/{employeeId}","title":"Get an employee","href":"/api-reference/employees/get-an-employee"},{"openapi":"patch /v1/agents/{agentId}/employees/{employeeId}","title":"Update an employee","href":"/api-reference/employees/update-an-employee"},{"openapi":"delete /v1/agents/{agentId}/employees/{employeeId}","title":"Delete an employee","href":"/api-reference/employees/delete-an-employee"}]},{"group":"Contacts","pages":[{"openapi":"get /v1/agents/{agentId}/contacts","title":"List contacts","href":"/api-reference/contacts/list-contacts"},{"openapi":"post /v1/agents/{agentId}/contacts","title":"Create a contact","href":"/api-reference/contacts/create-a-contact"},{"openapi":"get /v1/agents/{agentId}/contacts/{contactId}","title":"Get a contact","href":"/api-reference/contacts/get-a-contact"},{"openapi":"patch /v1/agents/{agentId}/contacts/{contactId}","title":"Update a contact","href":"/api-reference/contacts/update-a-contact"},{"openapi":"delete /v1/agents/{agentId}/contacts/{contactId}","title":"Delete a contact","href":"/api-reference/contacts/delete-a-contact"}]},{"group":"Forwarding Slots","pages":[{"openapi":"get /v1/agents/{agentId}/forwarding-slots","title":"List forwarding slots","href":"/api-reference/forwarding-slots/list-forwarding-slots"},{"openapi":"post /v1/agents/{agentId}/forwarding-slots","title":"Create a forwarding slot","href":"/api-reference/forwarding-slots/create-a-forwarding-slot"},{"openapi":"put /v1/agents/{agentId}/forwarding-slots","title":"Replace all forwarding slots","href":"/api-reference/forwarding-slots/replace-all-forwarding-slots"},{"openapi":"patch /v1/agents/{agentId}/forwarding-slots/{slotId}","title":"Update a forwarding slot","href":"/api-reference/forwarding-slots/update-a-forwarding-slot"},{"openapi":"delete /v1/agents/{agentId}/forwarding-slots/{slotId}","title":"Delete a forwarding slot","href":"/api-reference/forwarding-slots/delete-a-forwarding-slot"}]},{"group":"Knowledge Base","pages":[{"openapi":"get /v1/agents/{agentId}/knowledge-base","title":"List knowledge base documents","href":"/api-reference/knowledge-base/list-knowledge-base-documents"},{"openapi":"post /v1/agents/{agentId}/knowledge-base","title":"Create a knowledge base document","href":"/api-reference/knowledge-base/create-a-knowledge-base-document"},{"openapi":"get /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Get a knowledge base document","href":"/api-reference/knowledge-base/get-a-knowledge-base-document"},{"openapi":"patch /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Update a knowledge base document","href":"/api-reference/knowledge-base/update-a-knowledge-base-document"},{"openapi":"delete /v1/agents/{agentId}/knowledge-base/{documentId}","title":"Delete a knowledge base document","href":"/api-reference/knowledge-base/delete-a-knowledge-base-document"},{"openapi":"get /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"List chunks for a document","href":"/api-reference/knowledge-base/list-chunks-for-a-document"},{"openapi":"post /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"Create chunks (batch)","href":"/api-reference/knowledge-base/create-chunks-batch"},{"openapi":"delete /v1/agents/{agentId}/knowledge-base/{documentId}/chunks","title":"Delete all chunks for a document","href":"/api-reference/knowledge-base/delete-all-chunks-for-a-document"}]},{"group":"Calls","pages":[{"openapi":"get /v1/agents/{agentId}/calls","title":"List calls","href":"/api-reference/calls/list-calls"},{"openapi":"get /v1/agents/{agentId}/calls/{callId}","title":"Get call details","href":"/api-reference/calls/get-call-details"}]},{"group":"Performance","pages":[{"openapi":"get /v1/agents/{agentId}/performance","title":"List performance records","href":"/api-reference/performance/list-performance-records"},{"openapi":"get /v1/agents/{agentId}/performance/{statisticId}","title":"Get performance record details","href":"/api-reference/performance/get-performance-record-details"}]},{"group":"Organization","pages":[{"openapi":"get /v1/organization","title":"List organizations","href":"/api-reference/organization/list-organizations"},{"openapi":"patch /v1/organization/{orgId}","title":"Update organization settings","href":"/api-reference/organization/update-organization-settings"}]},{"group":"API Keys","pages":[{"openapi":"get /v1/api-keys","title":"List API keys","href":"/api-reference/api-keys/list-api-keys"},{"openapi":"post /v1/api-keys","title":"Create an API key","href":"/api-reference/api-keys/create-an-api-key"},{"openapi":"patch /v1/api-keys/{keyId}","title":"Update an API key","href":"/api-reference/api-keys/update-an-api-key"},{"openapi":"delete /v1/api-keys/{keyId}","title":"Revoke an API key","href":"/api-reference/api-keys/revoke-an-api-key"}]}]},{"group":"Guides","pages":[{"title":"Pagination","href":"/guides/pagination"},{"title":"Error Handling","href":"/guides/error-handling"},{"title":"Rate Limiting","href":"/guides/rate-limiting"},{"title":"Webhooks","href":"/guides/webhooks"}]},{"group":"Code Examples","pages":[{"title":"cURL Examples","href":"/examples/curl"},{"title":"JavaScript / TypeScript Examples","href":"/examples/javascript"},{"title":"Python Examples","href":"/examples/python"}]}]}]},"basePath":"","title":"Get agent status - TalkPilot","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}