Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.
Send Authorization: Bearer <THRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Thred API","description":"The data API for the phone. Collect structured answers from a known phone number.","colors":{"primary":"#3AA4C1","light":"#3AA4C1","dark":"#3AA4C1"},"logo":{"light":"https://mintcdn.com/pop101/o-sRhnCnjLqfHGe3/images/logo_full_dark.png?fit=max\u0026auto=format\u0026n=o-sRhnCnjLqfHGe3\u0026q=85\u0026s=acd9058a2fc6c122b1b200877b0d36dd","dark":"https://mintcdn.com/pop101/o-sRhnCnjLqfHGe3/images/logo_full_light.png?fit=max\u0026auto=format\u0026n=o-sRhnCnjLqfHGe3\u0026q=85\u0026s=0be4abc5d471e6db0953d7c9e3b887e9"},"favicon":"https://mintcdn.com/pop101/xEyEjyZgrjRp9yCI/images/icon.ico?fit=max\u0026auto=format\u0026n=xEyEjyZgrjRp9yCI\u0026q=85\u0026s=47086c9a22642a088551ba9129637e16","api":{"openapi":"api-reference/openapi.json","playground":{"display":"simple"},"examples":{"defaults":"required","languages":["curl","javascript","python"]}},"background":{"color":{"light":"#FFFFFF","dark":"#1D1D1D"}},"navbar":{"links":[{"href":"https://thred.ai","label":"Website"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.thred.ai"}},"fonts":{"family":"Instrument Sans"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pop101","hasAudioNarration":false,"actualSubdomain":"pop101","customDomains":["www.thred.dev"],"gitSource":{"type":"github","owner":"thred-ai","repo":"thred-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6ae4efc5a50e0154d4d48983"},"chroma":{"liveDeploymentHistoryId":"6ae55ed1e88570d4b4a37508","collectionId":"9be77499-6eb5-4df6-b65e-673214645ee6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae55ed1e88570d4b4a37508"},"entitlements":{},"buildId":"6ae55fc913db368f60c3eff7","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Collect API","count":5},{"language":"default","tag":"Account and utilities","count":3},{"language":"default","tag":"Get started","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--thred-surface:#ffffff;--thred-muted-surface:#f2f2f2;--thred-text:#2b333b;--thred-secondary-text:#717989;--thred-border:#dcdcdc;--thred-panel-border:#f0f0f0;--thred-hover:#f3f3f3;--thred-accent:#3aa4c1;--thred-link:#0957d0;--sidebar-width:14rem;--content-width:48rem}.dark{--thred-surface:#1d1d1d;--thred-muted-surface:#303030;--thred-text:lch(77.594 1 139.088);--thred-secondary-text:lch(67.594 1 139.088);--thred-border:#414141;--thred-panel-border:#2d2d2d;--thred-hover:#2a2a2a;--thred-link:#8ab4f8}body{font-size:14px;letter-spacing:calc(.6px - .05em);-webkit-font-smoothing:antialiased}button,input,select,textarea{font-family:inherit}#mobile-nav,#mobile-nav-content,#navbar,#navbar-transition{background:var(--thred-surface);border-color:var(--thred-panel-border)}img.nav-logo{height:28px!important;width:auto!important}#page-title,body{color:var(--thred-text)}#page-title{font-size:24px;font-weight:600;line-height:32px;letter-spacing:-.025em}#header .eyebrow,#header>div{color:var(--thred-secondary-text)}#header .eyebrow{font-size:12px;font-weight:500}#header>div{font-size:14px;line-height:24px}:is(#content, #api-playground-2-operation-page){margin-top:28px}#api-playground-2-operation-page,#content-container .prose{color:var(--thred-text);font-size:14px;line-height:24px;--tw-prose-body:var(--thred-text);--tw-prose-headings:var(--thred-text);--tw-prose-bold:var(--thred-text);--tw-prose-links:var(--thred-link);--tw-prose-counters:var(--thred-secondary-text);--tw-prose-bullets:var(--thred-secondary-text);--tw-prose-code:var(--thred-text);--tw-prose-th-borders:var(--thred-border);--tw-prose-td-borders:var(--thred-panel-border)}:is(#content, #api-playground-2-operation-page) :is(h2, h3, h4){color:var(--thred-text);font-weight:600;letter-spacing:calc(.6px - .05em)}:is(#content, #api-playground-2-operation-page) h2{font-size:18px;line-height:28px;margin-top:32px;margin-bottom:12px}:is(#content, #api-playground-2-operation-page) h3,:is(#content, #api-playground-2-operation-page) h4{font-size:14px;line-height:24px}:is(#content, #api-playground-2-operation-page) :is(p, ul, ol){margin-top:12px;margin-bottom:12px}:is(#content, #api-playground-2-operation-page) strong{color:var(--thred-text);font-weight:600}:is(#content, #api-playground-2-operation-page) a:not(.card):not([aria-label]){color:var(--thred-link);text-decoration-thickness:1px;text-underline-offset:3px}#mobile-nav-content a,#sidebar a{color:var(--thred-text);font-size:14px;font-weight:400;border-radius:6px}#mobile-nav-content a:hover,#sidebar a:hover{background:var(--thred-hover)}#mobile-nav-content .sidebar-group a[class~=\"bg-primary/10\"],#sidebar .sidebar-group a[class~=\"bg-primary/10\"]{color:var(--thred-text);background:var(--thred-muted-surface);font-weight:500;text-shadow:none}#sidebar-title{color:var(--thred-secondary-text);font-size:12px;font-weight:500}#footer,#table-of-contents,#table-of-contents a,.navbar-link{color:var(--thred-secondary-text);font-size:13px}#table-of-contents a:hover{color:var(--thred-text)}#search-bar-entry,#topbar-cta-button a{border-radius:6px;font-size:13px;box-shadow:none}#search-bar-entry{height:32px;border:1px solid var(--thred-border);background:var(--thred-surface);color:var(--thred-secondary-text);filter:none}#topbar-cta-button a{min-height:28px;padding:4px 10px;border:1px solid var(--thred-accent);background:color-mix(in srgb,var(--thred-accent) 80%,transparent);color:#2b333b;font-weight:400}#topbar-cta-button a:hover{background:color-mix(in srgb,var(--thred-accent) 60%,transparent)}#topbar-cta-button a>span{background:0 0;border-radius:inherit}#topbar-cta-button a :is(span, svg){color:inherit}.card{border:1px solid var(--thred-border);border-radius:6px;background:var(--thred-surface);box-shadow:none}.card:hover{border-color:var(--thred-border)!important;background:var(--thred-hover)}[data-component-part=card-content-container]{padding:16px}[data-component-part=card-icon]{width:20px;height:20px;color:var(--thred-accent);fill:var(--thred-accent)}:is(#content, #api-playground-2-operation-page) [data-component-part=card-title]{color:var(--thred-text);font-size:14px;line-height:24px;margin-top:12px;margin-bottom:4px}[data-component-part=card-content]{color:var(--thred-secondary-text);font-size:14px;line-height:24px}:is(#content, #api-playground-2-operation-page) table{width:100%;font-size:14px;line-height:24px}:is(#content, #api-playground-2-operation-page) td,:is(#content, #api-playground-2-operation-page) th{padding:8px 12px;border-bottom:1px solid var(--thred-panel-border)}:is(#content, #api-playground-2-operation-page) th{background:var(--thred-muted-surface);color:var(--thred-secondary-text);font-size:12px;font-weight:500}:is(#content, #api-playground-2-operation-page) .callout{border:1px solid var(--thred-border);border-radius:6px;background:var(--thred-muted-surface);color:var(--thred-text);font-size:14px;line-height:24px}:is(#content, #api-playground-2-operation-page) [data-component-part=callout-content]{color:var(--thred-text);line-height:24px}:is(#content, #api-playground-2-operation-page) [data-component-part=callout-icon] svg{color:var(--thred-secondary-text)}.code-block,.code-group{border:1px solid var(--thred-border);border-radius:8px;box-shadow:none}#content-container .code-block-background{background:var(--thred-surface)!important;border-radius:inherit}code,kbd,pre{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace;letter-spacing:0}pre,pre code{font-size:13px;line-height:24px}:is(#content, #api-playground-2-operation-page) :not(pre)>code{background:var(--thred-muted-surface);color:var(--thred-text);border-color:var(--thred-border);border-radius:4px;font-size:12px}#pagination a,.expandable,.option-dropdown{border-color:var(--thred-border);border-radius:6px}@media (min-width:1024px){#sidebar{width:var(--sidebar-width)}#sidebar-content{padding-right:12px}#content-area{padding-left:calc(var(--sidebar-width) + 6rem)}}a:focus-visible,button:focus-visible,input:focus-visible{outline:2px solid var(--thred-link);outline-offset:3px}"}],"page":{"pagePath":"api-reference/get-collection","slug":"/api-reference/get-collection","pageMetadata":{"title":"Get a collection","openapi":"api-reference/openapi.json GET /v1/collect/{id}","description":"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.","href":"/api-reference/get-collection"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\"\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":"Get a collection","openapi":"api-reference/openapi.json GET /v1/collect/{id}","description":"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.","href":"/api-reference/get-collection"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getCollection","tags":["Collect"],"summary":"Get a collection","description":"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.","responses":{"200":"d80a8751-c67c-4f29-8f89-dd69f72ecdf0","401":"d46c8830-60b1-4089-a392-201a966aceb4","404":"b223b3ee-fafe-46f0-a589-d3df3f546e98","500":"c49157f9-d86e-43e3-b358-676d6b4f6ac0","503":"bac02abc-7831-4c04-8b2d-60902e03827f"},"method":"get","type":"path","servers":["018fa0c6-8491-4098-bf8a-ea0196732702"],"security":["169d90c7-fab1-4290-a28c-41b56a1ae8f2"],"path":"/v1/collect/{id}","baseUrlOptions":["https://api.thred.dev"],"title":"Get a collection","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a5ea25fd-3c6a-4e0e-96aa-dd2fe5bab65e":{"name":"id","in":"path","required":true,"description":"The collection ID returned when the request was accepted. IDs use the call_ prefix.","schema":{"type":"string","pattern":"^call_[a-z0-9-]+$","isRequired":true,"description":"The collection ID returned when the request was accepted. IDs use the call_ prefix.","uniqueKey":"","typeLabel":"string"},"example":"call_123e4567-e89b-42d3-a456-426614174000"}},"responses":{"d80a8751-c67c-4f29-8f89-dd69f72ecdf0":{"description":"The current collection and its published results.","content":{"application/json":{"schema":{"type":"object","description":"A collection and its published results. List responses return this shape. Detail responses also include navigation_routes.","required":["navigation_routes","id","environment","status","handling","to","from","created_at","updated_at","started_at","ended_at","human_assisted","outcome","data","partial_data","missing_fields","error","duration_seconds","usage","recording_status","recording","cancellation_requested","screener_sequence","screener_sequence_source","navigation_cache_source_call_id","request"],"properties":{"id":{"type":"string","example":"call_123e4567-e89b-42d3-a456-426614174000","description":"The collection ID, using the call_ prefix.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"environment":{"type":"string","enum":["development","production"],"description":"The API key selects the workspace environment. Development and Production are isolated, but either can place real calls when enabled.","isRequired":true,"uniqueKey":"environment","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["queued","dialing","in_progress","processing","awaiting_review","completed","incomplete","failed","canceled"],"description":"Final: completed, incomplete, failed, canceled. Continue polling for all other statuses.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"handling":{"type":"string","enum":["ai","awaiting_operator","operator"],"description":"Who is handling the call: AI, waiting for an internal operator, or an internal operator.","isRequired":true,"uniqueKey":"handling","typeLabel":"enum\u003cstring>"},"to":{"type":"string","example":"+14155550123","description":"Destination in E.164 format.","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"from":{"type":"string","example":"+12025550124","description":"Outbound caller number in E.164 format.","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"UTC creation time.","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"UTC time of the latest update.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"started_at":{"oneOf":[{"type":"string","format":"date-time","description":"UTC job start time, or null before startup.","isRequired":true,"uniqueKey":"started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC job start time, or null before startup.","isRequired":true,"uniqueKey":"started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"started_at","typeLabel":"string\u003cdate-time> | null"},"ended_at":{"oneOf":[{"type":"string","format":"date-time","description":"UTC job end time, or null until closure. Results may still be processing afterward.","isRequired":true,"uniqueKey":"ended_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"UTC job end time, or null until closure. Results may still be processing afterward.","isRequired":true,"uniqueKey":"ended_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"ended_at","typeLabel":"string\u003cdate-time> | null"},"human_assisted":{"type":"boolean","description":"Whether an internal operator assisted the live call. Assisted results require approval before publication.","isRequired":true,"uniqueKey":"human_assisted","typeLabel":"boolean"},"outcome":{"oneOf":[{"type":"string","description":"Call closure reason, when known. Use status to determine whether results are final.","isRequired":true,"uniqueKey":"outcome.oneOf.0","typeLabel":"string"},{"type":"null","description":"Call closure reason, when known. Use status to determine whether results are final.","isRequired":true,"uniqueKey":"outcome.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"outcome","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Complete answers matching output, or null before publication / when no complete result exists.","isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Complete answers matching output, or null before publication / when no complete result exists.","isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data","typeLabel":"object | null"},"partial_data":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Available answers when a complete result could not be obtained. Missing required fields may be omitted, but remaining schema constraints still apply.","isRequired":true,"uniqueKey":"partial_data.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Available answers when a complete result could not be obtained. Missing required fields may be omitted, but remaining schema constraints still apply.","isRequired":true,"uniqueKey":"partial_data.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"partial_data","typeLabel":"object | null"},"missing_fields":{"type":"array","items":{"type":"string","uniqueKey":"missing_fields.items.[INDEX]","typeLabel":"string"},"description":"Validation messages for unavailable answers, including the field path. Empty for completed and canceled collections.","isRequired":true,"uniqueKey":"missing_fields","typeLabel":"string[]"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"required":["code","message"],"description":"Collection failure details. This is separate from an HTTP error response.","isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"description":"Collection failure details. This is separate from an HTTP error response.","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"},"duration_seconds":{"oneOf":[{"type":"number","description":"Elapsed job duration; not provider billable talk time.","isRequired":true,"uniqueKey":"duration_seconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Elapsed job duration; not provider billable talk time.","isRequired":true,"uniqueKey":"duration_seconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"duration_seconds","typeLabel":"number | null"},"usage":{"type":"object","properties":{"elapsed_job_seconds":{"oneOf":[{"type":"number","description":"Elapsed job duration, including setup and waiting. Not a billable duration.","isRequired":true,"uniqueKey":"usage.elapsed_job_seconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Elapsed job duration, including setup and waiting. Not a billable duration.","isRequired":true,"uniqueKey":"usage.elapsed_job_seconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"usage.elapsed_job_seconds","typeLabel":"number | null"},"billed_seconds":{"oneOf":[{"type":"number","enum":[null],"description":"Always null until provider billing reconciliation is available.","isRequired":true,"uniqueKey":"usage.billed_seconds.oneOf.0","typeLabel":"enum\u003cnumber>"},{"type":"null","enum":[null],"description":"Always null until provider billing reconciliation is available.","isRequired":true,"uniqueKey":"usage.billed_seconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"usage.billed_seconds","typeLabel":"enum\u003cnumber> | null"},"billing_status":{"type":"string","enum":["unreconciled"],"isRequired":true,"uniqueKey":"usage.billing_status","typeLabel":"enum\u003cstring>"}},"required":["elapsed_job_seconds","billed_seconds","billing_status"],"isRequired":true,"uniqueKey":"usage","typeLabel":"object"},"recording_status":{"type":"string","enum":["disabled","pending","starting","recording","processing","ready","failed"],"description":"Recording progresses independently of the call result. Hosted recording is currently disabled.","isRequired":true,"uniqueKey":"recording_status","typeLabel":"enum\u003cstring>"},"recording":{"type":"object","properties":{"status":{"type":"string","enum":["disabled","pending","starting","recording","processing","ready","failed"],"description":"Recording progresses independently of the call result. Hosted recording is currently disabled.","isRequired":true,"uniqueKey":"recording.status","typeLabel":"enum\u003cstring>"},"duration_seconds":{"oneOf":[{"type":"number","description":"Recorded audio duration, when available.","isRequired":true,"uniqueKey":"recording.duration_seconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Recorded audio duration, when available.","isRequired":true,"uniqueKey":"recording.duration_seconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recording.duration_seconds","typeLabel":"number | null"},"audio_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the recording audio clock, when available.","isRequired":true,"uniqueKey":"recording.audio_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the recording audio clock, when available.","isRequired":true,"uniqueKey":"recording.audio_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recording.audio_started_at","typeLabel":"string\u003cdate-time> | null"},"error":{"oneOf":[{"type":"string","description":"Recording failure details, if any.","isRequired":true,"uniqueKey":"recording.error.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recording failure details, if any.","isRequired":true,"uniqueKey":"recording.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"recording.error","typeLabel":"string | null"}},"required":["status","duration_seconds","audio_started_at","error"],"isRequired":true,"uniqueKey":"recording","typeLabel":"object"},"cancellation_requested":{"type":"boolean","description":"True once a cancellation request is recorded; does not by itself mean the call has ended.","isRequired":true,"uniqueKey":"cancellation_requested","typeLabel":"boolean"},"screener_sequence":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":500,"description":"Approved spoken copy; must contain non-whitespace text.","isRequired":true,"uniqueKey":"screener_sequence.oneOf.0.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","enum":["intro","detail"],"description":"The first message must be intro; all later messages must be detail.","isRequired":true,"uniqueKey":"screener_sequence.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["message","type"],"additionalProperties":false,"uniqueKey":"screener_sequence.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Prepared or supplied screener messages, or null while preparation is pending.","isRequired":true,"uniqueKey":"screener_sequence.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":500,"description":"Approved spoken copy; must contain non-whitespace text."},"type":{"type":"string","enum":["intro","detail"],"description":"The first message must be intro; all later messages must be detail."}},"required":["message","type"],"additionalProperties":false},"description":"Prepared or supplied screener messages, or null while preparation is pending.","isRequired":true,"uniqueKey":"screener_sequence.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"screener_sequence","typeLabel":"object[] | null"},"screener_sequence_source":{"oneOf":[{"type":"string","enum":["provided","generated",null],"description":"Whether screener messages were supplied or generated.","isRequired":true,"uniqueKey":"screener_sequence_source.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["provided","generated",null],"description":"Whether screener messages were supplied or generated.","isRequired":true,"uniqueKey":"screener_sequence_source.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"screener_sequence_source","typeLabel":"enum\u003cstring> | null"},"navigation_cache_source_call_id":{"oneOf":[{"type":"string","description":"Prior call whose eligible navigation steps were loaded, or null.","isRequired":true,"uniqueKey":"navigation_cache_source_call_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prior call whose eligible navigation steps were loaded, or null.","isRequired":true,"uniqueKey":"navigation_cache_source_call_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"navigation_cache_source_call_id","typeLabel":"string | null"},"request":{"type":"object","description":"The accepted request with defaults applied and text normalized. Client metadata remains available here.","required":["input","max_duration_seconds","metadata","record","to","instructions","output"],"properties":{"to":{"type":"string","pattern":"^\\+[1-9]\\d{6,14}$","example":"+14155550123","description":"Destination phone number in E.164 format.","isRequired":true,"uniqueKey":"request.to","typeLabel":"string"},"instructions":{"type":"string","minLength":1,"maxLength":8000,"description":"What you want to find out. Thred manages conversation, navigation, and assistance. Must contain non-whitespace text.","isRequired":true,"uniqueKey":"request.instructions","typeLabel":"string"},"input":{"type":"object","additionalProperties":true,"default":{},"description":"Known context values for the call, such as a date, product name, or reference number. Must be a JSON object; optional and defaults to an empty object. Up to 16,000 bytes of JSON. Maximum depth: 32; maximum values: 8,192.","example":{"date":"today"},"isRequired":true,"uniqueKey":"request.input","typeLabel":"object"},"output":{"type":"object","properties":{"properties":{"type":"object","description":"Object fields. Names must contain 1–120 characters and cannot be __proto__, prototype, or constructor.","additionalProperties":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","description":"One supported type, or an array containing one supported non-null type and null. An object schema must include properties and additionalProperties: false; an array schema must include items.","enum":["object","array","string","number","integer","boolean","null"],"isRequired":true,"uniqueKey":"request.output.properties.additionalProperties.type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"type":"string","enum":["object","array","string","number","integer","boolean","null"],"uniqueKey":"request.output.properties.additionalProperties.type.oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"One supported type, or an array containing one supported non-null type and null. An object schema must include properties and additionalProperties: false; an array schema must include items.","maxItems":2,"minItems":1,"uniqueItems":true,"isRequired":true,"uniqueKey":"request.output.properties.additionalProperties.type.oneOf.1","typeLabel":"enum\u003cstring>[]"}],"isRequired":true,"uniqueKey":"request.output.properties.additionalProperties.type","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"description":{"type":"string","maxLength":2000,"description":"Explain what the answer should contain.","uniqueKey":"request.output.properties.additionalProperties.description","typeLabel":"string"},"title":{"type":"string","maxLength":2000,"uniqueKey":"request.output.properties.additionalProperties.title","typeLabel":"string"},"properties":{"type":"object","description":"Object fields. Names must contain 1–120 characters and cannot be __proto__, prototype, or constructor.","additionalProperties":{"type":"object","additionalProperties":true,"description":"A nested schema with the same supported fields. Every node needs type; objects need properties and additionalProperties: false; arrays need items.","uniqueKey":"request.output.properties.additionalProperties.properties.additionalProperties","typeLabel":"object"},"uniqueKey":"request.output.properties.additionalProperties.properties","typeLabel":"object"},"required":{"type":"array","description":"Unique names declared in properties. Required answers that cannot be obtained prevent a completed result.","uniqueItems":true,"items":{"type":"string","uniqueKey":"request.output.properties.additionalProperties.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"request.output.properties.additionalProperties.required","typeLabel":"string[]"},"additionalProperties":{"type":"boolean","enum":[false],"description":"Required and always false for every object schema.","uniqueKey":"request.output.properties.additionalProperties.\\additionalProperties","typeLabel":"enum\u003cboolean>"},"items":{"type":"object","additionalProperties":true,"description":"The schema for each array item, using the same supported fields.","uniqueKey":"request.output.properties.additionalProperties.\\items","typeLabel":"object"},"enum":{"type":"array","minItems":1,"maxItems":100,"items":{"oneOf":[{"type":"string","uniqueKey":"request.output.properties.additionalProperties.enum.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"request.output.properties.additionalProperties.enum.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"request.output.properties.additionalProperties.enum.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"request.output.properties.additionalProperties.enum.items.[INDEX].oneOf.3","typeLabel":"boolean"}],"uniqueKey":"request.output.properties.additionalProperties.enum.items.[INDEX]","typeLabel":"string | null | number | boolean"},"description":"Primitive string, number, boolean, or null values. Each value must satisfy the declared type and bounds.","uniqueKey":"request.output.properties.additionalProperties.enum","typeLabel":"(string | null | number | boolean)[]"},"minItems":{"type":"integer","minimum":0,"maximum":10000,"uniqueKey":"request.output.properties.additionalProperties.minItems","typeLabel":"integer"},"maxItems":{"type":"integer","minimum":0,"maximum":10000,"uniqueKey":"request.output.properties.additionalProperties.maxItems","typeLabel":"integer"},"minLength":{"type":"integer","minimum":0,"maximum":10000,"uniqueKey":"request.output.properties.additionalProperties.minLength","typeLabel":"integer"},"maxLength":{"type":"integer","minimum":0,"maximum":10000,"uniqueKey":"request.output.properties.additionalProperties.maxLength","typeLabel":"integer"},"minimum":{"type":"number","uniqueKey":"request.output.properties.additionalProperties.minimum","typeLabel":"number"},"maximum":{"type":"number","uniqueKey":"request.output.properties.additionalProperties.maximum","typeLabel":"number"}},"required":["type"],"description":"Supported JSON Schema fields. Maximum 128 nodes and 8 nesting levels below the root. Keywords must match their type; minimum bounds cannot exceed maximum bounds.","additionalProperties":false,"uniqueKey":"request.output.properties.additionalProperties","typeLabel":"object"},"isRequired":true,"uniqueKey":"request.output.properties","typeLabel":"object"},"additionalProperties":{"type":"boolean","enum":[false],"description":"Required and always false for every object schema.","isRequired":true,"uniqueKey":"request.output.\\additionalProperties","typeLabel":"enum\u003cboolean>"},"type":{"type":"string","enum":["object"],"description":"Optional. The output root is always an object; omit this field when creating a collection.","default":"object","uniqueKey":"request.output.type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":2000,"description":"Explain what the answer should contain.","uniqueKey":"request.output.description","typeLabel":"string"},"title":{"type":"string","maxLength":2000,"uniqueKey":"request.output.title","typeLabel":"string"},"required":{"type":"array","description":"Unique names declared in properties. Required answers that cannot be obtained prevent a completed result.","uniqueItems":true,"items":{"type":"string","uniqueKey":"request.output.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"request.output.required","typeLabel":"string[]"}},"required":["properties","additionalProperties"],"description":"The JSON Schema defining the answers returned in data. The output root is always an object, so no top-level type is needed. Define properties and required fields, and set additionalProperties to false.","additionalProperties":false,"example":{"properties":{"is_open":{"type":"boolean"},"closes_at":{"type":"string"}},"required":["is_open","closes_at"],"additionalProperties":false},"isRequired":true,"uniqueKey":"request.output","typeLabel":"object"},"max_duration_seconds":{"type":"integer","default":300,"minimum":30,"maximum":1800,"description":"Maximum job duration. Your workspace and environment may have a lower limit.","isRequired":true,"uniqueKey":"request.max_duration_seconds","typeLabel":"integer"},"metadata":{"type":"object","additionalProperties":true,"default":{},"description":"Your tracking fields, up to 4,000 bytes of JSON. Maximum depth: 32; maximum values: 8,192.","isRequired":true,"uniqueKey":"request.metadata","typeLabel":"object"},"record":{"type":"boolean","default":false,"description":"Recording is currently disabled. Leave false or omit; true returns 503.","isRequired":true,"uniqueKey":"request.record","typeLabel":"boolean"},"caller_number_id":{"type":"string","minLength":1,"maxLength":160,"description":"Enabled caller number ID belonging to the same workspace and environment. Omit to use the environment default.","uniqueKey":"request.caller_number_id","typeLabel":"string"},"webhook_id":{"type":"string","minLength":1,"maxLength":160,"description":"Enabled webhook endpoint ID from your dashboard, in the same workspace and environment. Omit to poll for results.","uniqueKey":"request.webhook_id","typeLabel":"string"},"navigation":{"type":"object","properties":{"contact_name":{"type":"string","minLength":1,"maxLength":160,"description":"Person to ask for.","uniqueKey":"request.navigation.contact_name","typeLabel":"string"},"department":{"type":"string","minLength":1,"maxLength":160,"description":"Department to reach.","uniqueKey":"request.navigation.department","typeLabel":"string"},"extension":{"type":"string","minLength":1,"maxLength":16,"pattern":"^[0-9]+$","description":"Extension hint, used when an appropriate extension-entry prompt is heard.","uniqueKey":"request.navigation.extension","typeLabel":"string"},"language":{"type":"string","minLength":1,"maxLength":160,"pattern":"^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8}){0,3}$","example":"en","description":"Language tag, such as en or fr-CA.","uniqueKey":"request.navigation.language","typeLabel":"string"}},"description":"Optional routing hints. IVR navigation is automatic. Custom routes, actions, and navigation policy overrides are not accepted.","additionalProperties":false,"uniqueKey":"request.navigation","typeLabel":"object"},"screener_sequence":{"type":"array","minItems":1,"maxItems":8,"items":{"type":"object","properties":{"message":{"type":"string","minLength":1,"maxLength":500,"description":"Approved spoken copy; must contain non-whitespace text.","isRequired":true,"uniqueKey":"request.screener_sequence.items.[INDEX].message","typeLabel":"string"},"type":{"type":"string","enum":["intro","detail"],"description":"The first message must be intro; all later messages must be detail.","isRequired":true,"uniqueKey":"request.screener_sequence.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["message","type"],"additionalProperties":false,"uniqueKey":"request.screener_sequence.items.[INDEX]","typeLabel":"object"},"description":"An intro followed by optional detail messages for screeners. If omitted, Thred prepares a sequence from the task and input before dialing.","uniqueKey":"request.screener_sequence","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"request","typeLabel":"object"},"navigation_routes":{"type":"array","maxItems":16,"items":{"type":"object","properties":{"navigation_id":{"type":"string","description":"Navigation episode identifier.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].navigation_id","typeLabel":"string"},"status":{"type":"string","description":"Navigation episode status.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].status","typeLabel":"string"},"result":{"oneOf":[{"type":"string","description":"Navigation outcome, when known.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].result.oneOf.0","typeLabel":"string"},{"type":"null","description":"Navigation outcome, when known.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].result","typeLabel":"string | null"},"reusable":{"type":"boolean","description":"Whether successful steps are eligible for automatic reuse on a matching future call.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].reusable","typeLabel":"boolean"},"steps":{"type":"array","items":{"type":"object","properties":{"menu":{"type":"string","description":"Observed menu text.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].menu","typeLabel":"string"},"action":{"oneOf":[{"type":"object","required":["kind","digits"],"properties":{"kind":{"type":"string","enum":["press-digits"],"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"digits":{"type":"string","description":"Digits sent to the phone menu.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.0.digits","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","text"],"properties":{"kind":{"type":"string","enum":["speak"],"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.1.kind","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Spoken menu response.","isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.1.text","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].action","typeLabel":"object"},"status":{"type":"string","enum":["authorized","executing","sent","failed","uncertain","canceled"],"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["menu","action","status"],"uniqueKey":"navigation_routes.items.[INDEX].steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"navigation_routes.items.[INDEX].steps","typeLabel":"object[]"}},"required":["navigation_id","status","result","reusable","steps"],"uniqueKey":"navigation_routes.items.[INDEX]","typeLabel":"object"},"description":"Observed IVR navigation routes for this call.","isRequired":true,"uniqueKey":"navigation_routes","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"call_123e4567-e89b-42d3-a456-426614174000","environment":"development","status":"completed","handling":"ai","to":"+14155550123","from":"+12025550124","created_at":"2026-10-30T14:00:00.000Z","updated_at":"2026-10-30T14:01:20.000Z","started_at":"2026-10-30T14:00:02.000Z","ended_at":"2026-10-30T14:01:12.000Z","human_assisted":false,"outcome":"data-completed","data":{"is_open":true,"closes_at":"5 PM"},"partial_data":null,"missing_fields":[],"error":null,"duration_seconds":70,"usage":{"elapsed_job_seconds":70,"billed_seconds":null,"billing_status":"unreconciled"},"recording_status":"disabled","recording":{"status":"disabled","duration_seconds":null,"audio_started_at":null,"error":null},"cancellation_requested":false,"screener_sequence":[{"message":"Hello, I am calling to confirm today’s business hours.","type":"intro"}],"screener_sequence_source":"generated","navigation_cache_source_call_id":null,"request":{"to":"+14155550123","instructions":"Ask whether the business is open on the date in input and what time it closes.","input":{"date":"today"},"output":{"type":"object","properties":{"is_open":{"type":"boolean"},"closes_at":{"type":["string","null"]}},"required":["is_open","closes_at"],"additionalProperties":false},"max_duration_seconds":300,"metadata":{},"record":false},"navigation_routes":[]},"examples":{"Example":{"title":"Example","value":{"id":"call_123e4567-e89b-42d3-a456-426614174000","environment":"development","status":"completed","handling":"ai","to":"+14155550123","from":"+12025550124","created_at":"2026-10-30T14:00:00.000Z","updated_at":"2026-10-30T14:01:20.000Z","started_at":"2026-10-30T14:00:02.000Z","ended_at":"2026-10-30T14:01:12.000Z","human_assisted":false,"outcome":"data-completed","data":{"is_open":true,"closes_at":"5 PM"},"partial_data":null,"missing_fields":[],"error":null,"duration_seconds":70,"usage":{"elapsed_job_seconds":70,"billed_seconds":null,"billing_status":"unreconciled"},"recording_status":"disabled","recording":{"status":"disabled","duration_seconds":null,"audio_started_at":null,"error":null},"cancellation_requested":false,"screener_sequence":[{"message":"Hello, I am calling to confirm today’s business hours.","type":"intro"}],"screener_sequence_source":"generated","navigation_cache_source_call_id":null,"request":{"to":"+14155550123","instructions":"Ask whether the business is open on the date in input and what time it closes.","input":{"date":"today"},"output":{"type":"object","properties":{"is_open":{"type":"boolean"},"closes_at":{"type":["string","null"]}},"required":["is_open","closes_at"],"additionalProperties":false},"max_duration_seconds":300,"metadata":{},"record":false},"navigation_routes":[]}}},"exampleType":"examples"}},"exampleType":"examples"},"d46c8830-60b1-4089-a392-201a966aceb4":{"description":"Missing, malformed, invalid, revoked, or environment-mismatched bearer API key.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b223b3ee-fafe-46f0-a589-d3df3f546e98":{"description":"No matching collection in this key’s workspace and environment, or the endpoint does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c49157f9-d86e-43e3-b358-676d6b4f6ac0":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"bac02abc-7831-4c04-8b2d-60902e03827f":{"description":"Calling or the backend is unavailable. Codes include calling_unavailable, environment_unavailable, not_configured, and backend_unavailable.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"169d90c7-fab1-4290-a28c-41b56a1ae8f2":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Thred API key","description":"Send Authorization: Bearer \u003cTHRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"018fa0c6-8491-4098-bf8a-ea0196732702":{"url":"https://api.thred.dev","description":"Thred API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Thred API key","description":"Send Authorization: Bearer \u003cTHRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Send Authorization: Bearer \u003cTHRED_API_KEY>. Development keys begin thr_dev_; Production keys begin thr_prod_. Each key is scoped to a workspace and environment. Keep secrets on your server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"pop101","siteName":"Thred API","title":"Get a collection - Thred API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T19:40:36.460Z","originalFileLocation":"api-reference/get-collection.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=\"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Thred API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_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/pop101/j0nmZA184tfqmqT0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a collection - Thred API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Thred API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.thred.dev/api-reference/get-collection\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pop101.mintlify.app/_mintlify/api/og/v2?division=Collect+API\u0026amp;title=Get+a+collection\u0026amp;description=Get+the+latest+collection+status+and+results.+Keep+polling+until+status+is+completed%2C+incomplete%2C+failed%2C+or+canceled.+Read+completed+answers+from+data+and+inco\u0026amp;theme=d17339659d3ab7261c0da2d6\u0026amp;signature=297413c40b9cc38b5638129c3a8be0ae7440f055f304abfc20157f5b9b28509b\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a collection - Thred API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pop101.mintlify.app/_mintlify/api/og/v2?division=Collect+API\u0026amp;title=Get+a+collection\u0026amp;description=Get+the+latest+collection+status+and+results.+Keep+polling+until+status+is+completed%2C+incomplete%2C+failed%2C+or+canceled.+Read+completed+answers+from+data+and+inco\u0026amp;theme=d17339659d3ab7261c0da2d6\u0026amp;signature=297413c40b9cc38b5638129c3a8be0ae7440f055f304abfc20157f5b9b28509b\">\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/pop101/j0nmZA184tfqmqT0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Thred API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3AA4C1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.thred.dev/api-reference/get-collection\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-collection.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.thred.dev/#organization\",\"name\":\"Thred API\",\"url\":\"https://www.thred.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pop101/o-sRhnCnjLqfHGe3/images/logo_full_dark.png?fit=max\u0026auto=format\u0026n=o-sRhnCnjLqfHGe3\u0026q=85\u0026s=acd9058a2fc6c122b1b200877b0d36dd\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.thred.dev#website\",\"name\":\"Thred API\",\"url\":\"https://www.thred.dev\",\"publisher\":{\"@id\":\"https://www.thred.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.thred.dev/api-reference/get-collection#webpage\",\"url\":\"https://www.thred.dev/api-reference/get-collection\",\"name\":\"Get a collection\",\"description\":\"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\",\"dateModified\":\"2026-10-30T19:40:36.460Z\",\"isPartOf\":{\"@id\":\"https://www.thred.dev#website\"},\"breadcrumb\":{\"@id\":\"https://www.thred.dev/api-reference/get-collection#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.thred.dev/api-reference/get-collection#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Collect API\",\"item\":\"https://www.thred.dev/api-reference/create-collection\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get a collection\",\"item\":\"https://www.thred.dev/api-reference/get-collection\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.thred.dev/api-reference/get-collection#apireference\",\"headline\":\"Get a collection\",\"name\":\"Get a collection\",\"description\":\"Get the latest collection status and results. Keep polling until status is completed, incomplete, failed, or canceled. Read completed answers from data and incomplete answers from partial_data.\",\"url\":\"https://www.thred.dev/api-reference/get-collection\",\"mainEntityOfPage\":{\"@id\":\"https://www.thred.dev/api-reference/get-collection#webpage\"},\"dateModified\":\"2026-10-30T19:40:36.460Z\",\"publisher\":{\"@id\":\"https://www.thred.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://www.thred.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Thred API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Thred API","nav":{"global":null,"groups":[{"group":"Get started","pages":[{"title":"Thred API","icon":"phone","href":"/introduction"},{"title":"Quickstart","icon":"bolt","href":"/quickstart"},{"title":"What you can build","href":"/guides/what-you-can-build"}]},{"group":"Collect API","pages":[{"title":"Create a collection","openapi":"api-reference/openapi.json POST /v1/collect","description":"Collect answers from a known phone number. Send instructions, optional context values in input, and a JSON Schema in output. Use the returned ID to retrieve the result, or provide a webhook_id. Development and Production can both place real calls.","href":"/api-reference/create-collection"},{"title":"Get a collection","openapi":"api-reference/openapi.json GET /v1/collect/{id}","href":"/api-reference/get-collection"},{"title":"List collections","openapi":"api-reference/openapi.json GET /v1/collect","description":"List collections in your workspace and API environment, newest first. Pass next_cursor as cursor to get the next page.","href":"/api-reference/list-collections"},{"title":"Cancel a collection","openapi":"api-reference/openapi.json POST /v1/collect/{id}/cancel","href":"/api-reference/cancel-collection"},{"title":"Get a recording","openapi":"api-reference/openapi.json GET /v1/collect/{id}/recording","href":"/api-reference/get-recording"}]},{"group":"Account and utilities","pages":[{"title":"Check your API key","openapi":"api-reference/openapi.json GET /v1/auth/me","href":"/api-reference/authentication"},{"title":"Get usage","openapi":"api-reference/openapi.json GET /v1/usage","href":"/api-reference/get-usage"},{"title":"Check API health","openapi":"api-reference/openapi.json GET /v1/health","href":"/api-reference/health"}]}]},"basePath":"","title":"Get a collection - Thred API","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}