URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.
Which provider fetches and cleans the pages. auto (default) picks the first configured provider in Helve's priority order. Brave and Perplexity have no extraction product.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Helve","description":"One key, one request shape, one bill for web search, page extraction, and transcription across every provider.","colors":{"primary":"#14655a","light":"#37a08f","dark":"#14655a"},"logo":{"light":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/light.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=eb97b007a2ec2b7125f02ee2cc65b8d8","dark":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/dark.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=8b290a25b599307eeebdfb7fb4a04786","href":"https://helve.dev"},"favicon":"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/favicon.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=51062c58010b78bf395309f9beb81339","appearance":{"default":"system"},"navbar":{"links":[{"href":"https://helve.dev","label":"Dashboard"}],"primary":{"type":"button","label":"Get an API key","href":"https://helve.dev"}},"footer":{"socials":{"github":"https://github.com/youssefarizk/tool-marketplace"},"links":[{"header":"Helve","items":[{"label":"Dashboard","href":"https://helve.dev"},{"label":"Terms","href":"https://helve.dev/terms"},{"label":"Privacy","href":"https://helve.dev/privacy"}]}]},"fonts":{"heading":{"family":"Archivo","weight":700}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"helve","hasAudioNarration":false,"actualSubdomain":"helve","customDomains":["docs.helve.dev"],"gitSource":{"type":"github","owner":"youssefarizk","repo":"tool-marketplace","deployBranch":"staging","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aabaa10096eb2d1ccbcd211","collectionId":"4119f034-be56-40c8-b787-c98a041ecd8f","liveDeploymentHistoryId":"6aabaa10096eb2d1ccbcd211","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aabaa10096eb2d1ccbcd211","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Guides","count":12},{"language":"default","tag":"Concepts","count":5},{"language":"default","tag":"API reference","count":4},{"language":"default","tag":"Get started","count":3},{"language":"default","tag":"Tools","count":3},{"language":"default","tag":"Transcription","count":2},{"language":"default","tag":"Extract","count":1},{"language":"default","tag":"Search","count":1},{"language":"default","tag":"Integrations","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/extract","slug":"/api-reference/extract","pageMetadata":{"title":"Extract page content","openapi":"openapi.json POST /v1/extract","description":"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a `query`. URLs the provider cannot fetch are listed in `failed` rather than failing the whole request.","href":"/api-reference/extract"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a \", _jsx(_components.code, {\n children: \"query\"\n }), \". URLs the provider cannot fetch are listed in \", _jsx(_components.code, {\n children: \"failed\"\n }), \" rather than failing the whole request.\"]\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":"Extract page content","openapi":"openapi.json POST /v1/extract","description":"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a `query`. URLs the provider cannot fetch are listed in `failed` rather than failing the whole request.","href":"/api-reference/extract"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"extract","tags":["Extract"],"summary":"Extract page content","description":"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a `query`. URLs the provider cannot fetch are listed in `failed` rather than failing the whole request.","security":["9c400962-94c4-4e9f-8c2e-32ab6d6e9e6c"],"requestBody":"dbedfb7d-5ed7-41fa-bee5-5470fab229d6","responses":{"200":"596ca2ad-a73c-4cbd-aa62-6128f4ee4971","400":"82b7bd16-90da-4315-ae59-b6b25bb15781","401":"926652b4-c619-4823-b8fd-13331682d96b","402":"6a08dfc7-3a63-46ce-ba81-ce0722901bb9","502":"9da2fdb3-c19d-4072-9fc7-ca092cc65ddc","503":"8a362a0b-528b-4a8a-a7ae-375369b490dc"},"method":"post","type":"path","servers":["336702ba-c08f-4f5b-b5c5-aca0fb2290c6"],"path":"/v1/extract","baseUrlOptions":["https://helve.dev"],"title":"Extract page content","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"example":{"urls":["https://arxiv.org/abs/2211.17192"],"query":"how does speculative decoding work","content":{"excerpts":{"max_per_url":3}}},"schema":{"type":"object","properties":{"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"urls.items.[INDEX]","typeLabel":"string\u003curi>"},"minItems":1,"maxItems":20,"description":"The pages to extract, 1–20 absolute URLs. Providers that take one URL per call are fanned out by Helve.","isRequired":true,"uniqueKey":"urls","typeLabel":"string\u003curi>[]"},"provider":{"type":"string","enum":["exa","tavily","parallel","serper","firecrawl","linkup","valyu","jina","octen","auto"],"description":"Which provider fetches and cleans the pages. `auto` (default) picks the first configured provider in Helve's priority order. Brave and Perplexity have no extraction product.","uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"query":{"type":"string","minLength":1,"description":"What you are extracting for. Drives focused excerpts and summaries on providers that support them (Exa, Tavily, Parallel, Firecrawl, Valyu).","uniqueKey":"query","typeLabel":"string"},"content":{"type":"object","properties":{"full_text":{"type":"boolean","description":"Return the whole page in `content`. Default true.","uniqueKey":"content.full_text","typeLabel":"boolean"},"max_chars":{"type":"integer","minimum":100,"maximum":100000,"description":"Cap on `content` length per URL. Native on Exa; Helve truncates for other providers.","uniqueKey":"content.max_chars","typeLabel":"integer"},"excerpts":{"type":"object","properties":{"max_per_url":{"type":"integer","minimum":1,"maximum":20,"description":"Cap on the number of excerpts per URL.","uniqueKey":"content.excerpts.max_per_url","typeLabel":"integer"},"max_chars_per_excerpt":{"type":"integer","minimum":1,"description":"Cap on the length of each excerpt, in characters.","uniqueKey":"content.excerpts.max_chars_per_excerpt","typeLabel":"integer"}},"additionalProperties":false,"description":"Return focused excerpts in `excerpts`, instead of or alongside the full text. Most useful with `query`.","uniqueKey":"content.excerpts","typeLabel":"object"},"summary":{"type":"boolean","description":"Return a per-URL summary in `summary`. Native on Exa and Valyu.","uniqueKey":"content.summary","typeLabel":"boolean"},"format":{"type":"string","enum":["markdown","text"],"description":"Output format for `content`. Native on Tavily and Serper; most providers return markdown regardless.","uniqueKey":"content.format","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"description":"What to return for each URL.","uniqueKey":"content","typeLabel":"object"},"include_links":{"type":"boolean","description":"Return the page's outbound links in `links`. Native on Exa.","uniqueKey":"include_links","typeLabel":"boolean"},"include_images":{"type":"boolean","description":"Return the page's image URLs in `images`. Native on Exa and Tavily.","uniqueKey":"include_images","typeLabel":"boolean"},"max_age_hours":{"type":"integer","minimum":0,"maximum":720,"description":"Accept a cached copy up to this many hours old; 0 forces a live fetch. Native on Exa.","uniqueKey":"max_age_hours","typeLabel":"integer"},"timeout_ms":{"type":"integer","minimum":1000,"maximum":90000,"description":"Per-page fetch timeout in milliseconds, 1000–90000. Native on Exa and Tavily.","uniqueKey":"timeout_ms","typeLabel":"integer"},"strict":{"type":"boolean","description":"When true, any parameter the serving provider cannot honour is a 400 instead of a warning. Default false.","uniqueKey":"strict","typeLabel":"boolean"},"provider_options":{"type":"object","properties":{"exa":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.exa.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.exa.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Exa when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.exa","typeLabel":"object"},"parallel":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.parallel.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.parallel.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Parallel when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.parallel","typeLabel":"object"},"tavily":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.tavily.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.tavily.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Tavily when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.tavily","typeLabel":"object"},"brave":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.brave.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.brave.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Brave when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.brave","typeLabel":"object"},"serper":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.serper.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.serper.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Serper when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.serper","typeLabel":"object"},"firecrawl":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.firecrawl.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.firecrawl.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Firecrawl when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.firecrawl","typeLabel":"object"},"linkup":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.linkup.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.linkup.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Linkup when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.linkup","typeLabel":"object"},"octen":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.octen.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.octen.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Octen when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.octen","typeLabel":"object"},"valyu":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.valyu.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.valyu.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Valyu when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.valyu","typeLabel":"object"},"jina":{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"provider_options.jina.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_options.jina.additionalProperties","typeLabel":"null"},"description":"Passed verbatim to Jina when it serves the request; ignored by every other provider.","uniqueKey":"provider_options.jina","typeLabel":"object"}},"additionalProperties":false,"description":"Escape hatch for provider-native parameters, keyed by provider id and merged into that provider's request unchanged.","uniqueKey":"provider_options","typeLabel":"object"}},"required":["urls"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"urls":["https://arxiv.org/abs/2211.17192"],"query":"how does speculative decoding work","content":{"excerpts":{"max_per_url":3}}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"596ca2ad-a73c-4cbd-aa62-6128f4ee4971":{"description":"Extracted content","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Helve's id for this extraction, `ext_…`.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"provider":{"type":"string","enum":["exa","tavily","parallel","serper","firecrawl","linkup","valyu","jina","octen"],"description":"The provider that served the request, resolved from `auto`.","isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"results":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The URL as requested.","isRequired":true,"uniqueKey":"results.items.[INDEX].url","typeLabel":"string"},"final_url":{"type":"string","description":"The URL after redirects, when the provider reports it.","uniqueKey":"results.items.[INDEX].final_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"results.items.[INDEX].title","typeLabel":"string"},"content":{"type":"string","description":"The full extracted page, in markdown or text per `content.format`.","uniqueKey":"results.items.[INDEX].content","typeLabel":"string"},"excerpts":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].excerpts.items.[INDEX]","typeLabel":"string"},"description":"Focused excerpts, when requested.","uniqueKey":"results.items.[INDEX].excerpts","typeLabel":"string[]"},"summary":{"type":"string","description":"Per-URL summary, when requested and supported.","uniqueKey":"results.items.[INDEX].summary","typeLabel":"string"},"published_date":{"type":"string","description":"ISO 8601 date when known.","uniqueKey":"results.items.[INDEX].published_date","typeLabel":"string"},"author":{"type":"string","uniqueKey":"results.items.[INDEX].author","typeLabel":"string"},"links":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].links.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].links","typeLabel":"string[]"},"images":{"type":"array","items":{"type":"string","uniqueKey":"results.items.[INDEX].images.items.[INDEX]","typeLabel":"string"},"uniqueKey":"results.items.[INDEX].images","typeLabel":"string[]"},"raw":{"oneOf":[{"description":"The provider's original result object, verbatim. Always present.","uniqueKey":"results.items.[INDEX].raw.oneOf.0","typeLabel":"any"},{"description":"The provider's original result object, verbatim. Always present.","type":"null","uniqueKey":"results.items.[INDEX].raw.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].raw","typeLabel":"any | null"}},"required":["url"],"additionalProperties":false,"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"description":"One entry per successfully extracted URL.","isRequired":true,"uniqueKey":"results","typeLabel":"object[]"},"failed":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","isRequired":true,"uniqueKey":"failed.items.[INDEX].url","typeLabel":"string"},"error":{"type":"string","isRequired":true,"uniqueKey":"failed.items.[INDEX].error","typeLabel":"string"}},"required":["url","error"],"additionalProperties":false,"uniqueKey":"failed.items.[INDEX]","typeLabel":"object"},"description":"URLs the provider could not fetch, with its reason. Partial success is a 200.","isRequired":true,"uniqueKey":"failed","typeLabel":"object[]"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["param_ignored","param_approximated","results_post_filtered"],"isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"},"param":{"type":"string","description":"The request field the warning concerns.","uniqueKey":"warnings.items.[INDEX].param","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"description":"How the request was adjusted for the serving provider. Empty when it was honoured exactly.","isRequired":true,"uniqueKey":"warnings","typeLabel":"object[]"},"usage":{"type":"object","properties":{"cost_usd":{"type":"number","description":"What this request debited from your balance: the provider's raw price.","isRequired":true,"uniqueKey":"usage.cost_usd","typeLabel":"number"},"credits":{"type":"number","isRequired":true,"uniqueKey":"usage.credits","typeLabel":"number"}},"required":["cost_usd","credits"],"additionalProperties":false,"isRequired":true,"uniqueKey":"usage","typeLabel":"object"},"latency_ms":{"type":"number","description":"Wall-clock time Helve spent on the request.","isRequired":true,"uniqueKey":"latency_ms","typeLabel":"number"}},"required":["id","provider","results","failed","warnings","usage","latency_ms"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","provider":"exa","results":[{"url":"\u003cstring>","final_url":"\u003cstring>","title":"\u003cstring>","content":"\u003cstring>","excerpts":["\u003cstring>"],"summary":"\u003cstring>","published_date":"\u003cstring>","author":"\u003cstring>","links":["\u003cstring>"],"images":["\u003cstring>"],"raw":"\u003cunknown>"}],"failed":[{"url":"\u003cstring>","error":"\u003cstring>"}],"warnings":[{"code":"param_ignored","message":"\u003cstring>","param":"\u003cstring>"}],"usage":{"cost_usd":123,"credits":123},"latency_ms":123}}},"exampleType":"generated"}},"exampleType":"generated"},"82b7bd16-90da-4315-ae59-b6b25bb15781":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"926652b4-c619-4823-b8fd-13331682d96b":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"6a08dfc7-3a63-46ce-ba81-ce0722901bb9":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"9da2fdb3-c19d-4072-9fc7-ca092cc65ddc":{"description":"Provider error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8a362a0b-528b-4a8a-a7ae-375369b490dc":{"description":"Provider not configured","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["unauthorized","invalid_request","provider_not_available","provider_not_configured","provider_error","not_found","insufficient_credits","internal_error"],"description":"Stable machine-readable category. `invalid_request` carries validation issues in `detail`; `provider_error` carries the provider's own error body.","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"detail":{"oneOf":[{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","uniqueKey":"error.detail.oneOf.0","typeLabel":"any"},{"description":"Validation issues for `invalid_request`; the provider's error body for `provider_error`.","type":"null","uniqueKey":"error.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.detail","typeLabel":"any | null"}},"required":["type","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"unauthorized","message":"\u003cstring>","detail":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9c400962-94c4-4e9f-8c2e-32ab6d6e9e6c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","scopes":[]}}},"servers":{"336702ba-c08f-4f5b-b5c5-aca0fb2290c6":{"url":"https://helve.dev","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from the dashboard, `sk_live_…`, sent as `Authorization: Bearer sk_live_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"helve","siteName":"Helve","title":"Extract page content - Helve","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T12:08:44.767Z","originalFileLocation":"api-reference/extract.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=\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Helve\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Extract page content - Helve\">\u003cmeta data-mint-head property=\"og:description\" content=\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Helve\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.helve.dev/api-reference/extract\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://helve.mintlify.app/_mintlify/api/og/v2?division=Extract\u0026amp;title=Extract+page+content\u0026amp;description=URLs+in%2C+clean+content+out.+Returns+the+full+page+as+markdown+or+text%2C+and+optionally+focused+excerpts+and+a+summary+when+you+pass+a+%60query%60.+URLs+the+provider+\u0026amp;theme=0f571ea141e669259272653e\u0026amp;signature=21f93282312a8c1dfbae41a2a5b14971cd3ebcd61e627b7e710389a988e3d826\">\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=\"Extract page content - Helve\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://helve.mintlify.app/_mintlify/api/og/v2?division=Extract\u0026amp;title=Extract+page+content\u0026amp;description=URLs+in%2C+clean+content+out.+Returns+the+full+page+as+markdown+or+text%2C+and+optionally+focused+excerpts+and+a+summary+when+you+pass+a+%60query%60.+URLs+the+provider+\u0026amp;theme=0f571ea141e669259272653e\u0026amp;signature=21f93282312a8c1dfbae41a2a5b14971cd3ebcd61e627b7e710389a988e3d826\">\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/helve/Mj0uqQ8YCWh4A1Yd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Helve\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#14655a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.helve.dev/api-reference/extract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/extract.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.helve.dev/#organization\",\"name\":\"Helve\",\"url\":\"https://docs.helve.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/helve/bd3M8ys9egZ2jyd-/logo/light.svg?fit=max\u0026auto=format\u0026n=bd3M8ys9egZ2jyd-\u0026q=85\u0026s=eb97b007a2ec2b7125f02ee2cc65b8d8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.helve.dev#website\",\"name\":\"Helve\",\"url\":\"https://docs.helve.dev\",\"publisher\":{\"@id\":\"https://docs.helve.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.helve.dev/api-reference/extract#webpage\",\"url\":\"https://docs.helve.dev/api-reference/extract\",\"name\":\"Extract page content\",\"description\":\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.\",\"dateModified\":\"2026-09-16T12:08:44.767Z\",\"isPartOf\":{\"@id\":\"https://docs.helve.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.helve.dev/api-reference/extract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.helve.dev/api-reference/extract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Helve\",\"item\":\"https://docs.helve.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Extract page content\",\"item\":\"https://docs.helve.dev/api-reference/extract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.helve.dev/api-reference/extract#apireference\",\"headline\":\"Extract page content\",\"name\":\"Extract page content\",\"description\":\"URLs in, clean content out. Returns the full page as markdown or text, and optionally focused excerpts and a summary when you pass a query. URLs the provider cannot fetch are listed in failed rather than failing the whole request.\",\"url\":\"https://docs.helve.dev/api-reference/extract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.helve.dev/api-reference/extract#webpage\"},\"dateModified\":\"2026-09-16T12:08:44.767Z\",\"publisher\":{\"@id\":\"https://docs.helve.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.helve.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Helve\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Helve","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Search","pages":[{"title":"Search the web","openapi":"openapi.json POST /v1/search","description":"One request shape across every search engine Helve fronts. Pick an engine with `provider`, leave it on `auto`, or set `fusion` to merge a panel's top picks. Parameters the serving engine cannot express are approximated or dropped and reported in `warnings`; set `strict` to make that an error instead. The response always includes what the request cost.","href":"/api-reference/search"}]},{"group":"Extract","pages":[{"title":"Extract page content","openapi":"openapi.json POST /v1/extract","href":"/api-reference/extract"}]},{"group":"Transcription","pages":[{"title":"Transcribe a recording","openapi":"openapi.json POST /v1/transcriptions","description":"Submits a prerecorded file by URL and returns a job immediately. Helve records the attempt before contacting the provider, retries rate limits, never re-sends an uncertain submission, and fails the job at its deadline rather than leaving it hanging. Poll `GET /v1/jobs/{id}` for the transcript.","href":"/api-reference/create-transcription"},{"title":"Get a job","openapi":"openapi.json GET /v1/jobs/{id}","href":"/api-reference/get-job"}]}]}]},"title":"Extract page content - Helve","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}