{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Nimble Docs","colors":{"primary":"#edc602","light":"#edc602","dark":"#edc602"},"logo":{"light":"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/light.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=4f01d3ff0f6702dfa400db4d8d46d71a","dark":"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/dark.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=884461c581a8cd728bd01f0887180dc4","href":"https://www.nimbleway.com"},"favicon":"https://mintcdn.com/nimble-f5a8283f/p44s6zCqqsFm92lY/images/favicon.png?fit=max\u0026auto=format\u0026n=p44s6zCqqsFm92lY\u0026q=85\u0026s=2c068e67e4853cc4e392c1f9e65d8766","api":{"playground":{"display":"interactive","proxy":true}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://portal.usepylon.com/nimble","label":"Support"},{"href":"https://nimbleway.com/contact-general/","label":"Book a Demo"}],"primary":{"type":"button","label":"Ask Nimble","href":"https://online.nimbleway.com/workflow-builder"}},"footer":{"socials":{"website":"https://www.nimbleway.com/","linkedin":"https://www.linkedin.com/company/nimbledata","x":"https://x.com/nimble_search"}},"seo":{"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"system","latex":true},"integrations":{"posthog":{"apiKey":"phc_WSssX85HFXGf9WkKvKgjHR80zijmy5KLO3HdyiSMY3S","apiHost":"https://x.nimbleway.com","sessionRecording":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","add-mcp","cursor","vscode"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Ask Nimble","icon":"wand-magic-sparkles","color":{"light":"#edc602","dark":"#edc602"},"href":"https://online.nimbleway.com/workflow-builder"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"nimble-f5a8283f","hasAudioNarration":false,"actualSubdomain":"nimble-f5a8283f","customDomains":["docs.nimbleway.com"],"gitSource":{"type":"github","owner":"nimbleway","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1cb6e83326b7b15e9318d","collectionId":"dd486f83-e1be-4db1-93ae-201e54692a01","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1cb6e83326b7b15e9318d"},"feedback":{"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1cb6e83326b7b15e9318d","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Integrations","count":72},{"language":"default","tag":"Documentation","count":64},{"language":"default","tag":"API Reference","count":60},{"language":"default","tag":"Proxy","count":22},{"language":"default","tag":"Connectors","count":16},{"language":"default","tag":"Agent","count":16},{"language":"default","tag":"Extraction Tools","count":16},{"language":"default","tag":"Partnerships","count":13},{"language":"default","tag":"Jobs API","count":13},{"language":"default","tag":"Agents API","count":13}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"[email protected]","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":false},"customCss":[],"page":{"pagePath":"api-reference/extract-templates-api/run-extract-template","slug":"/api-reference/extract-templates-api/run-extract-template","pageMetadata":{"title":"Run Extract Template","description":"Execute Extract Template Realtime Endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/run","href":"/api-reference/extract-templates-api/run-extract-template","autogeneratedByOpenApi":true},"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: \"Execute Extract Template Realtime Endpoint\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Run Extract Template","description":"Execute Extract Template Realtime Endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/run","href":"/api-reference/extract-templates-api/run-extract-template","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Execute Extract Template Realtime Endpoint","requestBody":"10cd9a79-af87-4d99-9f8d-19a993d58c08","responses":{"200":"eacf84e5-c0ab-457c-a32b-09a4da6e44b3","404":"4ef953a9-fafc-4f9a-9bea-2e4a040d4205"},"security":["20f23fbe-5c92-4c39-8ddb-8d7e229d2510"],"tags":["Extract Templates API"],"summary":"Run Extract Template","operationId":"runExtractTemplate","method":"post","type":"path","servers":["750ab62d-ab67-4bbe-8cf4-3493ce6ece35"],"path":"/v2/extract/templates/run","baseUrlOptions":["https://sdk.nimbleway.com"],"title":"Run Extract Template","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"description":"Request body for executing an Extraction Template","properties":{"params":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"params.additionalProperties","typeLabel":"any"},"properties":{},"type":"object","isRequired":true,"uniqueKey":"params","typeLabel":"object"},"template":{"type":"string","isRequired":true,"uniqueKey":"template","typeLabel":"string"},"formats":{"description":"Response formats to include. All disabled by default.","examples":[["html","markdown"]],"items":{"enum":["html","markdown","screenshot","headers","links"],"type":"string","uniqueKey":"formats.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"type":"array","uniqueKey":"formats","typeLabel":"enum\u003cstring>[]"},"localization":{"default":false,"type":"boolean","uniqueKey":"localization","typeLabel":"boolean"}},"required":["params","template"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"params":{},"template":"\u003cstring>","formats":["html","markdown"],"localization":false}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"eacf84e5-c0ab-457c-a32b-09a4da6e44b3":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"browser_actions":{"additionalProperties":false,"description":"Browser actions execution results. Present only when browser_actions were specified in the request.","properties":{"results":{"items":{"additionalProperties":false,"properties":{"duration":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"data.browser_actions.results.items.[INDEX].duration","typeLabel":"number"},"name":{"enum":["goto","wait","wait_for_element","wait_for_navigation","click","fill","press","scroll","auto_scroll","screenshot","get_cookies","eval","fetch"],"type":"string","isRequired":true,"uniqueKey":"data.browser_actions.results.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"status":{"enum":["no-run","in-progress","done","error","skipped"],"type":"string","isRequired":true,"uniqueKey":"data.browser_actions.results.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"error":{"type":"string","uniqueKey":"data.browser_actions.results.items.[INDEX].error","typeLabel":"string"},"result":{"oneOf":[{}],"uniqueKey":"data.browser_actions.results.items.[INDEX].result","typeLabel":"any"}},"required":["name","status","duration"],"type":"object","uniqueKey":"data.browser_actions.results.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","isRequired":true,"uniqueKey":"data.browser_actions.results","typeLabel":"object[]"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"data.browser_actions.success","typeLabel":"boolean"},"total_duration":{"minimum":0,"type":"number","isRequired":true,"uniqueKey":"data.browser_actions.total_duration","typeLabel":"number"}},"required":["success","results","total_duration"],"type":"object","uniqueKey":"data.browser_actions","typeLabel":"object"},"cookies":{"description":"The cookies collected from browser actions during the task.","items":{"oneOf":[{}],"uniqueKey":"data.cookies.items.[INDEX]","typeLabel":"any"},"type":"array","uniqueKey":"data.cookies","typeLabel":"any[]"},"eval":{"description":"The evaluation results from browser actions during the task.","items":{"oneOf":[{}],"uniqueKey":"data.eval.items.[INDEX]","typeLabel":"any"},"type":"array","uniqueKey":"data.eval","typeLabel":"any[]"},"fetch":{"description":"The http requests from browser actions made during the task.","items":{"oneOf":[{}],"uniqueKey":"data.fetch.items.[INDEX]","typeLabel":"any"},"type":"array","uniqueKey":"data.fetch","typeLabel":"any[]"},"headers":{"additionalProperties":{"type":"string","uniqueKey":"data.headers.additionalProperties","typeLabel":"string"},"description":"The headers received during the task.","propertyNames":{"type":"string"},"type":"object","uniqueKey":"data.headers","typeLabel":"object"},"html":{"description":"The HTML content of the page.","type":"string","uniqueKey":"data.html","typeLabel":"string"},"links":{"description":"List of all unique URLs found on the page.","items":{"type":"string","uniqueKey":"data.links.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.links","typeLabel":"string[]"},"markdown":{"description":"The Markdown version of the HTML content.","type":"string","uniqueKey":"data.markdown","typeLabel":"string"},"network_capture":{"description":"The network capture data collected during the task.","items":{"additionalProperties":false,"properties":{"filter":{"additionalProperties":false,"properties":{"validation":{"default":false,"type":"boolean","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].filter.validation","typeLabel":"boolean"},"wait_for_requests_count":{"default":0,"minimum":0,"type":"number","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].filter.wait_for_requests_count","typeLabel":"number"},"method":{"enum":["GET","HEAD","POST","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH"],"type":"string","uniqueKey":"data.network_capture.items.[INDEX].filter.method","typeLabel":"enum\u003cstring>"},"resource_type":{"oneOf":[{"type":"string","description":"Resource type for network capture filtering","enum":["document","stylesheet","image","media","font","script","texttrack","xhr","fetch","prefetch","eventsource","websocket","manifest","signedexchange","ping","cspviolationreport","preflight","other","fedcm"],"example":"document","uniqueKey":"data.network_capture.items.[INDEX].filter.resource_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"array","items":{"description":"Resource type for network capture filtering","enum":["document","stylesheet","image","media","font","script","texttrack","xhr","fetch","prefetch","eventsource","websocket","manifest","signedexchange","ping","cspviolationreport","preflight","other","fedcm"],"examples":["document","script","xhr","fetch"],"type":"string","uniqueKey":"data.network_capture.items.[INDEX].filter.resource_type.oneOf.1.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"uniqueKey":"data.network_capture.items.[INDEX].filter.resource_type.oneOf.1","typeLabel":"enum\u003cstring>[]"}],"uniqueKey":"data.network_capture.items.[INDEX].filter.resource_type","typeLabel":"enum\u003cstring> | enum\u003cstring>[]"},"status_code":{"oneOf":[{"type":"number","maximum":599,"minimum":100,"uniqueKey":"data.network_capture.items.[INDEX].filter.status_code.oneOf.0","typeLabel":"number"},{"type":"array","items":{"maximum":599,"minimum":100,"type":"number","uniqueKey":"data.network_capture.items.[INDEX].filter.status_code.oneOf.1.items.[INDEX]","typeLabel":"number"},"minItems":1,"uniqueKey":"data.network_capture.items.[INDEX].filter.status_code.oneOf.1","typeLabel":"number[]"}],"uniqueKey":"data.network_capture.items.[INDEX].filter.status_code","typeLabel":"number | number[]"},"url":{"additionalProperties":false,"properties":{"type":{"default":"exact","enum":["exact","contains"],"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].filter.url.type","typeLabel":"enum\u003cstring>"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].filter.url.value","typeLabel":"string"}},"required":["type","value"],"type":"object","uniqueKey":"data.network_capture.items.[INDEX].filter.url","typeLabel":"object"},"wait_for_requests_count_timeout":{"exclusiveMinimum":0,"maximum":300000,"type":"number","uniqueKey":"data.network_capture.items.[INDEX].filter.wait_for_requests_count_timeout","typeLabel":"number"}},"required":["validation","wait_for_requests_count"],"type":"object","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].filter","typeLabel":"object"},"results":{"items":{"additionalProperties":false,"properties":{"request":{"additionalProperties":false,"properties":{"headers":{"additionalProperties":{"type":"string","uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.headers.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"type":"object","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.headers","typeLabel":"object"},"method":{"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.method","typeLabel":"string"},"resource_type":{"description":"Resource type for network capture filtering","enum":["document","stylesheet","image","media","font","script","texttrack","xhr","fetch","prefetch","eventsource","websocket","manifest","signedexchange","ping","cspviolationreport","preflight","other","fedcm"],"examples":["document","script","xhr","fetch"],"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.resource_type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.url","typeLabel":"string"},"body":{"type":"string","uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request.body","typeLabel":"string"}},"required":["resource_type","method","url","headers"],"type":"object","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].request","typeLabel":"object"},"response":{"additionalProperties":false,"properties":{"body":{"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.body","typeLabel":"string"},"headers":{"additionalProperties":{"type":"string","uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.headers.additionalProperties","typeLabel":"string"},"propertyNames":{"type":"string"},"type":"object","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.headers","typeLabel":"object"},"serialization":{"enum":["none","base64"],"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.serialization","typeLabel":"enum\u003cstring>"},"status":{"type":"number","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.status","typeLabel":"number"},"status_text":{"type":"string","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response.status_text","typeLabel":"string"}},"required":["status","status_text","headers","serialization","body"],"type":"object","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX].response","typeLabel":"object"}},"required":["request","response"],"type":"object","uniqueKey":"data.network_capture.items.[INDEX].results.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"data.network_capture.items.[INDEX].results","typeLabel":"object[]"},"errorMessage":{"type":"string","uniqueKey":"data.network_capture.items.[INDEX].errorMessage","typeLabel":"string"}},"required":["filter","results"],"type":"object","uniqueKey":"data.network_capture.items.[INDEX]","typeLabel":"object"},"readOnly":true,"type":"array","uniqueKey":"data.network_capture","typeLabel":"object[]"},"pages_html":{"description":"Individual HTML content of each pagination page, before merging.","items":{"type":"string","uniqueKey":"data.pages_html.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"data.pages_html","typeLabel":"string[]"},"parsing":{"oneOf":[{"type":"object","description":"The parsing results extracted from the HTML \u0026 network content.","required":["status","entities"],"properties":{"entities":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"data.parsing.oneOf.0.entities.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"type":"object","isRequired":true,"uniqueKey":"data.parsing.oneOf.0.entities","typeLabel":"object"},"status":{"const":"success","type":"string","isRequired":true,"uniqueKey":"data.parsing.oneOf.0.status","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"data.parsing.oneOf.0","typeLabel":"object"},{"type":"object","description":"The parsing results extracted from the HTML \u0026 network content.","required":["status","error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"data.parsing.oneOf.1.error","typeLabel":"string"},"status":{"const":"error","type":"string","isRequired":true,"uniqueKey":"data.parsing.oneOf.1.status","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"data.parsing.oneOf.1","typeLabel":"object"},{"type":"object","description":"The parsing results extracted from the HTML \u0026 network content.","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.parsing.oneOf.2.additionalProperties","typeLabel":"any"},"uniqueKey":"data.parsing.oneOf.2","typeLabel":"object"}],"uniqueKey":"data.parsing","typeLabel":"object"},"redirects":{"description":"The list of redirects that occurred during the task.","items":{"additionalProperties":false,"properties":{"status_code":{"maximum":599,"minimum":100,"type":"number","isRequired":true,"uniqueKey":"data.redirects.items.[INDEX].status_code","typeLabel":"number"},"url":{"type":"string","isRequired":true,"uniqueKey":"data.redirects.items.[INDEX].url","typeLabel":"string"}},"required":["status_code","url"],"type":"object","uniqueKey":"data.redirects.items.[INDEX]","typeLabel":"object"},"type":"array","uniqueKey":"data.redirects","typeLabel":"object[]"},"screenshots":{"description":"Screenshots taken during the task, from browser actions, or the screenshot format.","items":{"oneOf":[{}],"uniqueKey":"data.screenshots.items.[INDEX]","typeLabel":"any"},"type":"array","uniqueKey":"data.screenshots","typeLabel":"any[]"}},"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"metadata":{"additionalProperties":false,"properties":{"agent":{"description":"The name of the agent used for the query.","type":"string","uniqueKey":"metadata.agent","typeLabel":"string"},"driver":{"description":"The driver used for the task.","type":"string","uniqueKey":"metadata.driver","typeLabel":"string"},"localization_id":{"description":"The localization identifier for the query.","type":"string","uniqueKey":"metadata.localization_id","typeLabel":"string"},"query_duration":{"description":"The duration in milliseconds of the query processing.","type":"number","uniqueKey":"metadata.query_duration","typeLabel":"number"},"query_time":{"description":"The time when the query was received.","type":"string","uniqueKey":"metadata.query_time","typeLabel":"string"},"response_parameters":{"description":"Additional response parameters.","uniqueKey":"metadata.response_parameters","typeLabel":"any"},"tag":{"description":"A tag associated with the query.","type":"string","uniqueKey":"metadata.tag","typeLabel":"string"}},"type":"object","isRequired":true,"uniqueKey":"metadata","typeLabel":"object"},"status":{"description":"The status of the task.","enum":["success","skipped","fatal","error","postponed","ignored","rejected","blocked"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"task_id":{"description":"Unique identifier for the task.","type":"string","isRequired":true,"uniqueKey":"task_id","typeLabel":"string"},"url":{"description":"The final URL.","type":"string","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"debug":{"additionalProperties":false,"properties":{"performance_metrics":{"additionalProperties":{"type":"number","uniqueKey":"debug.performance_metrics.additionalProperties","typeLabel":"number"},"description":"Performance metrics collected during the task.","propertyNames":{"type":"string"},"type":"object","uniqueKey":"debug.performance_metrics","typeLabel":"object"},"proxy_total_bytes_usage":{"description":"Total bytes used by the proxy during the task.","minimum":0,"type":"number","uniqueKey":"debug.proxy_total_bytes_usage","typeLabel":"number"},"transformed_output":{"description":"The transformed output after applying any transformations.","uniqueKey":"debug.transformed_output","typeLabel":"any"},"userbrowser":{"description":"The userbrowser instance using during the task.","uniqueKey":"debug.userbrowser","typeLabel":"any"}},"type":"object","uniqueKey":"debug","typeLabel":"object"},"pagination":{"oneOf":[{"type":"object","description":"Pagination information if applicable.","required":["next_page_params"],"properties":{"next_page_params":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"pagination.oneOf.0.next_page_params.additionalProperties","typeLabel":"any"},"properties":{},"type":"object","isRequired":true,"uniqueKey":"pagination.oneOf.0.next_page_params","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"pagination.oneOf.0","typeLabel":"object"},{"type":"array","items":{"additionalProperties":false,"properties":{"next_page_params":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"pagination.oneOf.1.items.[INDEX].next_page_params.additionalProperties","typeLabel":"any"},"properties":{},"type":"object","isRequired":true,"uniqueKey":"pagination.oneOf.1.items.[INDEX].next_page_params","typeLabel":"object"}},"required":["next_page_params"],"type":"object","uniqueKey":"pagination.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"Pagination information if applicable.","uniqueKey":"pagination.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"pagination","typeLabel":"object | object[]"},"status_code":{"description":"The HTTP status code of the task.","type":"number","uniqueKey":"status_code","typeLabel":"number"},"warnings":{"description":"List of warnings generated during the task.","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"warnings","typeLabel":"string[]"}},"required":["task_id","url","status","data","metadata"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"browser_actions":{"results":[{"duration":1,"name":"goto","status":"no-run","error":"\u003cstring>","result":"\u003cunknown>"}],"success":true,"total_duration":1},"cookies":["\u003cunknown>"],"eval":["\u003cunknown>"],"fetch":["\u003cunknown>"],"headers":{},"html":"\u003cstring>","links":["\u003cstring>"],"markdown":"\u003cstring>","network_capture":[{"filter":{"validation":false,"wait_for_requests_count":0,"method":"GET","resource_type":"document","status_code":349.5,"url":{"type":"exact","value":"\u003cstring>"},"wait_for_requests_count_timeout":123},"results":[{"request":{"headers":{},"method":"\u003cstring>","resource_type":"document","url":"\u003cstring>","body":"\u003cstring>"},"response":{"body":"\u003cstring>","headers":{},"serialization":"none","status":123,"status_text":"\u003cstring>"}}],"errorMessage":"\u003cstring>"}],"pages_html":["\u003cstring>"],"parsing":{"entities":{},"status":"success"},"redirects":[{"status_code":349.5,"url":"\u003cstring>"}],"screenshots":["\u003cunknown>"]},"metadata":{"agent":"\u003cstring>","driver":"\u003cstring>","localization_id":"\u003cstring>","query_duration":123,"query_time":"\u003cstring>","response_parameters":"\u003cunknown>","tag":"\u003cstring>"},"status":"success","task_id":"\u003cstring>","url":"\u003cstring>","debug":{"performance_metrics":{},"proxy_total_bytes_usage":1,"transformed_output":"\u003cunknown>","userbrowser":"\u003cunknown>"},"pagination":{"next_page_params":{}},"status_code":123,"warnings":["\u003cstring>"]}}},"exampleType":"generated"}},"description":"Successful Response","exampleType":"generated"},"4ef953a9-fafc-4f9a-9bea-2e4a040d4205":{"content":{"application/json":{"schema":{"additionalProperties":{"oneOf":[{}],"uniqueKey":"additionalProperties","typeLabel":"any"},"properties":{"msg":{"examples":["Template not found"],"type":"string","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"status":{"const":"failed","type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"string"}},"required":["status","msg"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"msg":"Template not found","status":"failed"}}},"exampleType":"generated"}},"description":"Template Not Found","exampleType":"generated"}},"security":{"20f23fbe-5c92-4c39-8ddb-8d7e229d2510":{"BearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"750ab62d-ab67-4bbe-8cf4-3493ce6ece35":{"url":"https://sdk.nimbleway.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"nimble-f5a8283f","siteName":"Nimble Docs","title":"Run Extract Template - Nimble Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T22:09:37.148Z","originalFileLocation":"api-reference/extract-templates-api/run-extract-template.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Execute Extract Template Realtime Endpoint\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nimble Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Run Extract Template - Nimble Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Execute Extract Template Realtime Endpoint\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nimble Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://nimble-f5a8283f.mintlify.app/_mintlify/api/og/v2?division=Extract+Templates+API\u0026amp;title=Run+Extract+Template\u0026amp;description=Execute+Extract+Template+Realtime+Endpoint\u0026amp;theme=e511cdab2c346c886a5a73f0\u0026amp;signature=ebe67a051db3b17d58494b80cd7751adbfcbbaacf1903921088deacf151bf261\">\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=\"Run Extract Template - Nimble Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Execute Extract Template Realtime Endpoint\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://nimble-f5a8283f.mintlify.app/_mintlify/api/og/v2?division=Extract+Templates+API\u0026amp;title=Run+Extract+Template\u0026amp;description=Execute+Extract+Template+Realtime+Endpoint\u0026amp;theme=e511cdab2c346c886a5a73f0\u0026amp;signature=ebe67a051db3b17d58494b80cd7751adbfcbbaacf1903921088deacf151bf261\">\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/nimble-f5a8283f/O9QbVEd4KNgIUIh9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nimble Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#edc602\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template\">\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-templates-api/run-extract-template.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nimbleway.com/#organization\",\"name\":\"Nimble Docs\",\"url\":\"https://docs.nimbleway.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/nimble-f5a8283f/o--9pIuMkGtkmWwc/images/light.svg?fit=max\u0026auto=format\u0026n=o--9pIuMkGtkmWwc\u0026q=85\u0026s=4f01d3ff0f6702dfa400db4d8d46d71a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nimbleway.com#website\",\"name\":\"Nimble Docs\",\"url\":\"https://docs.nimbleway.com\",\"publisher\":{\"@id\":\"https://docs.nimbleway.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template#webpage\",\"url\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template\",\"name\":\"Run Extract Template\",\"description\":\"Execute Extract Template Realtime Endpoint\",\"dateModified\":\"2026-10-14T22:09:37.148Z\",\"isPartOf\":{\"@id\":\"https://docs.nimbleway.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Nimble Docs\",\"item\":\"https://docs.nimbleway.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Run Extract Template\",\"item\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template#apireference\",\"headline\":\"Run Extract Template\",\"name\":\"Run Extract Template\",\"description\":\"Execute Extract Template Realtime Endpoint\",\"url\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nimbleway.com/api-reference/extract-templates-api/run-extract-template#webpage\"},\"dateModified\":\"2026-10-14T22:09:37.148Z\",\"publisher\":{\"@id\":\"https://docs.nimbleway.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nimbleway.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nimble Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Nimble Docs","nav":{"global":{"anchors":[{"anchor":"Ask Nimble","icon":"wand-magic-sparkles","color":{"light":"#edc602","dark":"#edc602"},"href":"https://online.nimbleway.com/workflow-builder"}]},"tabs":[{"tab":"Home","icon":"house-blank","pages":[{"title":"Home","href":"/home"}]},{"tab":"Hackathon","hidden":true,"pages":[{"title":"Hackathon","href":"/hackathon"}]},{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/nimble-sdk/getting-started/overview"}]},{"tab":"Nimble Platform","hidden":true,"pages":[{"title":"Nimble Platform","href":"/nimble-platform/agents/managed-agents"}]},{"tab":"Integrations","icon":"link-horizontal","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"API Reference","icon":"code","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Search API","icon":"magnifying-glass","pages":[{"title":"Search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/search","href":"/api-reference/search/search"}]},{"group":"Agents API","icon":"bullseye-pointer","tag":"NEW","pages":[{"title":"Create Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents/runs","href":"/api-reference/public-api/create-run"},{"title":"Create Agent Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents/{agent_id}/runs","href":"/api-reference/public-api/create-agent-run"},{"title":"Get Agent Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}","href":"/api-reference/public-api/get-agent-run"},{"title":"Get Agent Run Result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}/result","href":"/api-reference/public-api/get-agent-run-result"},{"title":"Stream Agent Run Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs/{run_id}/events","href":"/api-reference/public-api/stream-agent-run-events"},{"title":"List Agent Runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}/runs","href":"/api-reference/public-api/list-agent-runs"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/agents","href":"/api-reference/public-api/create-agent"},{"title":"List Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents","href":"/api-reference/public-api/list-agents"},{"title":"Get Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/{agent_id}","href":"/api-reference/public-api/get-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/agents/{agent_id}","href":"/api-reference/public-api/update-agent"},{"title":"Deactivate Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/agents/{agent_id}","href":"/api-reference/public-api/deactivate-agent"},{"title":"List Agent Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/templates","href":"/api-reference/public-api/list-agent-templates"},{"title":"Get Agent Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/agents/templates/{template_name}","href":"/api-reference/public-api/get-agent-template"}]},{"group":"Extract API","icon":"arrows-to-circle","pages":[{"title":"Extract","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract","href":"/api-reference/extract/extract"},{"title":"Extract Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/async","href":"/api-reference/extract/extract-async"},{"title":"Extract Batch","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/batch","href":"/api-reference/extract/extract-batch"}]},{"group":"Extract Templates API","icon":"table-cells","tag":"NEW","pages":[{"title":"Run Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/run","href":"/api-reference/extract-templates-api/run-extract-template"},{"title":"Run Extract Template (Async)","description":"Execute Extract Template Async Endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/async","href":"/api-reference/extract-templates-api/run-extract-template-async"},{"title":"Run Extract Template (Batch)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/batch","href":"/api-reference/extract-templates-api/run-extract-template-batch"},{"title":"List Extract Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates","href":"/api-reference/extract-templates-api/list-extract-templates"},{"title":"Get Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/get-extract-template"},{"title":"Update Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/update-extract-template"},{"title":"Delete Extract Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/extract/templates/{extract_template_name}","href":"/api-reference/extract-templates-api/delete-extract-template"},{"title":"List Extract Template Versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}/versions","href":"/api-reference/extract-templates-api/list-extract-template-versions"},{"title":"Get Extract Template Version","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/{extract_template_name}/versions/{version_id}","href":"/api-reference/extract-templates-api/get-extract-template-version"},{"title":"Create Extract Template Generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/extract/templates/generations","href":"/api-reference/extract-templates-api/create-extract-template-generation"},{"title":"Get Extract Template Generation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/extract/templates/generations/{generation_id}","href":"/api-reference/extract-templates-api/get-extract-template-generation"}]},{"group":"Map API","icon":"sitemap","pages":[{"title":"Map","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/map","href":"/api-reference/map/map"}]},{"group":"Crawl API","icon":"spider","pages":[{"title":"Create Crawl","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/crawl","href":"/api-reference/crawl/create-crawl"},{"title":"List Crawls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/crawl","href":"/api-reference/crawl/list-crawls"},{"title":"Crawl by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/crawl/{id}","href":"/api-reference/crawl/crawl-by-id"},{"title":"Cancel Crawl","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/crawl/{id}","href":"/api-reference/crawl/cancel-crawl"}]},{"group":"SERP API","icon":"search","tag":"NEW","pages":[{"title":"SERP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp","href":"/api-reference/serp/serp"},{"title":"SERP Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp/async","href":"/api-reference/serp/serp-async"},{"title":"SERP Batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/serp/batch","href":"/api-reference/serp/serp-batch"}]},{"group":"Media API","icon":"image","tag":"NEW","pages":[{"title":"Media Download","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/media","href":"/api-reference/media/media-download"},{"title":"Media Download Async","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/media/async","href":"/api-reference/media/media-download-async"}]},{"group":"Domain Knowledge API","icon":"brain","tag":"NEW","pages":[{"title":"Get Driver","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/domain-knowledge/driver","href":"/api-reference/domain-knowledge/get-driver"}]},{"group":"Domain Health API","icon":"heart-pulse","tag":"NEW","pages":[{"title":"Check Domain Health","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/domain-health/check","href":"/api-reference/domain-health/check-domain-health"}]},{"group":"Jobs API","icon":"timer","tag":"NEW","pages":[{"title":"Create Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs","href":"/api-reference/jobs/create-job"},{"title":"List Jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/{job_id}","href":"/api-reference/jobs/get-job"},{"title":"Update Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v2/jobs/{job_id}","href":"/api-reference/jobs/update-job"},{"title":"Delete Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v2/jobs/{job_id}","href":"/api-reference/jobs/delete-job"},{"title":"Trigger Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs/{job_id}/runs","href":"/api-reference/jobs/trigger-run"},{"title":"List Runs for Job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/{job_id}/runs","href":"/api-reference/jobs/list-runs-for-job"},{"title":"Get Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}","href":"/api-reference/jobs/get-run"},{"title":"Cancel Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v2/jobs/runs/{run_id}/cancel","href":"/api-reference/jobs/cancel-run"},{"title":"List Run Artifacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts","href":"/api-reference/jobs/list-run-artifacts"},{"title":"Get Run Artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}","href":"/api-reference/jobs/get-run-artifact"},{"title":"Preview Run Artifact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/preview","href":"/api-reference/jobs/preview-run-artifact"},{"title":"Get Run Artifact Download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/jobs/runs/{run_id}/artifacts/{artifact_id}/download-url","href":"/api-reference/jobs/get-run-artifact-download-url"}]},{"group":"Tasks \u0026 Batches API","icon":"list-check","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Task Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks/{task_id}","href":"/api-reference/tasks/task-status"},{"title":"Task Result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/tasks/{task_id}/results","href":"/api-reference/tasks/task-result"},{"title":"List batches","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches","href":"/api-reference/tasks/list-batches"},{"title":"Get batch details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches/{batch_id}","href":"/api-reference/tasks/get-batch-details"},{"title":"Get batch progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v2/batches/{batch_id}/progress","href":"/api-reference/tasks/get-batch-progress"}]},{"group":"Proxy API","icon":"globe","pages":[]},{"group":"Fast SERP API","icon":"bolt","hidden":true,"tag":"NEW","pages":[{"title":"Fast Google SERP","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/realtime/serp","href":"/api-reference/fast-serp/fast-google-serp"}]}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/release-notes"}]}]},"basePath":"","title":"Run Extract Template - Nimble Docs","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"]}