Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.
GET
/
contents
/
v1
/
documents
/
{content_id}
/
annotated
Get annotated document
curl --request GET \ --url https://api.bigdata.com/contents/v1/documents/{content_id}/annotated \ --header 'X-API-KEY: <api-key>'
Content ID of the document (32-character uppercase hex string).
Pattern: ^[A-F0-9]{32}$
Example:
"E0618D0E9D3A960C1731A620EDE56B5C"
Response
The endpoint returns an object containing a pre-signed url. Perform a GET request on that URL to retrieve the annotated document in JSON format. The URL is valid for 24 hours; request a new one if needed.
Pre-signed URL that provides temporary access to the annotated document in JSON format. When you access the URL, you receive the complete document with structure: document (metadata), content (title and body blocks), profiling (processor timestamps), and analytics (document-level metrics, events array, entities array).
Returned by URL - Document-level analytics, events array, and entities array.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bigdata.com API developer docs","colors":{"primary":"#4CA7F9","light":"#4CA7F9","dark":"#4CA7F9"},"logo":{"light":"https://mintcdn.com/ravenpackinternational/O1z6qnY-XMCwjEFX/logo/bigdata_logo_v3c_dark.svg?fit=max\u0026auto=format\u0026n=O1z6qnY-XMCwjEFX\u0026q=85\u0026s=946489fc058b9cc72700f20c4a07234d","dark":"https://mintcdn.com/ravenpackinternational/O1z6qnY-XMCwjEFX/logo/bigdata_logo_v3c_light.svg?fit=max\u0026auto=format\u0026n=O1z6qnY-XMCwjEFX\u0026q=85\u0026s=e100148ed224aa533563ab5a82c155c6"},"favicon":"https://mintcdn.com/ravenpackinternational/oXZ2k4-F2a4nJaoe/favicon-32x32.png?fit=max\u0026auto=format\u0026n=oXZ2k4-F2a4nJaoe\u0026q=85\u0026s=287ed1df194928ab25af5ed2186e58d0","appearance":{"default":"dark"},"background":{"color":{"dark":"#121212"}},"navbar":{"links":[{"href":"https://app.bigdata.com/signup?utm_source=docs","label":"Sign Up"}],"primary":{"type":"button","label":"Developer Platform","href":"https://platform.bigdata.com/"}},"footer":{"socials":{"x":"https://x.com/bigdatadotcom","linkedin":"https://www.linkedin.com/company/bigdata","instagram":"https://www.instagram.com/bigdatadotcom"}},"seo":{"metatags":{"canonical":"https://docs.bigdata.com"}},"integrations":{"mixpanel":{"projectToken":"0f78753900544f455b1d78b4b5c4aac4"}},"contextual":{"options":["download-spec"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ravenpackinternational","hasAudioNarration":false,"actualSubdomain":"ravenpackinternational","customDomains":["docs.bigdata.com"],"gitSource":{"type":"github","owner":"ravenpack","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aec3d9da93f970ede8c7255","collectionId":"c63b0ea0-4ab8-45ef-9ff0-e43870f9b29a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aec3d9da93f970ede8c7255"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aedb84cb5c73ad147ee5f97","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API","count":117},{"language":"default","tag":"MCP","count":47},{"language":"default","tag":"Research Service","count":34},{"language":"default","tag":"Structured Data","count":33},{"language":"default","tag":"Getting Started","count":31},{"language":"default","tag":"How to guides","count":31},{"language":"default","tag":"Knowledge Graph","count":30},{"language":"default","tag":"Cookbooks","count":29},{"language":"default","tag":"Tools","count":27},{"language":"default","tag":"Search Service","count":24}]},"assistantConfig":{},"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":"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":[{"filePath":"style.css","content":"@import url('./widgets/widgets.css');html{scroll-behavior:smooth}.center-container{display:flex;justify-content:center;align-items:center}.medium_size{height:200px}.hero-bg{background-image:url(\"https://mintlify.s3.us-west-1.amazonaws.com/ravenpackinternational/images/hero-bg-enhanced.jpg\"),\n url(\"https://mintlify.s3.us-west-1.amazonaws.com/ravenpackinternational/images/hero-bg.jpg\");background-size:cover;background-position:center;background-repeat:no-repeat}.hero-bg-content{color:#111!important}.hero-logo{filter:none!important}.text-playground-input{color:#171a1b!important}.dark .text-playground-input{color:#ffffff!important}.text-playground-input option{color:#171a1b!important;background-color:#ffffff!important}.dark .text-playground-input option{color:#ffffff!important;background-color:#171a1b!important}#navbar img.nav-logo{height:24px}@media (max-width: 600px){#navbar img.nav-logo{height:20px}}.author-avatar-image{width:100%;height:100%;display:block;object-fit:cover;margin:0}.dark img[src$=\"/images/logos/grok.svg\"],.dark img[src$=\"/images/logos/chatgpt.svg\"]{filter:invert(1)}"},{"filePath":"widgets/widgets.css","content":""}],"page":{"pagePath":"api-reference/documents/get-annotated-document","slug":"/api-reference/documents/get-annotated-document","pageMetadata":{"title":"Get annotated document","description":"Returns a time-limited pre-signed URL to download **private** document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents/{content_id}/annotated","href":"/api-reference/documents/get-annotated-document","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a time-limited pre-signed URL to download \", _jsx(_components.strong, {\n children: \"private\"\n }), \" document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get annotated document","description":"Returns a time-limited pre-signed URL to download **private** document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents/{content_id}/annotated","href":"/api-reference/documents/get-annotated-document","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ravenpackinternational/e8fac7367cdeecdc/script.js"],"openApiReferenceData":{"operation":{"tags":["Documents"],"summary":"Get annotated document","description":"Returns a time-limited pre-signed URL to download **private** document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.","parameters":["48952718-38a1-45be-b1af-c94754eb8750"],"responses":{"200":"9802f95e-8faf-4670-a060-bede806f69e8","401":"978ba176-0795-4524-b2ba-84b26cd794bb","403":"1b245b01-5a86-4626-8dfa-3d43dd5e04ed","404":"331bf54a-a3f0-4455-bcd1-6d417d10d619"},"method":"get","type":"path","servers":["6b342703-d757-4833-ab8a-55fa07555d5e"],"security":["093b0d6f-2288-4ee7-acd2-a1e98a8c1779"],"path":"/contents/v1/documents/{content_id}/annotated","baseUrlOptions":["https://api.bigdata.com/"],"title":"Get annotated document","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"48952718-38a1-45be-b1af-c94754eb8750":{"name":"content_id","in":"path","required":true,"description":"Content ID of the document (32-character uppercase hex string).","schema":{"type":"string","pattern":"^[A-F0-9]{32}$","example":"E0618D0E9D3A960C1731A620EDE56B5C","isRequired":true,"description":"Content ID of the document (32-character uppercase hex string).","uniqueKey":"","typeLabel":"string"}}},"responses":{"9802f95e-8faf-4670-a060-bede806f69e8":{"description":"The endpoint returns an object containing a pre-signed url. Perform a GET request on that URL to retrieve the annotated document in JSON format. The URL is valid for 24 hours; request a new one if needed.","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Pre-signed URL that provides temporary access to the annotated document in JSON format. When you access the URL, you receive the complete document with structure: document (metadata), content (title and body blocks), profiling (processor timestamps), and analytics (document-level metrics, events array, entities array).","example":"https://content.bigdata.com/classified-documents/E0618D0E9D3A960C1731A620EDE56B5C.json?Expires=1770304237\u0026Signature=abc123...\u0026Key-Pair-Id=K34UQS1JQ2RLGM","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"document":{"type":"object","description":"**Returned by URL** - Document metadata including source information, timestamps, and details.","properties":{"rp_document_id":{"type":"string","description":"Internal document identifier","example":"E0618D0E9D3A960C1731A620EDE56B5C","isRequired":true,"uniqueKey":"document.rp_document_id","typeLabel":"string"},"source":{"type":"object","description":"Information about the document source.","properties":{"rp_source_id":{"type":"string","description":"Identifier of the source system","example":"DA0F7F","isRequired":true,"uniqueKey":"document.source.rp_source_id","typeLabel":"string"},"name":{"type":"string","description":"Source display name","example":"User Uploaded Content","isRequired":true,"uniqueKey":"document.source.name","typeLabel":"string"},"rank":{"type":"integer","description":"Ranking classification of the source","example":1,"isRequired":true,"uniqueKey":"document.source.rank","typeLabel":"integer"}},"required":["rp_source_id","name","rank"],"isRequired":true,"uniqueKey":"document.source","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"Document timestamp in ISO format","example":"2026-02-03T08:43:02Z","isRequired":true,"uniqueKey":"document.timestamp","typeLabel":"string\u003cdate-time>"},"metadata":{"type":"object","description":"Additional document metadata.","properties":{"file_name":{"type":"string","description":"Original file name of the uploaded document","example":"Weekly summary report.eml","uniqueKey":"document.metadata.file_name","typeLabel":"string"},"content_type":{"type":"string","description":"MIME type of the document","example":"message/rfc822","uniqueKey":"document.metadata.content_type","typeLabel":"string"},"user_id":{"type":"string","description":"ID of the user who uploaded the document","example":"user_id_001","uniqueKey":"document.metadata.user_id","typeLabel":"string"},"org_id":{"type":"string","description":"ID of the organization","example":"org_id_001","uniqueKey":"document.metadata.org_id","typeLabel":"string"}},"isRequired":true,"uniqueKey":"document.metadata","typeLabel":"object"}},"required":["rp_document_id","source","timestamp","metadata"],"uniqueKey":"document","typeLabel":"object"},"content":{"type":"object","description":"**Returned by URL** - Document content including title, body blocks, entities, and sentences.","properties":{"title":{"type":"object","description":"Title content block representing the document title.","properties":{"text":{"type":"string","description":"Extracted document title","example":"Weekly summary report","isRequired":true,"uniqueKey":"content.title.text","typeLabel":"string"},"sentences":{"type":"array","description":"Sentence segmentation with sentiment analysis","items":{"type":"object","description":"Sentence segmentation information with sentiment analysis.","properties":{"start":{"type":"integer","description":"Start character index of the sentence","example":0,"isRequired":true,"uniqueKey":"content.title.sentences.items.[INDEX].start","typeLabel":"integer"},"end":{"type":"integer","description":"End character index of the sentence","example":67,"isRequired":true,"uniqueKey":"content.title.sentences.items.[INDEX].end","typeLabel":"integer"},"sentiment":{"type":"string","description":"Sentiment score from -1.00 (negative) to 1.00 (positive)","example":"0.01","uniqueKey":"content.title.sentences.items.[INDEX].sentiment","typeLabel":"string"},"sentiment_confidence":{"type":"string","description":"Confidence score for sentiment analysis (0.00 to 1.00)","example":"0.94","uniqueKey":"content.title.sentences.items.[INDEX].sentiment_confidence","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"content.title.sentences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.title.sentences","typeLabel":"object[]"},"entities":{"type":"array","description":"Entities detected in the title text","items":{"type":"object","description":"An entity detected within the text.","properties":{"rp_entity_id":{"type":"string","description":"Bigdata.com unique entity identifier","example":"4A1B9C","isRequired":true,"uniqueKey":"content.title.entities.items.[INDEX].rp_entity_id","typeLabel":"string"},"start":{"type":"integer","description":"Start character index of the entity","example":4,"isRequired":true,"uniqueKey":"content.title.entities.items.[INDEX].start","typeLabel":"integer"},"end":{"type":"integer","description":"End character index of the entity","example":19,"isRequired":true,"uniqueKey":"content.title.entities.items.[INDEX].end","typeLabel":"integer"},"name":{"type":"string","description":"Display name of the entity","example":"Federal Reserve","uniqueKey":"content.title.entities.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Entity type classification","enum":["COMPANY","PERSON","PLACE","PRODUCT","ORGANIZATION","ETF"],"example":"ORGANIZATION","uniqueKey":"content.title.entities.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["rp_entity_id","start","end"],"uniqueKey":"content.title.entities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.title.entities","typeLabel":"object[]"}},"required":["text"],"isRequired":true,"uniqueKey":"content.title","typeLabel":"object"},"body":{"type":"array","description":"Array of content blocks extracted from the document","items":{"type":"object","description":"A content block (TEXT, TABLE, LIST, etc.)","properties":{"type":{"type":"string","description":"Type of content block","enum":["TEXT","TABLE","LIST_ORDERED","LIST_UNORDERED","HEADING","FOOTER"],"example":"TEXT","isRequired":true,"uniqueKey":"content.body.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Text content (for TEXT blocks)","example":"The Federal Reserve will meet this week to discuss interest rates.","uniqueKey":"content.body.items.[INDEX].text","typeLabel":"string"},"normalized_coordinates":{"type":"array","description":"Normalized coordinates for the block position","items":{"type":"number","uniqueKey":"content.body.items.[INDEX].normalized_coordinates.items.[INDEX]","typeLabel":"number"},"uniqueKey":"content.body.items.[INDEX].normalized_coordinates","typeLabel":"number[]"},"sentences":{"type":"array","description":"Sentence segmentation with sentiment","items":{"type":"object","description":"Sentence segmentation information with sentiment analysis.","properties":{"start":{"type":"integer","description":"Start character index of the sentence","example":0,"isRequired":true,"uniqueKey":"content.body.items.[INDEX].sentences.items.[INDEX].start","typeLabel":"integer"},"end":{"type":"integer","description":"End character index of the sentence","example":67,"isRequired":true,"uniqueKey":"content.body.items.[INDEX].sentences.items.[INDEX].end","typeLabel":"integer"},"sentiment":{"type":"string","description":"Sentiment score from -1.00 (negative) to 1.00 (positive)","example":"0.01","uniqueKey":"content.body.items.[INDEX].sentences.items.[INDEX].sentiment","typeLabel":"string"},"sentiment_confidence":{"type":"string","description":"Confidence score for sentiment analysis (0.00 to 1.00)","example":"0.94","uniqueKey":"content.body.items.[INDEX].sentences.items.[INDEX].sentiment_confidence","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"content.body.items.[INDEX].sentences.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.body.items.[INDEX].sentences","typeLabel":"object[]"},"entities":{"type":"array","description":"Entities detected in the text","items":{"type":"object","description":"An entity detected within the text.","properties":{"rp_entity_id":{"type":"string","description":"Bigdata.com unique entity identifier","example":"4A1B9C","isRequired":true,"uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX].rp_entity_id","typeLabel":"string"},"start":{"type":"integer","description":"Start character index of the entity","example":4,"isRequired":true,"uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX].start","typeLabel":"integer"},"end":{"type":"integer","description":"End character index of the entity","example":19,"isRequired":true,"uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX].end","typeLabel":"integer"},"name":{"type":"string","description":"Display name of the entity","example":"Federal Reserve","uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","description":"Entity type classification","enum":["COMPANY","PERSON","PLACE","PRODUCT","ORGANIZATION","ETF"],"example":"ORGANIZATION","uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"required":["rp_entity_id","start","end"],"uniqueKey":"content.body.items.[INDEX].entities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.body.items.[INDEX].entities","typeLabel":"object[]"},"rows":{"type":"array","description":"Table rows (for TABLE blocks)","items":{"type":"object","uniqueKey":"content.body.items.[INDEX].rows.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.body.items.[INDEX].rows","typeLabel":"object[]"},"entries":{"type":"array","description":"List entries (for LIST blocks)","items":{"type":"object","uniqueKey":"content.body.items.[INDEX].entries.items.[INDEX]","typeLabel":"object"},"uniqueKey":"content.body.items.[INDEX].entries","typeLabel":"object[]"}},"required":["type"],"uniqueKey":"content.body.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.body","typeLabel":"object[]"}},"required":["title","body"],"uniqueKey":"content","typeLabel":"object"},"profiling":{"description":"**Returned by URL** - Processor timestamps for collection.","type":"object","properties":{"collection":{"type":"object","properties":{"processor_in_timestamp_utc":{"type":"string","example":"2025-10-22 22:57:42.170","uniqueKey":"profiling.collection.processor_in_timestamp_utc","typeLabel":"string"},"processor_out_timestamp_utc":{"type":"string","example":"2025-10-22 22:57:42.170","uniqueKey":"profiling.collection.processor_out_timestamp_utc","typeLabel":"string"}},"uniqueKey":"profiling.collection","typeLabel":"object"}},"uniqueKey":"profiling","typeLabel":"object"},"analytics":{"description":"**Returned by URL** - Document-level analytics, events array, and entities array.","type":"object","properties":{"document":{"type":"object","description":"Document-level analytics (analytics_version, document_type, document_sentiment, etc.).","uniqueKey":"analytics.document","typeLabel":"object"},"events":{"type":"array","description":"Detected events with topic, type, relevance, roles, and sentiment.","uniqueKey":"analytics.events","typeLabel":"array"},"entities":{"type":"array","description":"Detected entities with entity_type, entity_name, relevance, and sentiment.","uniqueKey":"analytics.entities","typeLabel":"array"}},"uniqueKey":"analytics","typeLabel":"object"}},"required":["url"],"uniqueKey":"","typeLabel":"object"},"examples":{"api_response":{"title":"api_response","description":"The endpoint returns a pre-signed URL.","value":{"url":"https://content.bigdata.com/classified-documents/E0618D0E9D3A960C1731A620EDE56B5C.json?Expires=1770304237\u0026Signature=abc123...\u0026Key-Pair-Id=K34UQS1JQ2RLGM"}},"document_from_url":{"title":"document_from_url","description":"When you access the URL, you receive the complete document in JSON format with the structure: document (metadata), content (title and body blocks) and analytics (document-level metrics, events array, entities array). For transcript-style documents, the Fetch document OpenAPI example document_from_url describes normalized transcript metadata (participants, reporting fields, timestamps_utc) and offset conventions.","value":{"document":{"rp_document_id":"E0618D0E9D3A960C1731A620EDE56B5C","source":{"rp_source_id":"DA0F7F","name":"User Uploaded Content","rank":1},"timestamp":"2026-02-03T08:43:02Z","metadata":{"file_name":"Weekly summary report.eml","content_type":"message/rfc822"}},"content":{"title":{"text":"Tesla Inc: Q1 2025 Earnings Call","sentences":[{"start":0,"end":31,"sentiment":"0.00","sentiment_confidence":"1.00"}],"entities":[{"rp_entity_id":"DD3BB1","start":0,"end":9}]},"body":[{"type":"TEXT","text":"The first quarter results were announced today.","normalized_coordinates":[],"sentences":[{"start":0,"end":46,"sentiment":"0.01","sentiment_confidence":"0.94"}],"entities":[{"rp_entity_id":"DD3BB1","start":4,"end":17}]},{"type":"TABLE","rows":[{"cells":[{"type":"CELL_HEADER","content":[{"text":"Quarter"}]},{"type":"CELL_VALUE","content":[{"text":"Q1 2025"}]}]}]},{"type":"LIST_UNORDERED","entries":[{"key":"•","content":[{"text":"Unordered dummy point"}]}]},{"type":"LIST_ORDERED","entries":[{"key":"1","content":[{"text":"Ordered dummy point"}]}]}]},"profiling":{"collection":{"processor_in_timestamp_utc":"2025-10-22 22:57:42.170","processor_out_timestamp_utc":"2025-10-22 22:57:42.170"}},"analytics":{"document":{"analytics_version":"2.0","analytics_revision_number":0,"document_type":"TRANSCRIPT-RAW","document_record_count":257,"title_similarity_key":"0A4AD1E8BF251E1A90E3B2376E471E07","document_sentiment":0.21,"document_sentiment_confidence":0.65,"composite_sentiment_score":0.04,"sentiment_impact_projection":-0.2,"stock_tone_sentiment":0,"earnings_tone_sentiment":0,"commentary_sentiment":1,"mergers_acquisitions_sentiment":0,"corporate_actions_sentiment":0,"earnings_release_sentiment":0,"product_key":"EDGE","realtime":"Y"},"events":[{"event_similarity_key":"E7913FBE641945AC0670EEF684B6D8E0","topic":"business","group":"products-services","type":"business-contract","event_relevance":77,"roles":[{"rp_entity_id":"DD3BB1","category":"business-contract","fact_level":"fact","document_record_index":6,"match_type":"TEMPLATE","event_sentiment":0.49,"event_risk":0.24,"sustainability_sentiment":0.24,"credit_sentiment":0.25,"interest_rate_sentiment":0,"event_detection_distance":0,"event_text":"Tesla: we entered into new contracts","rp_event_detected_entity_id":"DD3BB1","event_detected_entity_name":"Tesla Inc."}]}],"entities":[{"rp_entity_id":"4A6F00","entity_type":"COMP","entity_name":"Alphabet Inc.","country_code":"US","document_record_index":217,"entity_hierarchy_level":1,"entity_detection_type":"direct","entity_detection_distance":0,"entity_relevance":26,"entity_sentiment":0.25,"entity_sentiment_confidence":0.05,"entity_text_sentiment":0.25,"entity_text_sent_confidence":0.05,"analyst_ratings_sentiment":0,"multi_stock_sentiment":0}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"978ba176-0795-4524-b2ba-84b26cd794bb":{"description":"Unauthorized - Invalid or missing API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"1b245b01-5a86-4626-8dfa-3d43dd5e04ed":{"description":"You do not have permission to access this document.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"331bf54a-a3f0-4455-bcd1-6d417d10d619":{"description":"No document found with this content_id.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"093b0d6f-2288-4ee7-acd2-a1e98a8c1779":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"6b342703-d757-4833-ab8a-55fa07555d5e":{"url":"https://api.bigdata.com/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","description":"Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-rest/openapi/openapi_content_data.json"},"subdomain":"ravenpackinternational","siteName":"Bigdata.com API developer docs","title":"Get annotated document - Bigdata.com API developer docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T11:33:45.227Z","originalFileLocation":"api-reference/documents/get-annotated-document.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=\"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=\"Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bigdata.com API developer 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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_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/ravenpackinternational/0ZQJThiL-hYHaY_C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get annotated document - Bigdata.com API developer docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bigdata.com API developer docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bigdata.com/api-reference/documents/get-annotated-document\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ravenpackinternational.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Get+annotated+document\u0026amp;description=Returns+a+time-limited+pre-signed+URL+to+download+**private**+document+content+in+annotated+%28structured%29+JSON+format.+Use+this+only+for+documents+you+ingested+v\u0026amp;theme=0bfd5283ab20b98a8d106eeb\u0026amp;signature=d87cc4ef1d8bba5cafa1e705f62b4044682f9b7b8b7661cba7ce3f2657ac331a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get annotated document - Bigdata.com API developer docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ravenpackinternational.mintlify.site/_mintlify/api/og/v2?division=Documents\u0026amp;title=Get+annotated+document\u0026amp;description=Returns+a+time-limited+pre-signed+URL+to+download+**private**+document+content+in+annotated+%28structured%29+JSON+format.+Use+this+only+for+documents+you+ingested+v\u0026amp;theme=0bfd5283ab20b98a8d106eeb\u0026amp;signature=d87cc4ef1d8bba5cafa1e705f62b4044682f9b7b8b7661cba7ce3f2657ac331a\">\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/ravenpackinternational/0ZQJThiL-hYHaY_C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bigdata.com API developer docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4CA7F9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bigdata.com/api-reference/documents/get-annotated-document\">\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/get-annotated-document.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bigdata.com/#organization\",\"name\":\"Bigdata.com API developer docs\",\"url\":\"https://docs.bigdata.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ravenpackinternational/O1z6qnY-XMCwjEFX/logo/bigdata_logo_v3c_dark.svg?fit=max\u0026auto=format\u0026n=O1z6qnY-XMCwjEFX\u0026q=85\u0026s=946489fc058b9cc72700f20c4a07234d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bigdata.com#website\",\"name\":\"Bigdata.com API developer docs\",\"url\":\"https://docs.bigdata.com\",\"publisher\":{\"@id\":\"https://docs.bigdata.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document#webpage\",\"url\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document\",\"name\":\"Get annotated document\",\"description\":\"Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\",\"dateModified\":\"2026-10-14T11:33:45.227Z\",\"isPartOf\":{\"@id\":\"https://docs.bigdata.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Content\",\"item\":\"https://docs.bigdata.com/api-rest/content_introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documents\",\"item\":\"https://docs.bigdata.com/api-reference/documents/enrich-document\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get annotated document\",\"item\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document#apireference\",\"headline\":\"Get annotated document\",\"name\":\"Get annotated document\",\"description\":\"Returns a time-limited pre-signed URL to download private document content in annotated (structured) JSON format. Use this only for documents you ingested via the Content API (connectors or direct upload). When you GET the URL, the response contains document content, metadata and annotations. The URL expires after 24 hours; request a new one if needed.\",\"url\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bigdata.com/api-reference/documents/get-annotated-document#webpage\"},\"dateModified\":\"2026-10-14T11:33:45.227Z\",\"publisher\":{\"@id\":\"https://docs.bigdata.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bigdata.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bigdata.com API developer docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bigdata.com API developer docs","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/getting-started/introduction"}]},{"tab":"FAQ","pages":[{"title":"FAQ","href":"/faq/privacy_questions"}]},{"tab":"How to guides","pages":[{"title":"How to guides","href":"/how-to-guides/introduction"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/use-cases/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk-reference/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp-reference/introduction"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills-reference/introduction"}]},{"tab":"API","pages":[{"group":"API","pages":[{"title":"Introduction to Bigdata APIs","sidebarTitle":"Introduction","href":"/api-rest/introduction"},{"title":"Domains to whitelist","href":"/api-rest/bigdata_domains"},{"title":"Authentication","href":"/api-rest/authentication"},{"group":"Best practices","pages":[{"title":"Resolve companies","href":"/api-rest/best-practices/resolve_companies"},{"title":"Company news coverage","sidebarTitle":"News Coverage","href":"/api-rest/best-practices/company_news_coverage"}]},{"title":"Rate limits","href":"/api-rest/rate_limits"},{"title":"Bigdata CLI","sidebarTitle":"Bigdata CLI","href":"/cli-reference/introduction"}]},{"group":"Knowledge Graph","pages":[{"group":"Companies","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/companies","href":"/api-reference/companies/find-by-details"},{"title":"Get by ISIN","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/companies/isin","href":"/api-reference/companies/get-by-isin"},{"title":"Get by CUSIP","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/companies/cusip","href":"/api-reference/companies/get-by-cusip"},{"title":"Get by SEDOL","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/companies/sedol","href":"/api-reference/companies/get-by-sedol"},{"title":"Get by Listing","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/companies/listing","href":"/api-reference/companies/get-by-listing"},{"title":"Get sectors","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json get /v1/knowledge-graph/companies/sectors","href":"/api-reference/companies/get-sectors"},{"title":"Get Subsidiaries","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/subsidiaries/query","href":"/api-reference/companies/get-subsidiaries"}]},{"group":"ETFs","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/etfs","href":"/api-reference/etfs/find-by-details"}]},{"group":"Sources","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/sources","href":"/api-reference/sources/find-by-details"}]},{"group":"Organizations","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/organizations","href":"/api-reference/organizations/find-by-details"}]},{"group":"People","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/people","href":"/api-reference/people/find-by-details"}]},{"group":"Places","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/places","href":"/api-reference/places/find-by-details"}]},{"group":"Products","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/products","href":"/api-reference/products/find-by-details"}]},{"group":"Concepts","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/concepts","href":"/api-reference/concepts/find-by-details"}]},{"group":"Topics","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/topics","href":"/api-reference/topics/find-by-details"}]},{"group":"Funds","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/funds","href":"/api-reference/funds/find-by-details"}]},{"group":"Positions","pages":[{"title":"Find by details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/positions","href":"/api-reference/positions/find-by-details"}]},{"group":"Filter values","pages":[{"title":"Get filter values","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json get /v1/knowledge-graph/{category}/values/{filter}","href":"/api-reference/filter-values/get-filter-values"}]},{"group":"Entities","pages":[{"title":"Get Entities by ID","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_knowledge_graph.json post /v1/knowledge-graph/entities/id","href":"/api-reference/entities/get-entities-by-id"}]}]},{"group":"Search Service","pages":[{"group":"Search","pages":[{"title":"Search documents","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search","href":"/api-reference/search/search-documents"},{"title":"Search volume","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search/volume","href":"/api-reference/search/search-volume"},{"title":"Search watchlist","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search/watchlist","href":"/api-reference/search/search-watchlist"},{"title":"Fetch document","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json get /v1/documents/{document_id}","href":"/api-reference/search/fetch-document"}]},{"group":"Batch Search","pages":[{"title":"Create a Batch Job","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search/batches","href":"/api-reference/batch-search/create-a-batch-job"},{"title":"Upload Your Input File","deprecated":null,"version":null,"playground":"none","openapi":"/api-rest/openapi/openapi_search_service.json put /s3_upload_placeholder","href":"/api-reference/batch-search/upload-your-input-file"},{"title":"Get Batch Job Info","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json get /v1/search/batches/{batch_id}","href":"/api-reference/batch-search/get-batch-job-info"}]},{"group":"Co-mentions","pages":[{"title":"Connected Entities","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search/co-mentions/entities","href":"/api-reference/co-mentions/connected-entities"},{"title":"Connected Topics","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_service.json post /v1/search/co-mentions/topics","href":"/api-reference/co-mentions/connected-topics"}]}]},{"group":"Monitors","tag":"Coming soon","pages":[{"group":"Manage","pages":[{"title":"Create a monitor","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json post /v1/search-monitoring/monitors","href":"/api-reference/monitors/create-a-monitor"},{"title":"List monitors","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors","href":"/api-reference/monitors/list-monitors"},{"title":"Get monitor details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors/{monitor_id}","href":"/api-reference/monitors/get-monitor-details"},{"title":"Update a monitor","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json patch /v1/search-monitoring/monitors/{monitor_id}","href":"/api-reference/monitors/update-a-monitor"},{"title":"Delete a monitor","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json delete /v1/search-monitoring/monitors/{monitor_id}","href":"/api-reference/monitors/delete-a-monitor"}]},{"group":"Test","pages":[{"title":"Simulate a monitor","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json post /v1/search-monitoring/monitors/{monitor_id}/simulate","href":"/api-reference/monitors/simulate-a-monitor"}]},{"group":"Runs","pages":[{"title":"List monitor runs","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors/{monitor_id}/runs","href":"/api-reference/monitors/list-monitor-runs"},{"title":"Get run details","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_search_monitoring.json get /v1/search-monitoring/monitors/{monitor_id}/runs/{run_id}","href":"/api-reference/monitors/get-run-details"}]}]},{"group":"Research Service","pages":[{"title":"Workflows API","sidebarTitle":"Introduction","href":"/api-rest/workflows/introduction"},{"group":"Research Agent","pages":[{"title":"Research Agent","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_research_agent.json post /v1/research-agent","href":"/api-reference/research-agent/research-agent"}]},{"group":"Workflows","pages":[{"title":"Execute Workflow","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json post /v1/workflow/execute","href":"/api-reference/workflows/execute-workflow"},{"title":"Submit Workflow","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json post /v1/workflow/execute/async","href":"/api-reference/workflows/submit-workflow"},{"title":"Stream Workflow Events","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/execute/async/{execution_id}/stream","href":"/api-reference/workflows/stream-workflow-events"},{"title":"Cancel Workflow","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json post /v1/workflow/execute/async/{execution_id}/cancel","href":"/api-reference/workflows/cancel-workflow"},{"title":"List Executions","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/executions","href":"/api-reference/workflow-executions/list-executions"},{"title":"Get Execution","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/executions/{execution_id}","href":"/api-reference/workflow-executions/get-execution"},{"title":"Delete Execution","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json delete /v1/workflow/executions/{execution_id}","href":"/api-reference/workflow-executions/delete-execution"},{"title":"List Templates","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/templates","href":"/api-reference/workflow-templates/list-templates"},{"title":"Create Template","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json post /v1/workflow/templates","href":"/api-reference/workflow-templates/create-template"},{"title":"Get Template","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/templates/{template_id}","href":"/api-reference/workflow-templates/get-template"},{"title":"Update Template","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json put /v1/workflow/templates/{template_id}","href":"/api-reference/workflow-templates/update-template"},{"title":"Delete Template","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json delete /v1/workflow/templates/{template_id}","href":"/api-reference/workflow-templates/delete-template"},{"title":"List Community Templates","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json get /v1/workflow/templates/community","href":"/api-reference/workflow-templates/list-community-templates"},{"title":"Clone Template","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_workflows.json post /v1/workflow/templates/{template_id}/clone","href":"/api-reference/workflow-templates/clone-template"}]}]},{"group":"Content","pages":[{"title":"Introduction","href":"/api-rest/content_introduction"},{"group":"Connectors","pages":[{"title":"Create connector","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json post /contents/v1/connectors","href":"/api-reference/connectors/create-connector"},{"title":"List connectors","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/connectors","href":"/api-reference/connectors/list-connectors"},{"title":"Get connector by ID","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/connectors/{connector_id}","href":"/api-reference/connectors/get-connector-by-id"},{"title":"Update connector by ID","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json put /contents/v1/connectors/{connector_id}","href":"/api-reference/connectors/update-connector-by-id"},{"title":"Trigger connector sync","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json post /contents/v1/connectors/{connector_id}/sync","href":"/api-reference/connectors/trigger-connector-sync"},{"title":"Delete connector by ID","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json delete /contents/v1/connectors/{connector_id}","href":"/api-reference/connectors/delete-connector-by-id"}]},{"group":"Documents","pages":[{"title":"Enrich document","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json post /contents/v1/documents","href":"/api-reference/documents/enrich-document"},{"title":"List documents","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents","href":"/api-reference/documents/list-documents"},{"title":"Get document metadata","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents/{content_id}","href":"/api-reference/documents/get-document-metadata"},{"title":"Update document metadata","description":"Partially update a document's metadata. Send only the fields you want to change.\n\n- **`tags`**: Array of **tag IDs** (UUIDs) to assign to the document. This replaces the document's current tag set, so you can add or remove tags by including the full list you want applied. Each ID must refer to an existing tag (use **POST** `/contents/v1/tags` to create one, or **GET** `/contents/v1/tags` to list IDs). If any ID is invalid, the API returns `400` with error code `INVALID_TAGS_ERROR`.\n- **`share_with_org`**: When `true`, the document is available to all members of your organization. When `false`, only you can access it.","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json patch /contents/v1/documents/{content_id}","href":"/api-reference/documents/update-document-metadata"},{"title":"Get annotated document","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents/{content_id}/annotated","href":"/api-reference/documents/get-annotated-document"},{"title":"Get original document","description":"Returns a time-limited pre-signed URL to download the **private** document's original file as uploaded (e.g. .eml, .pdf). When you GET the URL, the response is the raw file with appropriate Content-Type and Content-Disposition. Use this when you need the native format rather than the annotated JSON. The URL expires after 24 hours; request a new one if needed.","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/documents/{content_id}/original","href":"/api-reference/documents/get-original-document"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json delete /contents/v1/documents/{content_id}","href":"/api-reference/documents/delete-document"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json get /contents/v1/tags","href":"/api-reference/tags/list-tags"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json post /contents/v1/tags","href":"/api-reference/tags/create-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_content_data.json delete /contents/v1/tags/{tag_id}","href":"/api-reference/tags/delete-tag"}]}]},{"group":"Structured Data","pages":[{"title":"Introduction","href":"/structured-data/introduction"},{"group":"Market Data","pages":[{"title":"Daily Prices","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/price/daily/query","href":"/api-reference/market-data/daily-prices"},{"title":"Intraday Prices","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/price/intraday/query","href":"/api-reference/market-data/intraday-prices"},{"title":"Aftermarket Prices","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/price/aftermarket/query","href":"/api-reference/market-data/aftermarket-prices"},{"title":"Dividends","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/dividends/query","href":"/api-reference/market-data/dividends"},{"title":"Price Changes","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/price/changes/query","href":"/api-reference/market-data/price-changes"},{"title":"Quote","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/quote/query","href":"/api-reference/market-data/quote"},{"title":"Entity Sentiment","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/entity-sentiment/","href":"/api-reference/market-data/entity-sentiment"}]},{"group":"Analyst Estimates","pages":[{"title":"Analyst Estimates","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/analyst-estimates/query","href":"/api-reference/analyst-estimates/analyst-estimates"},{"title":"Analyst Ratings","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/analyst-ratings/query","href":"/api-reference/analyst-estimates/analyst-ratings"},{"title":"Earnings Surprises","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/latest-surprise/query","href":"/api-reference/analyst-estimates/earnings-surprises"},{"title":"Target Price","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/price/target/query","href":"/api-reference/analyst-estimates/target-price"}]},{"group":"Financials \u0026 Ratios","pages":[{"title":"Balance Sheet","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/balance-sheet/query","href":"/api-reference/financials-\u0026-ratios/balance-sheet"},{"title":"Cash Flow Statement","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/cash-flow-statement/query","href":"/api-reference/financials-\u0026-ratios/cash-flow-statement"},{"title":"Company Ratios TTM","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/company-ratios-ttm/query","href":"/api-reference/financials-\u0026-ratios/company-ratios-ttm"},{"title":"Income Statement","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/income-statement/query","href":"/api-reference/financials-\u0026-ratios/income-statement"},{"title":"Key Metrics TTM","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/key-metrics-ttm/query","href":"/api-reference/financials-\u0026-ratios/key-metrics-ttm"},{"title":"Revenue Geographic Segments","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/company-revenue-geographic-segments/query","href":"/api-reference/financials-\u0026-ratios/revenue-geographic-segments"},{"title":"Revenue Product Segments","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/company-revenue-product-segments/query","href":"/api-reference/financials-\u0026-ratios/revenue-product-segments"}]},{"group":"Company \u0026 Events","pages":[{"title":"Company Profile","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/company-profile/query","href":"/api-reference/company-\u0026-events/company-profile"},{"title":"Stocks \u0026 Funds Screener","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/company-screener/query","href":"/api-reference/company-\u0026-events/stocks-\u0026-funds-screener"},{"title":"Events Calendar","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/events-calendar/query","href":"/api-reference/company-\u0026-events/events-calendar"},{"title":"ESG Scores","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/esg-performance-score/query","href":"/api-reference/company-\u0026-events/esg-scores"},{"title":"Economic Calendar","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/economic-calendar/query","href":"/api-reference/company-\u0026-events/economic-calendar"}]},{"group":"Fund Holdings","pages":[{"title":"Fund Holdings","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/holdings/funds/stocks/","href":"/api-reference/fund-holdings/fund-holdings"},{"title":"Stock Fund Holdings","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/holdings/stocks/funds","href":"/api-reference/fund-holdings/stock-fund-holdings"},{"title":"Fund Position Signals","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/holdings/funds/trends/","href":"/api-reference/fund-holdings/fund-position-signals"}]},{"group":"Private Markets","pages":[{"title":"Private Company Overview","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/private-companies/query","href":"/api-reference/private-markets/private-company-overview"},{"title":"Private Company Funding Rounds","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/funding-rounds/query","href":"/api-reference/private-markets/private-company-funding-rounds"},{"title":"Private Company People","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/private-company-people/query","href":"/api-reference/private-markets/private-company-people"}]},{"group":"Fixed Income","pages":[{"title":"Bonds by Issuer","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/fixed-income/corporate/issuer/query","href":"/api-reference/fixed-income/bonds-by-issuer"},{"title":"Bonds by ISIN","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/fixed-income/corporate/isin/query","href":"/api-reference/fixed-income/bonds-by-isin"},{"title":"Bond prices","deprecated":null,"version":null,"tag":"Beta","openapi":"/api-rest/openapi/openapi_structured_data.json post /v1/fixed-income/corporate/prices/query","href":"/api-reference/fixed-income/bond-prices"}]}]},{"group":"Subscription","pages":[{"group":"Quotas","pages":[{"title":"Get Subscription Quotas","deprecated":null,"version":null,"openapi":"/api-rest/openapi/openapi_subscription.json get /v1/subscription/quotas","href":"/api-reference/quotas/get-subscription-quotas"}]}]}],"global":{"anchors":[{"anchor":"Developer Platform","icon":"code","href":"https://platform.bigdata.com/"},{"anchor":"Bigdata Assistant","icon":"comments-dollar","href":"https://bigdata.com"},{"anchor":"Support","icon":"headset","href":"https://docs.bigdata.com/support"}]}},{"tab":"Widgets","pages":[{"title":"Widgets","href":"/widgets/introduction"}]},{"tab":"Assistant","pages":[{"title":"Assistant","href":"/app/introduction"}]},{"tab":"Content Partners","pages":[{"title":"Content Partners","href":"/partner-content-upload/introduction"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/api_changelog"}]},{"tab":"Support","pages":[{"title":"Support","href":"/support"}]},{"tab":"Blog","pages":[{"title":"Blog","href":"/blog/introduction"}]}]},"basePath":"","title":"Get annotated document - Bigdata.com API developer docs","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"]}