cleared can be set to a timestamp indicating when follow-ups (work external to Synthpop) related to this Task have been completed. Initialized to null upon Task creation.
Timestamp indicating when the latest status change for this task occurred. This indicates when a Task entered processing, waiting, completed or failed state. For pending tasks this is set to the same value as created.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Synthpop","description":"Build patient-journey automation — intake, coverage, and engagement — through one API.","colors":{"primary":"#FB009F","light":"#FF66C4","dark":"#C2007A"},"logo":{"light":"https://mintcdn.com/synthpop/iAq5a50OWADyCmkV/logo/light.png?fit=max\u0026auto=format\u0026n=iAq5a50OWADyCmkV\u0026q=85\u0026s=ea4d2c5b903dcc439031983528dcece5","dark":"https://mintcdn.com/synthpop/iAq5a50OWADyCmkV/logo/dark.png?fit=max\u0026auto=format\u0026n=iAq5a50OWADyCmkV\u0026q=85\u0026s=41a4c542813d07abb682af1a81b56a2f"},"favicon":"https://mintcdn.com/synthpop/iAq5a50OWADyCmkV/favicon.png?fit=max\u0026auto=format\u0026n=iAq5a50OWADyCmkV\u0026q=85\u0026s=6dc711fa2fc21f76d03f35f7f26d900e","navbar":{"primary":{"type":"button","label":"Request access","href":"https://www.synthpop.ai/contact-us"}},"footer":{"socials":{"website":"https://synthpop.ai/"}},"fonts":{"heading":{"family":"NaN Serf B","weight":500,"source":"fonts/NaNSerfBHeadline-Medium.woff2","format":"woff2"},"body":{"family":"Neue Haas Grotesk Display","weight":400,"source":"fonts/NHGDisplay-55Roman.woff2","format":"woff2"}},"integrations":{"ga4":{"measurementId":"G-ZN1VC2CPF0"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"synthpop","hasAudioNarration":false,"actualSubdomain":"synthpop","customDomains":["docs.synthpop.ai"],"gitSource":{"type":"github","owner":"synthpop-inc","repo":"synthpop-mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af5933d9aa4e2cefaca4833","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"API reference","count":9},{"language":"default","tag":"Endpoints","count":8},{"language":"default","tag":"Tasks","count":6},{"language":"default","tag":"Patient engagement","count":5},{"language":"default","tag":"Core concepts","count":4},{"language":"default","tag":"Working with the API","count":4},{"language":"default","tag":"Resources","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Referral \u0026 order intake","count":3}]},"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":[{"filePath":"style.css","content":".prose a,article a{color:#C2007A}.dark .prose a,.dark article a{color:#FF66C4}"}],"page":{"pagePath":"api-reference/tasks/retrieve-a-task","slug":"/api-reference/tasks/retrieve-a-task","pageMetadata":{"title":"Retrieve a Task.","description":"Retrieve a task either using Synthpop's API or an external ID.\n\nEither `uuid` or `external_id` must be specified. Specifying none or both will raise a\n`HTTP 400` type error.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task/get","href":"/api-reference/tasks/retrieve-a-task","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieve a task either using Synthpop’s API or an external ID.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Either \", _jsx(_components.code, {\n children: \"uuid\"\n }), \" or \", _jsx(_components.code, {\n children: \"external_id\"\n }), \" must be specified. Specifying none or both will raise a\\n\", _jsx(_components.code, {\n children: \"HTTP 400\"\n }), \" type error.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a Task.","description":"Retrieve a task either using Synthpop's API or an external ID.\n\nEither `uuid` or `external_id` must be specified. Specifying none or both will raise a\n`HTTP 400` type error.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task/get","href":"/api-reference/tasks/retrieve-a-task","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Tasks"],"summary":"Retrieve a Task.","description":"Retrieve a task either using Synthpop's API or an external ID.\n\nEither `uuid` or `external_id` must be specified. Specifying none or both will raise a\n`HTTP 400` type error.","operationId":"p_api_get_task_task_get_get","parameters":["edc60a31-a59c-4816-843d-d504d1d881b3","314c754f-3af7-47f9-95f5-dc3e00f1be1c"],"responses":{"200":"6decdf4c-8288-4adc-a964-d53820a62875","400":"ecb77613-0c1c-4172-8b8e-e91883c996ca","404":"52015971-1f69-4f7b-abcd-7fdcaeee0688","422":"451e2080-e4aa-4606-aad1-acb70fc18804"},"security":["a573c2f9-f626-4196-ab4f-f5c79db5ce7d"],"method":"get","type":"path","servers":["b96bc96e-b431-49ab-85ac-a5c5df9ac2f0","1f841823-0105-43a3-bdbd-49e59db12d28"],"path":"/task/get","baseUrlOptions":["https://app.synthpop.ai/public/v1","https://stage.synthpop.ai/public/v1"],"title":"Retrieve a Task.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"edc60a31-a59c-4816-843d-d504d1d881b3":{"name":"uuid","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Uuid","description":"The UUID of the task to retrieve.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Uuid","description":"The UUID of the task to retrieve.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"},"description":"The UUID of the task to retrieve."},"314c754f-3af7-47f9-95f5-dc3e00f1be1c":{"name":"external_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"External Id","description":"The external task ID of the task to retrieve.","maxLength":1024,"uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"The external task ID of the task to retrieve.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"},"description":"The external task ID of the task to retrieve."}},"responses":{"6decdf4c-8288-4adc-a964-d53820a62875":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid","description":"A unique ID for the Task.","isRequired":true,"uniqueKey":"uuid","typeLabel":"string\u003cuuid>"},"task_type":{"type":"string","title":"Task Type","description":"A Task's type. Determines what kind of processing is performed on the input data.","isRequired":true,"uniqueKey":"task_type","typeLabel":"string"},"status":{"type":"string","enum":["pending","processing","waiting","completed","failed","invalid","deferred"],"title":"TaskStatus","description":"Current state of a task.\n\n- `pending`: The task is waiting to be processed.\n- `processing`: The task is currently being processed.\n- `waiting`: The task is waiting for additional input.\n- `completed`: The task has completed processing.\n- `failed`: An error occurred while the task was being processed.\n- `invalid`: The data uploaded does not provide any information pertaining to\n the task to be performed.\n- `deferred`: The bulk processing task has been put into a deferred state due to high load","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"name":{"type":"string","title":"Name","description":"A user friendly name, based on information extracted from inputs.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"cleared":{"oneOf":[{"type":"string","title":"Cleared","description":"`cleared` can be set to a timestamp indicating when follow-ups (work external to Synthpop) related to this Task have been completed. Initialized to `null` upon Task creation.","format":"date-time","isRequired":true,"uniqueKey":"cleared.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Cleared","description":"`cleared` can be set to a timestamp indicating when follow-ups (work external to Synthpop) related to this Task have been completed. Initialized to `null` upon Task creation.","isRequired":true,"uniqueKey":"cleared.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cleared","typeLabel":"string\u003cdate-time> | null"},"created":{"type":"string","format":"date-time","title":"Created","description":"Timestamp indicating when this task was created.","isRequired":true,"uniqueKey":"created","typeLabel":"string\u003cdate-time>"},"latest_status_change":{"type":"string","format":"date-time","title":"Latest Status Change","description":"Timestamp indicating when the latest status change for this task occurred. This indicates when a Task entered `processing`, `waiting`, `completed` or `failed` state. For `pending` tasks this is set to the same value as `created`.","isRequired":true,"uniqueKey":"latest_status_change","typeLabel":"string\u003cdate-time>"},"category":{"oneOf":[{"type":"string","title":"Category","description":"Suggested task category, as determined by the medical records found.","isRequired":true,"uniqueKey":"category.oneOf.0","typeLabel":"string"},{"type":"null","title":"Category","description":"Suggested task category, as determined by the medical records found.","isRequired":true,"uniqueKey":"category.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"category","typeLabel":"string | null"},"data_items":{"items":{"oneOf":[{"type":"object","title":"DataItemFile","required":["uuid","group","tag","created","data_type"],"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid","description":"Unique ID of the data item.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.uuid","typeLabel":"string\u003cuuid>"},"group":{"type":"string","title":"Group","description":"The name of the group this data item is part of. `inputs` and `outputs` are present in each type of task, but different task types might add additional data groups.","examples":["inputs"],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.group","typeLabel":"string"},"tag":{"type":"string","title":"Tag","description":"An identifier specifying the type of data. Useful for identifying the type of content for data items created during processing. (for example, a clinical-notes group, a supporting-documents group, or a missing-items group).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.tag","typeLabel":"string"},"created":{"type":"string","format":"date-time","title":"Created","description":"Time when this data item was uploaded.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.created","typeLabel":"string\u003cdate-time>"},"data_type":{"type":"string","const":"file","title":"Data Type","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.data_type","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.name","typeLabel":"string | null"},"data_format":{"oneOf":[{"type":"string","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.0.data_format.oneOf.0","typeLabel":"string"},{"type":"null","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.0.data_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.data_format","typeLabel":"string | null"},"medical_records":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique ID of this record.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].id","typeLabel":"integer"},"record_type":{"type":"string","title":"Record Type","description":"Type of record such as `insurance-card` or `patient-visit`.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].record_type","typeLabel":"string"},"sections":{"items":{"properties":{"start":{"type":"integer","title":"Start","description":"Start offset within the document the medical record was extracted from. For PDF documents this is a page number. For audio recordings this is a recording offset (in seconds).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].start","typeLabel":"integer"},"length":{"oneOf":[{"type":"integer","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length","typeLabel":"integer | null"},"content":{"oneOf":[{"type":"string","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content","typeLabel":"string | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"Extracted fields.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"Extracted fields.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["start","length","content"],"title":"MedicalRecordSection","description":"A section of a medical record, such as a page of a PDF.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX]","typeLabel":"MedicalRecordSection · object"},"type":"array","minItems":1,"title":"Sections","description":"Sections (pages) that this medical record is comprised of.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].sections","typeLabel":"MedicalRecordSection · object[]"},"timestamp":{"oneOf":[{"type":"string","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","format":"date-time","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time> | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["id","record_type","sections"],"title":"MedicalRecord","description":"A medical record as extracted from a part of a document.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0.items.[INDEX]","typeLabel":"MedicalRecord · object"},"title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.0","typeLabel":"MedicalRecord · object[]"},{"type":"null","title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.medical_records","typeLabel":"MedicalRecord · object[] | null"},"alias":{"oneOf":[{"type":"string","title":"Alias","description":"If present, alias consisting of {task_id}/{data_item_id}, referring to the original data item.","uniqueKey":"data_items.items.[INDEX].oneOf.0.alias.oneOf.0","typeLabel":"string"},{"type":"null","title":"Alias","description":"If present, alias consisting of {task_id}/{data_item_id}, referring to the original data item.","uniqueKey":"data_items.items.[INDEX].oneOf.0.alias.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.0.alias","typeLabel":"string | null"}},"uniqueKey":"data_items.items.[INDEX].oneOf.0","typeLabel":"DataItemFile · object"},{"type":"object","title":"DataItemJSON","description":"A data item that contains JSON.","required":["uuid","group","tag","created","data_type","data"],"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid","description":"Unique ID of the data item.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.uuid","typeLabel":"string\u003cuuid>"},"group":{"type":"string","title":"Group","description":"The name of the group this data item is part of. `inputs` and `outputs` are present in each type of task, but different task types might add additional data groups.","examples":["inputs"],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.group","typeLabel":"string"},"tag":{"type":"string","title":"Tag","description":"An identifier specifying the type of data. Useful for identifying the type of content for data items created during processing. (for example, a clinical-notes group, a supporting-documents group, or a missing-items group).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.tag","typeLabel":"string"},"created":{"type":"string","format":"date-time","title":"Created","description":"Time when this data item was uploaded.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.created","typeLabel":"string\u003cdate-time>"},"data_type":{"type":"string","const":"json","title":"Data Type","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.data_type","typeLabel":"string"},"data":{"additionalProperties":true,"type":"object","title":"Data","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.data","typeLabel":"Data · object"},"name":{"oneOf":[{"type":"string","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.1.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.1.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.name","typeLabel":"string | null"},"data_format":{"oneOf":[{"type":"string","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.1.data_format.oneOf.0","typeLabel":"string"},{"type":"null","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.1.data_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.data_format","typeLabel":"string | null"},"medical_records":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique ID of this record.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].id","typeLabel":"integer"},"record_type":{"type":"string","title":"Record Type","description":"Type of record such as `insurance-card` or `patient-visit`.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].record_type","typeLabel":"string"},"sections":{"items":{"properties":{"start":{"type":"integer","title":"Start","description":"Start offset within the document the medical record was extracted from. For PDF documents this is a page number. For audio recordings this is a recording offset (in seconds).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].start","typeLabel":"integer"},"length":{"oneOf":[{"type":"integer","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length","typeLabel":"integer | null"},"content":{"oneOf":[{"type":"string","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content","typeLabel":"string | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"Extracted fields.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"Extracted fields.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["start","length","content"],"title":"MedicalRecordSection","description":"A section of a medical record, such as a page of a PDF.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX]","typeLabel":"MedicalRecordSection · object"},"type":"array","minItems":1,"title":"Sections","description":"Sections (pages) that this medical record is comprised of.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].sections","typeLabel":"MedicalRecordSection · object[]"},"timestamp":{"oneOf":[{"type":"string","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","format":"date-time","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time> | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["id","record_type","sections"],"title":"MedicalRecord","description":"A medical record as extracted from a part of a document.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0.items.[INDEX]","typeLabel":"MedicalRecord · object"},"title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.0","typeLabel":"MedicalRecord · object[]"},{"type":"null","title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.1.medical_records","typeLabel":"MedicalRecord · object[] | null"}},"uniqueKey":"data_items.items.[INDEX].oneOf.1","typeLabel":"DataItemJSON · object"},{"type":"object","title":"DataItemText","description":"A data item that contains text.","required":["uuid","group","tag","created","data_type","data"],"properties":{"uuid":{"type":"string","format":"uuid","title":"Uuid","description":"Unique ID of the data item.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.uuid","typeLabel":"string\u003cuuid>"},"group":{"type":"string","title":"Group","description":"The name of the group this data item is part of. `inputs` and `outputs` are present in each type of task, but different task types might add additional data groups.","examples":["inputs"],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.group","typeLabel":"string"},"tag":{"type":"string","title":"Tag","description":"An identifier specifying the type of data. Useful for identifying the type of content for data items created during processing. (for example, a clinical-notes group, a supporting-documents group, or a missing-items group).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.tag","typeLabel":"string"},"created":{"type":"string","format":"date-time","title":"Created","description":"Time when this data item was uploaded.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.created","typeLabel":"string\u003cdate-time>"},"data_type":{"type":"string","const":"text","title":"Data Type","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.data_type","typeLabel":"string"},"data":{"type":"string","title":"Data","description":"The text represented by this data item","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.data","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.2.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"An optional user-friendly name. Might be derived from the file name for files.","uniqueKey":"data_items.items.[INDEX].oneOf.2.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.name","typeLabel":"string | null"},"data_format":{"oneOf":[{"type":"string","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.2.data_format.oneOf.0","typeLabel":"string"},{"type":"null","title":"Data Format","description":"Optional description of the format of the data. For JSON fields this might include an identifier of the expected JSONSchema.","uniqueKey":"data_items.items.[INDEX].oneOf.2.data_format.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.data_format","typeLabel":"string | null"},"medical_records":{"oneOf":[{"type":"array","items":{"properties":{"id":{"type":"integer","title":"Id","description":"Unique ID of this record.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].id","typeLabel":"integer"},"record_type":{"type":"string","title":"Record Type","description":"Type of record such as `insurance-card` or `patient-visit`.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].record_type","typeLabel":"string"},"sections":{"items":{"properties":{"start":{"type":"integer","title":"Start","description":"Start offset within the document the medical record was extracted from. For PDF documents this is a page number. For audio recordings this is a recording offset (in seconds).","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].start","typeLabel":"integer"},"length":{"oneOf":[{"type":"integer","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Length","description":"Length from `start` within the document corresponding to this medical record. Pages for PDFs, seconds for audio recordings. A value of `null` indicates until the end of the document.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].length","typeLabel":"integer | null"},"content":{"oneOf":[{"type":"string","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","description":"Extracted relevant content, such as OCR, extracted form data or a voice transcript.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].content","typeLabel":"string | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"Extracted fields.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"Extracted fields.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["start","length","content"],"title":"MedicalRecordSection","description":"A section of a medical record, such as a page of a PDF.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections.items.[INDEX]","typeLabel":"MedicalRecordSection · object"},"type":"array","minItems":1,"title":"Sections","description":"Sections (pages) that this medical record is comprised of.","isRequired":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].sections","typeLabel":"MedicalRecordSection · object[]"},"timestamp":{"oneOf":[{"type":"string","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","format":"date-time","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Timestamp","description":"A timestamp representing when this record was created. This is *not* the document upload or processing time, but the creation date of the medical information within this record. (\"When did the patient visit happen?\")","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].timestamp","typeLabel":"string\u003cdate-time> | null"},"fields":{"oneOf":[{"type":"object","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","additionalProperties":true,"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].fields.oneOf.0","typeLabel":"Fields · object"},{"type":"null","title":"Fields","description":"The aggregate of fields extracted from sections in is medical record.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX].fields","typeLabel":"Fields · object | null"}},"type":"object","required":["id","record_type","sections"],"title":"MedicalRecord","description":"A medical record as extracted from a part of a document.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0.items.[INDEX]","typeLabel":"MedicalRecord · object"},"title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.0","typeLabel":"MedicalRecord · object[]"},{"type":"null","title":"Medical Records","description":"Medical records found within this data item.","uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records.oneOf.1","typeLabel":"null"}],"uniqueKey":"data_items.items.[INDEX].oneOf.2.medical_records","typeLabel":"MedicalRecord · object[] | null"}},"uniqueKey":"data_items.items.[INDEX].oneOf.2","typeLabel":"DataItemText · object"}],"uniqueKey":"data_items.items.[INDEX]","typeLabel":"DataItemFile · object | DataItemJSON · object | DataItemText · object"},"type":"array","title":"Data Items","isRequired":true,"uniqueKey":"data_items","typeLabel":"(DataItemFile · object | DataItemJSON · object | DataItemText · object)[]"},"issues":{"items":{"oneOf":[{"type":"object","title":"TaskIssueGenericLLM","description":"A generic task issue reported by the LLM.","required":["message"],"properties":{"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.0.message","typeLabel":"string"},"key":{"type":"string","const":"task.llm.other","title":"Key","description":"A generic task issue reported by the LLM that currently does not have a specific error type.","default":"task.llm.other","uniqueKey":"issues.items.[INDEX].oneOf.0.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.0","typeLabel":"TaskIssueGenericLLM · object"},{"type":"object","title":"TaskIssueGenericLogic","description":"A generic task issue reported by a logic check performed on the code.","required":["message","code"],"properties":{"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.1.message","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"The HCPC or other code that failed the logic check","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.1.code","typeLabel":"string"},"key":{"type":"string","const":"task.logic.fail","title":"Key","description":"A generic issue reported by a logic check performed on the code.","default":"task.logic.fail","uniqueKey":"issues.items.[INDEX].oneOf.1.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.1","typeLabel":"TaskIssueGenericLogic · object"},{"type":"object","title":"TaskIssueGenericWarning","description":"A generic warning for a logic check performed on the code.","required":["message","code"],"properties":{"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.2.message","typeLabel":"string"},"code":{"type":"string","title":"Code","description":"The HCPC or other code needs human review for logic check","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.2.code","typeLabel":"string"},"key":{"type":"string","const":"task.logic.warning","title":"Key","description":"A generic warning for a logic check performed on the code.","default":"task.logic.warning","uniqueKey":"issues.items.[INDEX].oneOf.2.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.2","typeLabel":"TaskIssueGenericWarning · object"},{"type":"object","title":"TaskIssueDataMissing","description":"A data item required for the task to be processed is missing from the input.","required":["message","property"],"properties":{"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.3.message","typeLabel":"string"},"property":{"type":"string","title":"Property","description":"Type of required information that is missing.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.3.property","typeLabel":"string"},"key":{"type":"string","const":"task.data.missing","title":"Key","description":"A data item required for the task to be processed is missing from the input.","default":"task.data.missing","uniqueKey":"issues.items.[INDEX].oneOf.3.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.3","typeLabel":"TaskIssueDataMissing · object"},{"type":"object","title":"TaskIssueMissingRecord","description":"A required medical record type is missing.","required":["medical_record_type","message"],"properties":{"medical_record_type":{"type":"string","title":"Medical Record Type","description":"The type of medical record to which the issue applies.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.4.medical_record_type","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.4.message","typeLabel":"string"},"key":{"type":"string","const":"task.medical_record.missing","title":"Key","description":"A required medical record type is missing.","default":"task.medical_record.missing","uniqueKey":"issues.items.[INDEX].oneOf.4.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.4","typeLabel":"TaskIssueMissingRecord · object"},{"type":"object","title":"TaskIssueIncorrectDocumentSequence","description":"The sequence of documents provided does not meet requirements.","required":["medical_record_type","message"],"properties":{"medical_record_type":{"type":"string","title":"Medical Record Type","description":"The type of medical record to which the issue applies.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.5.medical_record_type","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.5.message","typeLabel":"string"},"key":{"type":"string","const":"task.medical_record.incorrect_sequence","title":"Key","description":"The sequence of documents provided does not meet requirements.","default":"task.medical_record.incorrect_sequence","uniqueKey":"issues.items.[INDEX].oneOf.5.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.5","typeLabel":"TaskIssueIncorrectDocumentSequence · object"},{"type":"object","title":"TaskIssueInconsistentData","description":"Inconsistent data found across medical documents in the task.","required":["property","message"],"properties":{"property":{"type":"string","title":"Property","description":"Data property exhibiting the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.6.property","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.6.message","typeLabel":"string"},"key":{"type":"string","const":"task.data.inconsistent","title":"Key","description":"Inconsistent data found across medical documents in the task.","default":"task.data.inconsistent","uniqueKey":"issues.items.[INDEX].oneOf.6.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.6","typeLabel":"TaskIssueInconsistentData · object"},{"type":"object","title":"TaskIssueExpired","description":"A medical record's service date is too far in the past.","required":["medical_record_type","message"],"properties":{"medical_record_type":{"type":"string","title":"Medical Record Type","description":"The type of medical record to which the issue applies.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.7.medical_record_type","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.7.message","typeLabel":"string"},"key":{"type":"string","const":"task.medical_record.expired","title":"Key","description":"A medical record's service date is too far in the past.","default":"task.medical_record.expired","uniqueKey":"issues.items.[INDEX].oneOf.7.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.7","typeLabel":"TaskIssueExpired · object"},{"type":"object","title":"MedicalRecordIssueDataMissing","description":"Information that is required to be provided for a certain type of medical record is missing.","required":["property","medical_record_type","message"],"properties":{"property":{"type":"string","title":"Property","description":"Data property exhibiting the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.8.property","typeLabel":"string"},"medical_record_type":{"type":"string","title":"Medical Record Type","description":"The type of medical record to which the issue applies.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.8.medical_record_type","typeLabel":"string"},"message":{"type":"string","title":"Message","description":"A user-friendly English text representing the issue.","isRequired":true,"uniqueKey":"issues.items.[INDEX].oneOf.8.message","typeLabel":"string"},"key":{"type":"string","const":"medical_record.data.missing","title":"Key","description":"Information that is required to be provided for a certain type of medical record is missing","default":"medical_record.data.missing","uniqueKey":"issues.items.[INDEX].oneOf.8.key","typeLabel":"string"}},"uniqueKey":"issues.items.[INDEX].oneOf.8","typeLabel":"MedicalRecordIssueDataMissing · object"}],"uniqueKey":"issues.items.[INDEX]","typeLabel":"TaskIssueGenericLLM · object | TaskIssueGenericLogic · object | TaskIssueGenericWarning · object | TaskIssueDataMissing · object | TaskIssueMissingRecord · object | TaskIssueIncorrectDocumentSequence · object | TaskIssueInconsistentData · object | TaskIssueExpired · object | MedicalRecordIssueDataMissing · object"},"type":"array","title":"Issues","description":"Issues detected with this task or any medical records of it.","isRequired":true,"uniqueKey":"issues","typeLabel":"(TaskIssueGenericLLM · object | TaskIssueGenericLogic · object | TaskIssueGenericWarning · object | TaskIssueDataMissing · object | TaskIssueMissingRecord · object | TaskIssueIncorrectDocumentSequence · object | TaskIssueInconsistentData · object | TaskIssueExpired · object | MedicalRecordIssueDataMissing · object)[]"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"An optional third party assigned ID for the task.","maxLength":1024,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"An optional third party assigned ID for the task.","uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"},"verdicts":{"items":{"properties":{"code":{"type":"string","title":"Code","description":"Code to be evaluated (such as HCPCS, or Exxxx codes).","isRequired":true,"uniqueKey":"verdicts.items.[INDEX].code","typeLabel":"string"},"approved":{"type":"boolean","title":"Approved","description":"Was the code approved?","isRequired":true,"uniqueKey":"verdicts.items.[INDEX].approved","typeLabel":"boolean"},"issues":{"items":{"type":"integer","uniqueKey":"verdicts.items.[INDEX].issues.items.[INDEX]","typeLabel":"integer"},"type":"array","title":"Issues","description":"A list of indices referring to the TaskDetails.issues list, indicating which issues affect this Verdict and might have caused to not be approved.","isRequired":true,"uniqueKey":"verdicts.items.[INDEX].issues","typeLabel":"integer[]"}},"type":"object","required":["code","approved","issues"],"title":"Verdict","description":"A verdict for a task.","uniqueKey":"verdicts.items.[INDEX]","typeLabel":"Verdict · object"},"type":"array","title":"Verdicts","description":"List of verdicts for the task.","uniqueKey":"verdicts","typeLabel":"Verdict · object[]"},"interceptions":{"oneOf":[{"type":"object","title":"Interceptions","description":"Optional interception data including structured_data with pages-details.","additionalProperties":{"items":{"oneOf":[{}],"uniqueKey":"interceptions.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"any"},"type":"array","uniqueKey":"interceptions.oneOf.0.additionalProperties","typeLabel":"any[]"},"uniqueKey":"interceptions.oneOf.0","typeLabel":"Interceptions · object"},{"type":"null","title":"Interceptions","description":"Optional interception data including structured_data with pages-details.","uniqueKey":"interceptions.oneOf.1","typeLabel":"null"}],"uniqueKey":"interceptions","typeLabel":"Interceptions · object | null"},"verdict_summaries":{"items":{"properties":{"code":{"type":"string","title":"Code","description":"Code the conclusion summary applies to (such as HCPCS or Exxxx codes).","isRequired":true,"uniqueKey":"verdict_summaries.items.[INDEX].code","typeLabel":"string"},"conclusion":{"type":"string","title":"Conclusion","description":"Human-readable conclusion summary for this code.","isRequired":true,"uniqueKey":"verdict_summaries.items.[INDEX].conclusion","typeLabel":"string"}},"type":"object","required":["code","conclusion"],"title":"VerdictSummary","description":"A per-code referral-validation conclusion summary.","uniqueKey":"verdict_summaries.items.[INDEX]","typeLabel":"VerdictSummary · object"},"type":"array","title":"Verdict Summaries","description":"Per-code referral-validation conclusion summaries.","uniqueKey":"verdict_summaries","typeLabel":"VerdictSummary · object[]"}},"type":"object","required":["uuid","task_type","status","name","cleared","created","latest_status_change","category","data_items","issues"],"title":"TaskDetails","uniqueKey":"","typeLabel":"TaskDetails · object"},"examples":{"Example":{"title":"Example","value":{"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","task_type":"\u003cstring>","status":"pending","name":"\u003cstring>","cleared":"2023-11-07T05:31:56Z","created":"2023-11-07T05:31:56Z","latest_status_change":"2023-11-07T05:31:56Z","category":"\u003cstring>","data_items":[{"uuid":"3c90c3cc-0d44-4b50-8888-8dd25736052a","group":"inputs","tag":"\u003cstring>","created":"2023-11-07T05:31:56Z","data_type":"file","name":"\u003cstring>","data_format":"\u003cstring>","medical_records":[{"id":123,"record_type":"\u003cstring>","sections":[{"start":123,"length":123,"content":"\u003cstring>","fields":{}}],"timestamp":"2023-11-07T05:31:56Z","fields":{}}],"alias":"\u003cstring>"}],"issues":[{"message":"\u003cstring>","key":"task.llm.other"}],"external_id":"\u003cstring>","verdicts":[{"code":"\u003cstring>","approved":true,"issues":[123]}],"interceptions":{},"verdict_summaries":[{"code":"\u003cstring>","conclusion":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ecb77613-0c1c-4172-8b8e-e91883c996ca":{"description":"Exactly one of task_id or external_id must be specified.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"52015971-1f69-4f7b-abcd-7fdcaeee0688":{"description":"No task was found matching the specified ID.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"451e2080-e4aa-4606-aad1-acb70fc18804":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a573c2f9-f626-4196-ab4f-f5c79db5ce7d":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"b96bc96e-b431-49ab-85ac-a5c5df9ac2f0":{"url":"https://app.synthpop.ai/public/v1","description":"Production"},"1f841823-0105-43a3-bdbd-49e59db12d28":{"url":"https://stage.synthpop.ai/public/v1","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"synthpop","siteName":"Synthpop","title":"Retrieve a Task. - Synthpop","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T10:22:01.307Z","originalFileLocation":"api-reference/tasks/retrieve-a-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=\"Retrieve a task either using Synthpop\u0026#x27;s API or an external ID. Either uuid or external_id must be specified. Specifying none or both will raise a HTTP 400 type error.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Synthpop\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_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/synthpop/7HtEvRHbJtHfWbPH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a Task. - Synthpop\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a task either using Synthpop\u0026#x27;s API or an external ID. Either uuid or external_id must be specified. Specifying none or both will raise a HTTP 400 type error.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Synthpop\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://synthpop.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Retrieve+a+Task.\u0026amp;description=Retrieve+a+task+either+using+Synthpop%27s+API+or+an+external+ID.%0A%0AEither+%60uuid%60+or+%60external_id%60+must+be+specified.+Specifying+none+or+both+will+raise+a%0A%60HTTP+400\u0026amp;theme=4ef178fb47054605cc561714\u0026amp;signature=76fbd2717545d8f9f8bd056847d6792644292a3eca214ad5551a957fae4a57a2\">\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=\"Retrieve a Task. - Synthpop\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a task either using Synthpop\u0026#x27;s API or an external ID. Either uuid or external_id must be specified. Specifying none or both will raise a HTTP 400 type error.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://synthpop.mintlify.site/_mintlify/api/og/v2?division=Tasks\u0026amp;title=Retrieve+a+Task.\u0026amp;description=Retrieve+a+task+either+using+Synthpop%27s+API+or+an+external+ID.%0A%0AEither+%60uuid%60+or+%60external_id%60+must+be+specified.+Specifying+none+or+both+will+raise+a%0A%60HTTP+400\u0026amp;theme=4ef178fb47054605cc561714\u0026amp;signature=76fbd2717545d8f9f8bd056847d6792644292a3eca214ad5551a957fae4a57a2\">\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/synthpop/7HtEvRHbJtHfWbPH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Synthpop\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FB009F\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-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/tasks/retrieve-a-task.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.synthpop.ai/#organization\",\"name\":\"Synthpop\",\"url\":\"https://docs.synthpop.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/synthpop/iAq5a50OWADyCmkV/logo/light.png?fit=max\u0026auto=format\u0026n=iAq5a50OWADyCmkV\u0026q=85\u0026s=ea4d2c5b903dcc439031983528dcece5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.synthpop.ai#website\",\"name\":\"Synthpop\",\"url\":\"https://docs.synthpop.ai\",\"publisher\":{\"@id\":\"https://docs.synthpop.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task#webpage\",\"url\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task\",\"name\":\"Retrieve a Task.\",\"description\":\"Retrieve a task either using Synthpop's API or an external ID. Either uuid or external_id must be specified. Specifying none or both will raise a HTTP 400 type error.\",\"dateModified\":\"2026-11-12T10:22:01.307Z\",\"isPartOf\":{\"@id\":\"https://docs.synthpop.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.synthpop.ai/api-reference/authentication/exchange-an-api-secret-for-a-token\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Tasks\",\"item\":\"https://docs.synthpop.ai/api-reference/tasks/create-a-new-task\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a Task.\",\"item\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task#apireference\",\"headline\":\"Retrieve a Task.\",\"name\":\"Retrieve a Task.\",\"description\":\"Retrieve a task either using Synthpop's API or an external ID. Either uuid or external_id must be specified. Specifying none or both will raise a HTTP 400 type error.\",\"url\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task\",\"mainEntityOfPage\":{\"@id\":\"https://docs.synthpop.ai/api-reference/tasks/retrieve-a-task#webpage\"},\"dateModified\":\"2026-11-12T10:22:01.307Z\",\"publisher\":{\"@id\":\"https://docs.synthpop.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.synthpop.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Synthpop\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Synthpop\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tasks/retrieve-a-task.md","siteName":"Synthpop","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Exchange an API secret for a token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/get_token","href":"/api-reference/authentication/exchange-an-api-secret-for-a-token"}]},{"group":"Tasks","pages":[{"title":"Create a New Task.","description":"**Create a new Task to process input.** Upload one or more document(s) to process.\n\n* Create a new task of a given `task_type`. Additional type-specific configuration might be\n passed in via `request_spec`, if needed.\n* Optionally, a (unique) `external_id` or a `name` for the task can be specified.\n* A set of documents (files) to process (typically PDFs, text, or images, but in some cases\n audio files as well) can be specified under `uploads`.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /task/create","href":"/api-reference/tasks/create-a-new-task"},{"title":"Retrieve a Task.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task/get","href":"/api-reference/tasks/retrieve-a-task"},{"title":"Update Task Metadata.","description":"Update a task's metadata. Only set properties you wish to change and omit others.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /task/{uuid}/update","href":"/api-reference/tasks/update-task-metadata"},{"title":"Upload additional data.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /task/{uuid}/upload","href":"/api-reference/tasks/upload-additional-data"},{"title":"Get File Download Link.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task/{task_uuid}/data_item/{data_item_uuid}/get_link","href":"/api-reference/tasks/get-file-download-link"},{"title":"Add an event to the task's event log.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /task/{task_uuid}/log_event","href":"/api-reference/tasks/add-an-event-to-the-tasks-event-log"}]},{"group":"Task List","pages":[{"title":"Get a list of tasks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task/list","href":"/api-reference/task-list/get-a-list-of-tasks"}]}]}]}]},"basePath":"","title":"Retrieve a Task. - Synthpop","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}