{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}
Receptionist
Create a receptionist task
Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.
POST
/
receptionist
/
tasks
Create a receptionist task
curl --request POST \ --url https://api.healos.ai/ext-api/v1/receptionist/tasks \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <api-key>' \ --data '{ "title": "Call back about a refill request", "category": "refill", "status": "todo", "notes": "Caller asked for a 90-day supply.", "due_date": "2026-10-30", "patient_id": "700000000000000001", "patient_label": "Pat Example", "assigned_provider_calendar_id": "<string>", "linked_call_id": "c0a80101-0000-4000-8000-000000000001"}'
{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}
Requirement
Detail
Scope
receptionist:write
Rate limit
About 60 requests per minute per API key (shared by all endpoints; approximate)
Cost
Free
Safety
Writes data: Yes. Adds a task to the AI Receptionist inbox in HealOS. It is not sent to your EHR.
Safe to retry: Only with an Idempotency-Key header: a repeat with the same key returns the first task instead of a second one. Without it, a retry creates a second task.
Contacts an outside system: None
Dry run: Not available.
Rolling out: this endpoint is on staging first and not yet on api.healos.ai.
The task appears in the dashboard inbox like one staff created (source is manual). status defaults to todo.patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization; any other id is a 404 and no task is created. A call that staff removed from Call History cannot be linked.Guide: Calls and inbox. Errors: Error catalog.
Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an Idempotent-Replayed: true header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency.
Up to 255 printable ASCII characters. Use a new random value (a UUID) for each new request and resend the same value when you retry it.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"HealOS Docs","description":"HealOS product guides for AI Scribe and AI Receptionist, plus guides, recipes and the API reference for the HealOS External API.","colors":{"primary":"#6731D7","light":"#8B5CF6","dark":"#5429AE"},"logo":{"light":"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-light.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=90de1addc301c87e1fe16e86d218b4af","dark":"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-dark.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=628ea7c8d0d101083267bd36937d327b","href":"https://healos.ai"},"favicon":"https://mintcdn.com/healos/1Zym37w0e99Y6K8x/favicon.png?fit=max\u0026auto=format\u0026n=1Zym37w0e99Y6K8x\u0026q=85\u0026s=750b7a2e719e792188d9e218d8a14c26","api":{"examples":{"languages":["bash","javascript","python"]}},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.healos.ai"}},"footer":{"socials":{"website":"https://healos.ai"}},"contextual":{"options":["copy","view","chatgpt","claude","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"healos","hasAudioNarration":false,"actualSubdomain":"healos","customDomains":["docs.healos.ai"],"gitSource":{"type":"github","owner":"medinoteorg","repo":"healos","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6ae4e1c72e0ec70f4fd8287b"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af2d49010b1a0d7de1300dd","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":64},{"language":"default","tag":"API Guides","count":56},{"language":"default","tag":"EHR Integrations","count":32},{"language":"default","tag":"Using HealOS","count":24},{"language":"default","tag":"AI Receptionist","count":11},{"language":"default","tag":"AI Scribe","count":10},{"language":"default","tag":"Notes","count":9},{"language":"default","tag":"Receptionist","count":8},{"language":"default","tag":"Get Started","count":8},{"language":"default","tag":"Fax","count":6}]},"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/receptionist/create-a-receptionist-task","slug":"/api-reference/receptionist/create-a-receptionist-task","pageMetadata":{"openapi":"openapi/ext-api-v1.json POST /receptionist/tasks","title":"Create a receptionist task","description":"Adds a task to the AI Receptionist inbox, as staff do with New task. `status` defaults to `todo`. `patient_id`, `linked_call_id` and `assigned_provider_calendar_id` must belong to your organization (404 otherwise). Requires the receptionist:write scope.","href":"/api-reference/receptionist/create-a-receptionist-task"},"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: [\"Adds a task to the AI Receptionist inbox, as staff do with New task. \", _jsx(_components.code, {\n children: \"status\"\n }), \" defaults to \", _jsx(_components.code, {\n children: \"todo\"\n }), \". \", _jsx(_components.code, {\n children: \"patient_id\"\n }), \", \", _jsx(_components.code, {\n children: \"linked_call_id\"\n }), \" and \", _jsx(_components.code, {\n children: \"assigned_provider_calendar_id\"\n }), \" must belong to your organization (404 otherwise). Requires the receptionist:write scope.\"]\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`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Note,Table}=_components;if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Requirement`}),_jsx(_components.th,{children:`Detail`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Scope`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`receptionist:write`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Rate limit`})}),_jsx(_components.td,{children:`About 60 requests per minute per API key (shared by all endpoints; approximate)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Cost`})}),_jsx(_components.td,{children:`Free`})]})]})]}),`\n`,_jsxs(Note,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Safety`})}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Writes data:`}),` Yes. Adds a task to the AI Receptionist inbox in HealOS. It is not sent to your EHR.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Safe to retry:`}),` Only with an `,_jsx(_components.code,{children:`Idempotency-Key`}),` header: a repeat with the same key returns the first task instead of a second one. Without it, a retry creates a second task.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Contacts an outside system:`}),` None`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Dry run:`}),` Not available.`]}),`\n`]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Rolling out: this endpoint is on staging first and not yet on `,_jsx(_components.code,{children:`api.healos.ai`}),`.`]})}),`\n`,_jsxs(_components.p,{children:[`The task appears in the dashboard inbox like one staff created (`,_jsx(_components.code,{children:`source`}),` is `,_jsx(_components.code,{children:`manual`}),`). `,_jsx(_components.code,{children:`status`}),` defaults to `,_jsx(_components.code,{children:`todo`}),`.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`patient_id`}),`, `,_jsx(_components.code,{children:`linked_call_id`}),` and `,_jsx(_components.code,{children:`assigned_provider_calendar_id`}),` must belong to your organization; any other id is a `,_jsx(_components.code,{children:`404`}),` and no task is created. A call that staff removed from Call History cannot be linked.`]}),`\n`,_jsxs(_components.p,{children:[`Guide: `,_jsx(_components.a,{href:`/guides/receptionist/calls-and-inbox`,children:`Calls and inbox`}),`. Errors: `,_jsx(_components.a,{href:`/errors`,children:`Error catalog`}),`.`]})]})}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":{"openapi":"openapi/ext-api-v1.json POST /receptionist/tasks","title":"Create a receptionist task","description":"Adds a task to the AI Receptionist inbox, as staff do with New task. `status` defaults to `todo`. `patient_id`, `linked_call_id` and `assigned_provider_calendar_id` must belong to your organization (404 otherwise). Requires the receptionist:write scope.","href":"/api-reference/receptionist/create-a-receptionist-task"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Receptionist"],"summary":"Create a receptionist task","description":"Adds a task to the AI Receptionist inbox, as staff do with New task. `status` defaults to `todo`. `patient_id`, `linked_call_id` and `assigned_provider_calendar_id` must belong to your organization (404 otherwise). Requires the receptionist:write scope.","requestBody":"da7b72e1-6479-4ba6-9e8d-ba2e6bf6f45c","responses":{"201":"cc5ac20f-3737-40a4-8749-6e4eeebba5e1","400":"91b865b9-7ec7-4fe1-a7ab-337d3e09dfc8","401":"a18fa3b1-9a15-4223-a31a-9ccb8d2ff2fe","403":"9fefcdcc-47c5-49c2-bb5b-0db62e3e5fd2","404":"a8105602-e88a-49de-8b2d-a73f1712fd81","409":"d7cfeda4-2c26-4ee0-b70d-1816c51e25d1","422":"12da4804-41fe-4bd1-8d08-8503d754272e","429":"e588830c-493b-4762-b5d8-3819be1ffc8a"},"parameters":["3949318d-eb95-4592-87f7-2d756c881bb8"],"method":"post","type":"path","servers":["a92d3741-dd38-4df3-b5dc-86f2ddc4f4bb","10214492-4974-49fd-b287-2cb6d30ebc92"],"security":["b356c10e-7bfb-49bf-bf0d-be98d19bb20a"],"path":"/receptionist/tasks","baseUrlOptions":["https://api.healos.ai/ext-api/v1","http://localhost:8787/ext-api/v1"],"title":"Create a receptionist task","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3949318d-eb95-4592-87f7-2d756c881bb8":{"schema":{"type":"string","minLength":1,"maxLength":255,"description":"Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an `Idempotent-Replayed: true` header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency.\nUp to 255 printable ASCII characters. Use a new random value (a UUID) for each new request and resend the same value when you retry it.","example":"5f0c3a8e-2b7d-4c1e-9a64-0d3f2e1b7c90","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"name":"Idempotency-Key","in":"header","description":"Makes a retry of this request safe. A repeat with the same key and the same request within 24 hours does not run again: it returns the original status with the resource as it is now, and an `Idempotent-Replayed: true` header. Keys are scoped to your organization and API key. See https://docs.healos.ai/idempotency."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":500,"example":"Call back about a refill request","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"category":{"oneOf":[{"type":"string","enum":["action","communicate","coordinate","document","order","call_followup","billing","insurance","refill","records","referral","appointment"],"description":"One of: action, communicate, coordinate, document, order, call_followup, billing, insurance, refill, records, referral, appointment.","example":"refill","uniqueKey":"category.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["action","communicate","coordinate","document","order","call_followup","billing","insurance","refill","records","referral","appointment"],"description":"One of: action, communicate, coordinate, document, order, call_followup, billing, insurance, refill, records, referral, appointment.","example":"refill","uniqueKey":"category.oneOf.1","typeLabel":"null"}],"uniqueKey":"category","typeLabel":"enum\u003cstring> | null"},"status":{"type":"string","enum":["todo","done","archived"],"description":"`todo` (open), `done` (resolved) or `archived` (hidden from the default inbox view).","example":"todo","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"notes":{"oneOf":[{"type":"string","maxLength":10000,"example":"Caller asked for a 90-day supply.","uniqueKey":"notes.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10000,"example":"Caller asked for a 90-day supply.","uniqueKey":"notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes","typeLabel":"string | null"},"due_date":{"oneOf":[{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2026-10-30","uniqueKey":"due_date.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^\\d{4}-\\d{2}-\\d{2}$","example":"2026-10-30","uniqueKey":"due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"due_date","typeLabel":"string | null"},"patient_id":{"oneOf":[{"type":"string","pattern":"^\\d{1,19}$","description":"A patient in your organization (GET /patients). Another organization's patient is a 404.","example":"700000000000000001","uniqueKey":"patient_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^\\d{1,19}$","description":"A patient in your organization (GET /patients). Another organization's patient is a 404.","example":"700000000000000001","uniqueKey":"patient_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient_id","typeLabel":"string | null"},"patient_label":{"oneOf":[{"type":"string","maxLength":300,"description":"The patient name the inbox row shows.","example":"Pat Example","uniqueKey":"patient_label.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":300,"description":"The patient name the inbox row shows.","example":"Pat Example","uniqueKey":"patient_label.oneOf.1","typeLabel":"null"}],"uniqueKey":"patient_label","typeLabel":"string | null"},"assigned_provider_calendar_id":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"Assign the task to one of your organization's AI Receptionist provider calendars.","uniqueKey":"assigned_provider_calendar_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"Assign the task to one of your organization's AI Receptionist provider calendars.","uniqueKey":"assigned_provider_calendar_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"assigned_provider_calendar_id","typeLabel":"string | null"},"linked_call_id":{"oneOf":[{"type":"string","pattern":"^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"The call this task came from (GET /receptionist/calls). Another organization's call is a 404.","example":"c0a80101-0000-4000-8000-000000000001","uniqueKey":"linked_call_id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$","description":"The call this task came from (GET /receptionist/calls). Another organization's call is a 404.","example":"c0a80101-0000-4000-8000-000000000001","uniqueKey":"linked_call_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"linked_call_id","typeLabel":"string | null"}},"required":["title"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"Call back about a refill request","category":"refill","status":"todo","notes":"Caller asked for a 90-day supply.","due_date":"2026-10-30","patient_id":"700000000000000001","patient_label":"Pat Example","assigned_provider_calendar_id":"\u003cstring>","linked_call_id":"c0a80101-0000-4000-8000-000000000001"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"cc5ac20f-3737-40a4-8749-6e4eeebba5e1":{"description":"Task created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"7a5c0000-0000-4000-8000-000000000001","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"title":{"type":"string","isRequired":true,"uniqueKey":"data.title","typeLabel":"string"},"category":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.category.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.category","typeLabel":"string | null"},"status":{"type":"string","example":"todo","isRequired":true,"uniqueKey":"data.status","typeLabel":"string"},"source":{"type":"string","description":"`manual` (created by staff or the API), `call` (created from a call) or `system`.","example":"call","isRequired":true,"uniqueKey":"data.source","typeLabel":"string"},"notes":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.notes.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.notes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string | null"},"due_date":{"oneOf":[{"type":"string","example":"2026-10-30","isRequired":true,"uniqueKey":"data.due_date.oneOf.0","typeLabel":"string"},{"type":"null","example":"2026-10-30","isRequired":true,"uniqueKey":"data.due_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.due_date","typeLabel":"string | null"},"patient_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.patient_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.patient_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.patient_id","typeLabel":"string | null"},"patient_label":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.patient_label.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.patient_label.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.patient_label","typeLabel":"string | null"},"assigned_provider_calendar_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.assigned_provider_calendar_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.assigned_provider_calendar_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.assigned_provider_calendar_id","typeLabel":"string | null"},"linked_call_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.linked_call_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.linked_call_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.linked_call_id","typeLabel":"string | null"},"caller_phone":{"oneOf":[{"type":"string","description":"The number the linked call came from, for a call back. Null without a phone call.","example":"+15555550100","isRequired":true,"uniqueKey":"data.caller_phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number the linked call came from, for a call back. Null without a phone call.","example":"+15555550100","isRequired":true,"uniqueKey":"data.caller_phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.caller_phone","typeLabel":"string | null"},"ehr_source":{"oneOf":[{"type":"string","description":"The EHR the organization had connected when the task was created.","isRequired":true,"uniqueKey":"data.ehr_source.oneOf.0","typeLabel":"string"},{"type":"null","description":"The EHR the organization had connected when the task was created.","isRequired":true,"uniqueKey":"data.ehr_source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.ehr_source","typeLabel":"string | null"},"created_at":{"type":"string","example":"2026-10-27T14:07:50.000Z","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","example":"2026-10-27T14:08:02.000Z","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string"}},"required":["id","title","category","status","source","notes","due_date","patient_id","patient_label","assigned_provider_calendar_id","linked_call_id","caller_phone","ehr_source","created_at","updated_at"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"7a5c0000-0000-4000-8000-000000000001","title":"\u003cstring>","category":"\u003cstring>","status":"todo","source":"call","notes":"\u003cstring>","due_date":"2026-10-30","patient_id":"\u003cstring>","patient_label":"\u003cstring>","assigned_provider_calendar_id":"\u003cstring>","linked_call_id":"\u003cstring>","caller_phone":"+15555550100","ehr_source":"\u003cstring>","created_at":"2026-10-27T14:07:50.000Z","updated_at":"2026-10-27T14:08:02.000Z"}}}},"exampleType":"generated"}},"headers":{"Idempotent-Replayed":{"description":"`true` when this response is a replay of an earlier request with the same `Idempotency-Key`.","schema":{"type":"string","enum":["true"]}}},"exampleType":"generated"},"91b865b9-7ec7-4fe1-a7ab-337d3e09dfc8":{"description":"Validation error: a blank or overlong title, an unknown field, category or status, or a malformed id or date; or `Idempotency-Key` is empty, longer than 255 characters or not printable ASCII","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.details.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.details.additionalProperties","typeLabel":"string[]"},"uniqueKey":"oneOf.0.details","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"a18fa3b1-9a15-4223-a31a-9ccb8d2ff2fe":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9fefcdcc-47c5-49c2-bb5b-0db62e3e5fd2":{"description":"Insufficient scope (needs receptionist:write)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"a8105602-e88a-49de-8b2d-a73f1712fd81":{"description":"The patient, call or provider calendar is not your organization's","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d7cfeda4-2c26-4ee0-b70d-1816c51e25d1":{"description":"A request with this `Idempotency-Key` is still being processed (`idempotency_in_progress`; retry after `Retry-After`)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"idempotency_key_invalid"}}},"exampleType":"generated"}},"exampleType":"generated"},"12da4804-41fe-4bd1-8d08-8503d754272e":{"description":"This `Idempotency-Key` was already used for a different request (`idempotency_key_reused`)","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["idempotency_key_invalid","idempotency_in_progress","idempotency_key_reused","idempotency_resource_gone"],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"}},"required":["error","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"idempotency_key_invalid"}}},"exampleType":"generated"}},"exampleType":"generated"},"e588830c-493b-4762-b5d8-3819be1ffc8a":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Rate limit exceeded. Please retry after the window resets.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["daily_cap_reached"],"description":"Set when the organization reached its daily cap for this paid operation (not on a per-minute limit).","uniqueKey":"code","typeLabel":"enum\u003cstring>"},"reset_at":{"type":"string","format":"date-time","description":"With `code`: when the daily cap resets (next 00:00 UTC).","example":"2026-10-28T00:00:00.000Z","uniqueKey":"reset_at","typeLabel":"string\u003cdate-time>"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"Rate limit exceeded. Please retry after the window resets.","code":"daily_cap_reached","reset_at":"2026-10-28T00:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b356c10e-7bfb-49bf-bf0d-be98d19bb20a":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key obtained from /api/v1/ext-api-keys","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"a92d3741-dd38-4df3-b5dc-86f2ddc4f4bb":{"url":"https://api.healos.ai/ext-api/v1","description":"Production"},"10214492-4974-49fd-b287-2cb6d30ebc92":{"url":"http://localhost:8787/ext-api/v1","description":"Local development"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key obtained from /api/v1/ext-api-keys","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"API key obtained from /api/v1/ext-api-keys","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/ext-api-v1.json"},"subdomain":"healos","siteName":"HealOS Docs","title":"Create a receptionist task - HealOS Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T21:06:57.848Z","originalFileLocation":"api-reference/receptionist/create-a-receptionist-task.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=\"Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HealOS Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_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/healos/bYFVQ6a9UFiIgFbT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a receptionist task - HealOS Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HealOS Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://healos.mintlify.site/_mintlify/api/og/v2?division=Receptionist\u0026amp;title=Create+a+receptionist+task\u0026amp;description=Adds+a+task+to+the+AI+Receptionist+inbox%2C+as+staff+do+with+New+task.+%60status%60+defaults+to+%60todo%60.+%60patient_id%60%2C+%60linked_call_id%60+and+%60assigned_provider_calendar\u0026amp;theme=49307a7035225162b4a02b71\u0026amp;signature=18bfcc406ee2e097034a3a54aa15300e2d63f533be8e00e09a907b88d5a45341\">\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=\"Create a receptionist task - HealOS Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://healos.mintlify.site/_mintlify/api/og/v2?division=Receptionist\u0026amp;title=Create+a+receptionist+task\u0026amp;description=Adds+a+task+to+the+AI+Receptionist+inbox%2C+as+staff+do+with+New+task.+%60status%60+defaults+to+%60todo%60.+%60patient_id%60%2C+%60linked_call_id%60+and+%60assigned_provider_calendar\u0026amp;theme=49307a7035225162b4a02b71\u0026amp;signature=18bfcc406ee2e097034a3a54aa15300e2d63f533be8e00e09a907b88d5a45341\">\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/healos/bYFVQ6a9UFiIgFbT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HealOS Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6731D7\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/receptionist/create-a-receptionist-task.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.healos.ai/#organization\",\"name\":\"HealOS Docs\",\"url\":\"https://docs.healos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/healos/M3Or2eJe4P95ax9C/logo/healos-light.png?fit=max\u0026auto=format\u0026n=M3Or2eJe4P95ax9C\u0026q=85\u0026s=90de1addc301c87e1fe16e86d218b4af\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.healos.ai#website\",\"name\":\"HealOS Docs\",\"url\":\"https://docs.healos.ai\",\"publisher\":{\"@id\":\"https://docs.healos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task#webpage\",\"url\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task\",\"name\":\"Create a receptionist task\",\"description\":\"Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.\",\"dateModified\":\"2026-11-05T21:06:57.848Z\",\"isPartOf\":{\"@id\":\"https://docs.healos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Receptionist\",\"item\":\"https://docs.healos.ai/api-reference/receptionist/list-receptionist-calls\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a receptionist task\",\"item\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task#apireference\",\"headline\":\"Create a receptionist task\",\"name\":\"Create a receptionist task\",\"description\":\"Adds a task to the AI Receptionist inbox, as staff do with New task. status defaults to todo. patient_id, linked_call_id and assigned_provider_calendar_id must belong to your organization (404 otherwise). Requires the receptionist:write scope.\",\"url\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task\",\"mainEntityOfPage\":{\"@id\":\"https://docs.healos.ai/api-reference/receptionist/create-a-receptionist-task#webpage\"},\"dateModified\":\"2026-11-05T21:06:57.848Z\",\"publisher\":{\"@id\":\"https://docs.healos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.healos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HealOS Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"HealOS Docs","nav":{"global":null,"tabs":[{"tab":"Using HealOS","pages":[{"title":"Using HealOS","href":"/guides/scribe/overview"}]},{"tab":"API Guides","pages":[{"title":"API Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference"}]},{"group":"Account","pages":[{"openapi":"openapi/ext-api-v1.json GET /me","title":"Describe the calling API key","href":"/api-reference/account/describe-the-calling-api-key"}]},{"group":"Patients","pages":[{"openapi":"openapi/ext-api-v1.json GET /patients","title":"List patients","href":"/api-reference/patients/list-patients"},{"openapi":"openapi/ext-api-v1.json POST /patients","title":"Create a new patient","href":"/api-reference/patients/create-a-new-patient"},{"openapi":"openapi/ext-api-v1.json GET /patients/{patientId}","title":"Get patient by ID","href":"/api-reference/patients/get-patient-by-id"},{"openapi":"openapi/ext-api-v1.json PATCH /patients/{patientId}","title":"Update a patient","href":"/api-reference/patients/update-a-patient"},{"openapi":"openapi/ext-api-v1.json DELETE /patients/{patientId}","title":"Delete a patient","href":"/api-reference/patients/delete-a-patient"}]},{"group":"Documents","pages":[{"openapi":"openapi/ext-api-v1.json GET /patients/{patientId}/documents","title":"List patient documents","href":"/api-reference/documents/list-patient-documents"},{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/documents","title":"Upload a document","href":"/api-reference/documents/upload-a-document"},{"openapi":"openapi/ext-api-v1.json DELETE /patients/{patientId}/documents/{documentId}","title":"Delete a document","href":"/api-reference/documents/delete-a-document"},{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/documents/{documentId}/extract","title":"Extract or retry document text extraction","href":"/api-reference/documents/extract-or-retry-document-text-extraction"}]},{"group":"Appointments","pages":[{"openapi":"openapi/ext-api-v1.json GET /appointments","title":"List appointments","href":"/api-reference/appointments/list-appointments"},{"openapi":"openapi/ext-api-v1.json POST /appointments","title":"Create an appointment","href":"/api-reference/appointments/create-an-appointment"},{"openapi":"openapi/ext-api-v1.json GET /appointments/{appointmentId}","title":"Get appointment by ID","href":"/api-reference/appointments/get-appointment-by-id"},{"openapi":"openapi/ext-api-v1.json PATCH /appointments/{appointmentId}","title":"Update an appointment","href":"/api-reference/appointments/update-an-appointment"},{"openapi":"openapi/ext-api-v1.json DELETE /appointments/{appointmentId}","title":"Delete an appointment","href":"/api-reference/appointments/delete-an-appointment"}]},{"group":"Providers","pages":[{"openapi":"openapi/ext-api-v1.json GET /providers","title":"List providers","href":"/api-reference/providers/list-providers"},{"openapi":"openapi/ext-api-v1.json GET /providers/{providerId}","title":"Get provider by ID","href":"/api-reference/providers/get-provider-by-id"}]},{"group":"Notes","pages":[{"openapi":"openapi/ext-api-v1.json POST /patients/{patientId}/notes/from-documents","title":"Generate a note from the patient's documents","href":"/api-reference/notes/generate-a-note-from-the-patients-documents"},{"openapi":"openapi/ext-api-v1.json GET /notes","title":"List clinical notes","href":"/api-reference/notes/list-clinical-notes"},{"openapi":"openapi/ext-api-v1.json GET /notes/{noteId}","title":"Get a clinical note by ID","href":"/api-reference/notes/get-a-clinical-note-by-id"},{"openapi":"openapi/ext-api-v1.json GET /notes/export","title":"Export clinical notes","href":"/api-reference/notes/export-clinical-notes"},{"openapi":"openapi/ext-api-v1.json GET /sessions/{sessionId}/notes","title":"List notes for a session","href":"/api-reference/notes/list-notes-for-a-session"},{"openapi":"openapi/ext-api-v1.json POST /sessions/{sessionId}/notes/regenerate","title":"Regenerate the note for a session","href":"/api-reference/notes/regenerate-the-note-for-a-session"},{"openapi":"openapi/ext-api-v1.json PATCH /sessions/{sessionId}","title":"Assign a patient to a session","href":"/api-reference/notes/assign-a-patient-to-a-session"},{"openapi":"openapi/ext-api-v1.json POST /notes/from-text","title":"Generate a note from text","href":"/api-reference/notes/generate-a-note-from-text"},{"openapi":"openapi/ext-api-v1.json POST /notes/from-audio","title":"Generate a note from an audio file","href":"/api-reference/notes/generate-a-note-from-an-audio-file"}]},{"group":"Sessions","pages":[{"openapi":"openapi/ext-api-v1.json GET /sessions/{sessionId}","title":"Get session details","href":"/api-reference/sessions/get-session-details"},{"openapi":"openapi/ext-api-v1.json DELETE /sessions/{sessionId}","title":"Delete a session","href":"/api-reference/sessions/delete-a-session"},{"openapi":"openapi/ext-api-v1.json POST /sessions/{sessionId}/restore","title":"Restore a deleted session","href":"/api-reference/sessions/restore-a-deleted-session"}]},{"group":"Templates","pages":[{"openapi":"openapi/ext-api-v1.json GET /templates","title":"List templates","href":"/api-reference/templates/list-templates"},{"openapi":"openapi/ext-api-v1.json GET /templates/{templateId}","title":"Get a template","href":"/api-reference/templates/get-a-template"}]},{"group":"Settings","pages":[{"openapi":"openapi/ext-api-v1.json GET /settings/notes","title":"Get note settings","href":"/api-reference/settings/get-note-settings"}]},{"group":"Fax","pages":[{"openapi":"openapi/ext-api-v1.json GET /faxes","title":"List received faxes","href":"/api-reference/fax/list-received-faxes"},{"openapi":"openapi/ext-api-v1.json GET /faxes/{faxId}","title":"Get a received fax","href":"/api-reference/fax/get-a-received-fax"},{"openapi":"openapi/ext-api-v1.json GET /faxes/{faxId}/file","title":"Download a received fax","href":"/api-reference/fax/download-a-received-fax"},{"openapi":"openapi/ext-api-v1.json GET /faxes/outbound","title":"List sent faxes","href":"/api-reference/fax/list-sent-faxes"},{"openapi":"openapi/ext-api-v1.json GET /faxes/outbound/{outboundFaxId}","title":"Get a sent fax","href":"/api-reference/fax/get-a-sent-fax"}]},{"group":"Benefits","pages":[{"openapi":"openapi/ext-api-v1.json POST /benefits/eligibility-checks","title":"Run an eligibility check","href":"/api-reference/benefits/run-an-eligibility-check"},{"openapi":"openapi/ext-api-v1.json GET /benefits/eligibility-checks","title":"List eligibility checks","href":"/api-reference/benefits/list-eligibility-checks"},{"openapi":"openapi/ext-api-v1.json GET /benefits/eligibility-checks/{checkId}","title":"Get an eligibility check","href":"/api-reference/benefits/get-an-eligibility-check"},{"openapi":"openapi/ext-api-v1.json GET /benefits/payers/search","title":"Search payers","href":"/api-reference/benefits/search-payers"}]},{"group":"Prior Auth","pages":[{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests","title":"List prior-auth requests","href":"/api-reference/prior-auth/list-prior-auth-requests"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests/{requestId}","title":"Get a prior-auth request","href":"/api-reference/prior-auth/get-a-prior-auth-request"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/requests/{requestId}/events","title":"List a request's events","href":"/api-reference/prior-auth/list-a-requests-events"},{"openapi":"openapi/ext-api-v1.json GET /prior-auth/workflows","title":"List prior-auth workflows","href":"/api-reference/prior-auth/list-prior-auth-workflows"},{"openapi":"openapi/ext-api-v1.json POST /prior-auth/status-checks","title":"Check Availity decisions now","href":"/api-reference/prior-auth/check-availity-decisions-now"}]},{"group":"EHR","pages":[{"openapi":"openapi/ext-api-v1.json GET /ehr/actions","title":"List EHR actions","href":"/api-reference/ehr/list-ehr-actions"},{"openapi":"openapi/ext-api-v1.json GET /ehr/actions/{actionName}","title":"Get an EHR action","href":"/api-reference/ehr/get-an-ehr-action"},{"openapi":"openapi/ext-api-v1.json GET /ehr/connections","title":"List your EHR connections","href":"/api-reference/ehr/list-your-ehr-connections"}]},{"group":"Receptionist","pages":[{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls","title":"List receptionist calls","href":"/api-reference/receptionist/list-receptionist-calls"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls/{callId}","title":"Get a receptionist call","href":"/api-reference/receptionist/get-a-receptionist-call"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/calls/{callId}/recording","title":"Download a call recording","href":"/api-reference/receptionist/download-a-call-recording"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/tasks","title":"List receptionist tasks","href":"/api-reference/receptionist/list-receptionist-tasks"},{"openapi":"openapi/ext-api-v1.json GET /receptionist/tasks/{taskId}","title":"Get a receptionist task","description":"One AI Receptionist inbox task. Returns 404 if the task isn't your organization's. Requires the receptionist:read scope.","href":"/api-reference/receptionist/get-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json POST /receptionist/tasks","title":"Create a receptionist task","href":"/api-reference/receptionist/create-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json PATCH /receptionist/tasks/{taskId}","title":"Update a receptionist task","description":"Changes the fields you send and leaves the rest. Resolve a task with `{\"status\": \"done\"}`; send `null` to clear an optional field. Linked ids must belong to your organization. Returns 404 if the task isn't your organization's. Requires the receptionist:write scope.","href":"/api-reference/receptionist/update-a-receptionist-task"},{"openapi":"openapi/ext-api-v1.json DELETE /receptionist/tasks/{taskId}","title":"Delete a receptionist task","href":"/api-reference/receptionist/delete-a-receptionist-task"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/ext-api-v1.json GET /webhooks","title":"List webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"openapi/ext-api-v1.json GET /webhooks/{webhookId}","title":"Get a webhook","href":"/api-reference/webhooks/get-a-webhook"},{"openapi":"openapi/ext-api-v1.json POST /webhooks","title":"Create a webhook","href":"/api-reference/webhooks/create-a-webhook"},{"openapi":"openapi/ext-api-v1.json PATCH /webhooks/{webhookId}","title":"Update a webhook","href":"/api-reference/webhooks/update-a-webhook"},{"openapi":"openapi/ext-api-v1.json DELETE /webhooks/{webhookId}","title":"Delete a webhook","href":"/api-reference/webhooks/delete-a-webhook"}]},{"group":"Audit","pages":[{"openapi":"openapi/ext-api-v1.json GET /audit-events","title":"List audit events","href":"/api-reference/audit/list-audit-events"}]}]}]},"basePath":"","title":"Create a receptionist task - HealOS Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}