{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fieldwise.ai","colors":{"primary":"#0AAAC2","light":"#0AAAC2","dark":"#0AAAC2"},"logo":{"light":"https://mintcdn.com/fieldwiseai/oO89ucxpSBL5mn4m/logo/light.svg?fit=max\u0026auto=format\u0026n=oO89ucxpSBL5mn4m\u0026q=85\u0026s=9fa713c6d539a6aaf1c36d6d85d1f969","dark":"https://mintcdn.com/fieldwiseai/oO89ucxpSBL5mn4m/logo/dark.svg?fit=max\u0026auto=format\u0026n=oO89ucxpSBL5mn4m\u0026q=85\u0026s=30c7001074dcde95f81b109dd7aea0e2"},"favicon":"/favicon.png","api":{"playground":{"proxy":false}},"navbar":{"links":[{"label":"Support","href":"mailto:support@fieldwise.ai"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.fieldwise.ai"}},"footer":{"links":[{"header":"Company","items":[{"label":"FAQ","href":"https://www.fieldwise.ai/faq"},{"label":"Privacy Policy","href":"https://www.fieldwise.ai/privacy-policy"},{"label":"Terms of Service","href":"https://www.fieldwise.ai/terms"}]}]},"seo":{"metatags":{"og:image":"/images/og-image.png","og:title":"FieldwiseAI - API Documentation","og:description":"FieldwiseAI API Documentation","og:image:width":"800","og:image:height":"600"}},"styling":{"latex":false},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fieldwiseai","hasAudioNarration":false,"actualSubdomain":"fieldwiseai","customDomains":["docs.fieldwise.ai"],"gitSource":{"type":"github","owner":"tidepool-copilot","repo":"fieldwise-api-doc","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c74a016d95c09d0eb56e","collectionId":"18a80fc0-27e1-4083-9d2b-98b969b2b4b0","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae9253be0bf2909fa998f80:success","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":23},{"language":"default","tag":"Documents","count":18},{"language":"default","tag":"Extractions","count":4},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Tasks","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/documents/ingest-document-from-url","slug":"/api-reference/documents/ingest-document-from-url","pageMetadata":{"openapi":"post /api/v1/documents/ingest/url","title":"Ingest Document From Url","description":"Ingest a document from a URL.","href":"/api-reference/documents/ingest-document-from-url"},"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: \"Ingest a document from a URL.\"\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":{"openapi":"post /api/v1/documents/ingest/url","title":"Ingest Document From Url","description":"Ingest a document from a URL.","href":"/api-reference/documents/ingest-document-from-url"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Ingest Document From Url","description":"Ingest a document from a URL.","operationId":"ingest_document_from_url_api_v1_documents_ingest_url_post","parameters":["237b862d-1ecd-4640-b38c-4c6f125e7b64"],"requestBody":"654a3c0f-dd71-47e2-8c12-329a0c323af1","responses":{"201":"6bfab3b0-93ae-4ef7-8e5b-efd5927b7fb9","400":"b0b28c86-f2e8-42a8-9e30-93f604745111","401":"711f6546-7366-45ca-ae7a-fe7be106cdab","403":"4aaa2898-19eb-45f9-a1cc-c4f21c26108b","422":"0b8e149c-02ed-42dc-868b-e17b645b65ac","429":"58519248-f3c9-4e24-a16c-b38206c8b691"},"method":"post","type":"path","servers":["a60c1aaa-9f7c-4a26-b260-67ec70f0ee65"],"security":["b55afaa4-ad7f-4411-83d5-dee3135e2a5d"],"path":"/api/v1/documents/ingest/url","baseUrlOptions":["https://api.fieldwise.ai"],"title":"Ingest Document From Url","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"237b862d-1ecd-4640-b38c-4c6f125e7b64":{"name":"X-API-Key","in":"header","required":false,"schema":{"oneOf":[{"type":"string","title":"X-Api-Key","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"X-Api-Key","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"url":{"type":"string","title":"Url","description":"URL of the document to ingest","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Document metadata (must be primitive types, arrays, or nested objects)","uniqueKey":"metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Document metadata (must be primitive types, arrays, or nested objects)","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"Metadata · object | null"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"External identifier","maxLength":255,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"External identifier","uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"external_id","typeLabel":"string | null"}},"type":"object","required":["url"],"title":"URLDocumentRequest","description":"Request model for ingesting documents via URL.","example":{"external_id":"doc123","metadata":{"category":"finance","details":{"year":2023},"tags":["quarterly","report"]},"url":"https://example.com/document.pdf"},"uniqueKey":"","typeLabel":"URLDocumentRequest · object"},"examples":{"Example":{"title":"Example","value":{"external_id":"doc123","metadata":{"category":"finance","details":{"year":2023},"tags":["quarterly","report"]},"url":"https://example.com/document.pdf"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6bfab3b0-93ae-4ef7-8e5b-efd5927b7fb9":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"data":{"type":"object","title":"UploadResponseData","description":"Response data","properties":{"task_identifier":{"oneOf":[{"type":"string","title":"Task Identifier","description":"Task identifier for tracking progress (null for synchronous operations)","uniqueKey":"data.task_identifier.oneOf.0","typeLabel":"string"},{"type":"null","title":"Task Identifier","description":"Task identifier for tracking progress (null for synchronous operations)","uniqueKey":"data.task_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.task_identifier","typeLabel":"string | null"},"file_path":{"oneOf":[{"type":"string","title":"File Path","description":"Path where the file is stored (null for embedding-based documents)","uniqueKey":"data.file_path.oneOf.0","typeLabel":"string"},{"type":"null","title":"File Path","description":"Path where the file is stored (null for embedding-based documents)","uniqueKey":"data.file_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.file_path","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","title":"External Id","description":"External identifier if provided","uniqueKey":"data.external_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"External Id","description":"External identifier if provided","uniqueKey":"data.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.external_id","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"UploadResponseData · object"},"success":{"type":"boolean","title":"Success","default":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"oneOf":[{"type":"object","title":"ErrorDetail","description":"Schema for API error responses.","required":["message","error_code"],"example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error.oneOf.0.error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"error.oneOf.0.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"error.oneOf.0.details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"error.oneOf.0.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.oneOf.0.details","typeLabel":"Details · object[] | null"}},"uniqueKey":"error.oneOf.0","typeLabel":"ErrorDetail · object"},{"type":"null","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"ErrorDetail · object | null"},"meta":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp","uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"},"version":{"type":"string","title":"Version","default":"1.0","uniqueKey":"meta.version","typeLabel":"string"}},"type":"object","title":"MetaData","description":"Metadata for API responses","uniqueKey":"meta","typeLabel":"MetaData · object"}},"type":"object","required":["data"],"title":"UploadResponse","uniqueKey":"","typeLabel":"UploadResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":{"task_identifier":"\u003cstring>","file_path":"\u003cstring>","external_id":"\u003cstring>"},"success":true,"error":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"meta":{"timestamp":"2023-11-07T05:31:56Z","version":"1.0"}}}},"exampleType":"generated"}},"exampleType":"generated"},"b0b28c86-f2e8-42a8-9e30-93f604745111":{"description":"Invalid request or unsupported file type","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object[] | null"}},"type":"object","required":["message","error_code"],"title":"ErrorDetail","description":"Schema for API error responses.","example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"uniqueKey":"","typeLabel":"ErrorDetail · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"711f6546-7366-45ca-ae7a-fe7be106cdab":{"description":"Unauthorized access","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object[] | null"}},"type":"object","required":["message","error_code"],"title":"ErrorDetail","description":"Schema for API error responses.","example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"uniqueKey":"","typeLabel":"ErrorDetail · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"4aaa2898-19eb-45f9-a1cc-c4f21c26108b":{"description":"Forbidden","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object[] | null"}},"type":"object","required":["message","error_code"],"title":"ErrorDetail","description":"Schema for API error responses.","example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"uniqueKey":"","typeLabel":"ErrorDetail · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"0b8e149c-02ed-42dc-868b-e17b645b65ac":{"description":"Unprocessable entity","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object[] | null"}},"type":"object","required":["message","error_code"],"title":"ErrorDetail","description":"Schema for API error responses.","example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"uniqueKey":"","typeLabel":"ErrorDetail · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"},"58519248-f3c9-4e24-a16c-b38206c8b691":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"properties":{"message":{"type":"string","title":"Message","description":"Error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","title":"Error Code","description":"Error code identifier","isRequired":true,"uniqueKey":"error_code","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"details.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"Details · object[]"},{"type":"null","title":"Details","description":"Additional error details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object[] | null"}},"type":"object","required":["message","error_code"],"title":"ErrorDetail","description":"Schema for API error responses.","example":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"},"uniqueKey":"","typeLabel":"ErrorDetail · object"},"examples":{"Example":{"title":"Example","value":{"error_code":"RESOURCE_NOT_FOUND","message":"Resource not found"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b55afaa4-ad7f-4411-83d5-dee3135e2a5d":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}}},"servers":{"a60c1aaa-9f7c-4a26-b260-67ec70f0ee65":{"url":"https://api.fieldwise.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"fieldwiseai","siteName":"Fieldwise.ai","title":"FieldwiseAI - API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-14T12:06:58.575Z","originalFileLocation":"api-reference/documents/ingest-document-from-url.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=\"Ingest a document from a URL.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fieldwise.ai\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_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/fieldwiseai/jnqltqNmHm9h-4-q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"FieldwiseAI - API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"FieldwiseAI API Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fieldwise.ai\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fieldwiseai.mintlify.site/images/og-image.png\">\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=\"FieldwiseAI - API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"FieldwiseAI API Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fieldwiseai.mintlify.site/images/og-image.png\">\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/fieldwiseai/jnqltqNmHm9h-4-q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fieldwise.ai\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0AAAC2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/documents/ingest-document-from-url.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.fieldwise.ai/#organization\",\"name\":\"Fieldwise.ai\",\"url\":\"https://docs.fieldwise.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fieldwiseai/oO89ucxpSBL5mn4m/logo/light.svg?fit=max\u0026auto=format\u0026n=oO89ucxpSBL5mn4m\u0026q=85\u0026s=9fa713c6d539a6aaf1c36d6d85d1f969\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.fieldwise.ai#website\",\"name\":\"Fieldwise.ai\",\"url\":\"https://docs.fieldwise.ai\",\"publisher\":{\"@id\":\"https://docs.fieldwise.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url#webpage\",\"url\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url\",\"name\":\"Ingest Document From Url\",\"description\":\"Ingest a document from a URL.\",\"dateModified\":\"2025-08-14T12:06:58.575Z\",\"isPartOf\":{\"@id\":\"https://docs.fieldwise.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documents\",\"item\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Ingest Document From Url\",\"item\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url#apireference\",\"headline\":\"Ingest Document From Url\",\"name\":\"Ingest Document From Url\",\"description\":\"Ingest a document from a URL.\",\"url\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url\",\"mainEntityOfPage\":{\"@id\":\"https://docs.fieldwise.ai/api-reference/documents/ingest-document-from-url#webpage\"},\"image\":\"https://docs.fieldwise.ai/images/og-image.png\",\"dateModified\":\"2025-08-14T12:06:58.575Z\",\"publisher\":{\"@id\":\"https://docs.fieldwise.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.fieldwise.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Fieldwise.ai\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Fieldwise.ai","nav":{"global":{},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Documents","pages":[{"openapi":"post /api/v1/documents/ingest","title":"Ingest Document","description":"Upload a document and start processing it.","href":"/api-reference/documents/ingest-document"},{"openapi":"post /api/v1/documents/ingest/url","title":"Ingest Document From Url","href":"/api-reference/documents/ingest-document-from-url"},{"openapi":"post /api/v1/documents/ingest/embedding","title":"Ingest Document From Embedding","description":"Ingest a document directly from a pre-computed embedding vector.\n\nThis endpoint allows you to create documents directly from embedding vectors,\nbypassing the file upload and text extraction process. This is useful when:\n\n- You already have pre-computed embeddings\n- You want to ingest structured data or custom content\n- You need to create documents from API responses or generated content\n- You want to maintain embedding consistency across systems\n\nThe embedding vector must be exactly 1536 dimensions (OpenAI's text-embedding-ada-002 format).\n\nPerformance Benefits:\n- No file processing overhead\n- No text extraction or embedding generation\n- Immediate availability for search\n- Synchronous operation (completed immediately)\n\nRetrieval:\n- Documents can be retrieved using the returned task_identifier via GET /task/{task_identifier}\n- External ID retrieval also works via GET /external/{external_id} if provided\n\nBest Practices:\n- Ensure embedding vector quality matches your use case\n- Include meaningful content text for human readability\n- Use consistent metadata structure for filtering\n- Consider embedding source and generation method in metadata","href":"/api-reference/documents/ingest-document-from-embedding"},{"title":"Get Document Answer","openapi":"post /api/v1/documents/answer","href":"/api-reference/documents/get-document-answer"},{"title":"Search document pages (deprecated)","openapi":"post /api/v1/documents/pages/search","href":"/api-reference/documents/search-document-pages"},{"openapi":"post /api/v1/documents/list","title":"List Documents","href":"/api-reference/documents/list-documents"},{"openapi":"post /api/v1/documents/search/pages","title":"Search Document Pages","href":"/api-reference/documents/search-document-pages-1"},{"openapi":"get /api/v1/documents/external/{external_id}","title":"Get Document By External Id","href":"/api-reference/documents/get-document-by-external-id"},{"openapi":"delete /api/v1/documents/external/{external_id}","title":"Delete Document By External Id","href":"/api-reference/documents/delete-document-by-external-id"},{"openapi":"get /api/v1/documents/internal/{document_id}","title":"Get Document By Id","href":"/api-reference/documents/get-document-by-id"},{"openapi":"delete /api/v1/documents/internal/{document_id}","title":"Delete Document By Id","href":"/api-reference/documents/delete-document-by-id"},{"openapi":"get /api/v1/documents/task/{task_identifier}","title":"Get Document By Task Id","href":"/api-reference/documents/get-document-by-task-id"},{"openapi":"post /api/v1/documents/delete/preview","title":"Preview Delete By Metadata","href":"/api-reference/documents/preview-delete-by-metadata"},{"openapi":"get /api/v1/documents/delete/external/{external_id}/preview","title":"Preview Delete By External Id","href":"/api-reference/documents/preview-delete-by-external-id"},{"openapi":"post /api/v1/documents/delete","title":"Delete Documents By Metadata","href":"/api-reference/documents/delete-documents-by-metadata"},{"openapi":"patch /api/v1/documents/internal/{document_id}/metadata","title":"Update Document By Id","href":"/api-reference/documents/update-document-by-id"},{"openapi":"patch /api/v1/documents/external/{external_id}/metadata","title":"Update Document By External Id","href":"/api-reference/documents/update-document-by-external-id"},{"openapi":"get /api/v1/documents/content/pages/{page_id}","title":"Get page content","href":"/api-reference/documents/get-page-content"}]},{"group":"Extractions","pages":[{"openapi":"post /api/v1/extractions/run","title":"Run Extraction From File","href":"/api-reference/extractions/run-extraction-from-file"},{"openapi":"post /api/v1/extractions/run/url","title":"Run Extraction From Url","href":"/api-reference/extractions/run-extraction-from-url"},{"openapi":"get /api/v1/extractions/results/internal/{result_id}","title":"Get Extraction Result By Id","href":"/api-reference/extractions/get-extraction-result-by-id"},{"openapi":"get /api/v1/extractions/results/task/{task_identifier}","title":"Get Extraction Result By Task Id","href":"/api-reference/extractions/get-extraction-result-by-task-id"}]},{"group":"Tasks","pages":[{"openapi":"get /api/v1/tasks/status/{task_identifier}","title":"Get Task Status","href":"/api-reference/tasks/get-task-status"}]}]}]},"basePath":"","title":"FieldwiseAI - API Documentation","buildId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","deploymentId":"dpl_8LJbrAiZvr1K98WQNZXCyY5AvT34","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-i2a3QZ8E.js","utils-ChLwp8m0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DRktVTDc.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CA2pEs4T.js","snippetPresets-ClQ6XrKD.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ct_Lv36y.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Cn2PYw9e.js","shallow-rkyymjXQ.js","getApiPlaygroundDisplay-BB9vkXtE.js","CodeSnippet-Bm5RU7m1.js","CodeSnippets-BgU9Deuz.js","Page-BUDYNlhG.js","getPastedJson-BD-6NNum.js","icon-8Z6tud2e.js","MethodPill-Tuzr4g3V.js","DuplicateIcon-0ceWFYhN.js","createIcon-FBXow_ST.js","DynamicMarkdown-CD8713Yy.js","SectionHeading-7zgzQbH-.js","axios-vUo_bRtp.js","Markdown-D7Ofw1oz.js","clsx-eKJ4rcii.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CwjSCXIK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-9EK5IAXV.js"]}