---
title: "Fetch document"
method: GET
path: "/v1/documents/{document_id}"
tags: ["Search"]
---

# Fetch document

`GET /v1/documents/{document_id}`

Returns a time-limited pre-signed URL for downloading the document in annotated (structured) JSON format. Issuing a GET request to that URL returns the document's content, metadata, and annotations. The URL expires after 24 hours; request a new one when it does.

This endpoint works for any document in Bigdata, whether it originates from the RavenPack catalog or from your own processed files.

When `web_content` is `true`, the returned document also includes a direct URL to the publisher's original article on the web.

## Path parameters

- `document_id` string, required

## Response `200`

An object with a url and a web_content field is returned. When web_content is true, the returned document contains a direct link to the original web page in addition to the full analytics.

- object
  - `web_content` boolean — true when is a public URL.
  - `url` string, uri, required — 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). In the case of transcript-style documents, the document metadata includes normalized event context (participants, reporting fields, timestamps_utc). This is available for **Factset** documents, other providers like **Quartr** or **Third Bridge** will be available soon.
  - `document` Document — Complete document structure returned when accessing the URL. This is the JSON format used by Bigdata.com for structured document representation.
    - `rp_document_id` string, required — Internal document identifier
    - `source` DocumentSourceDetails, required — Information about the document source.
      - `rp_external_source_id` string — External source identifier when the upstream feed exposes one.
      - `rp_provider_id` string — Short provider code for the originating data partner.
      - `rp_source_id` string, required — Identifier of the source system
      - `name` string, required — Source display name for the feed or collection
      - `rank` integer, required — Ranking classification of the source.
      - `rp_channel_id` integer — Channel identifier when the document is grouped under a provider channel.
    - `timestamps_utc` DocumentTimestampsUtc — Pipeline timestamps in UTC for the document record.
      - `published` string — When the provider published or released the underlying asset.
      - `reception` string — When the document was first received into the collection pipeline.
      - `analytics` string — When analytics enrichment completed for this revision.
      - `revision` string — When this metadata revision was materialized.
    - `metadata` DocumentMetadataDetails, required — Provider and RavenPack metadata carried on the document. Fields are sparse: only subsets apply per document type (news, filings, transcripts, web, etc.).
      - `url` string, uri — URL pointing to the original document or asset when the provider exposes one.
      - `provider_document_id` string — Opaque provider document key, often colon-delimited segments (collection, flavor, provider id).
      - `media_type` string — MIME type of the canonical payload when known.
      - `original_language` string — Primary language of the source document.
      - `file_name` string — Original file name for uploaded or file-based documents.
      - `content_type` string — Legacy or alternate MIME label (for example message/rfc822 for email).
      - `revision` DocumentRevisionMetadata — Provider revision lineage for the document.
        - `chain_id` string — Stable chain identifier for the revision stream (often a provider collection or story id, sometimes with flavor suffixes).
        - `sequence_id` string — Monotonic or provider-supplied sequence token within the chain, when present.
      - `transcript_event_date` string — Calendar date of the live session or release for transcript-class documents.
      - `transcript_event_datetime` string — Session anchor datetime in the provider or venue timezone context.
      - `transcript_event_type` string — Compact code for the session category (for example earnings call).
      - `transcript_participants` object — Map of string ordinal indexes to participant rows.
      - `codes` string[] — Listing, ISIN, or other security codes when supplied.
      - `custom` object — Provider-specific key-value metadata without a fixed cross-provider schema.
      - `reporting_period` string — Fiscal reporting label when the session ties to a reporting window.
      - `reporting_start_date_utc` string — Inclusive start of the reporting window in UTC when supplied.
      - `reporting_end_date_utc` string — Exclusive or inclusive end of the reporting window in UTC when supplied.
      - `reporting_entities` string[] — Related RavenPack entity identifiers for the reporting view.
      - `collection` DocumentMetadataCollection — Link between RavenPack collection identifiers and the provider collection.
        - `rp_collection_id` string — RavenPack collection identifier.
        - `provider_collection_id` string — Provider-native collection or listing identifier.
      - `provider_primary_entity_id` string — Provider-native primary company identifier for the session.
      - `provider_primary_entity_name` string — Provider-native primary company display name.
      - `document_type` string — Normalized document flavor (for example transcript-raw, transcript-corrected).
  - `content` Content — Structured content extracted from the document including title and body blocks.
    - `stats` ContentStats — Optional size statistics for the document text payload.
      - `word_count` integer — Approximate word count for indexed body text.
      - `byte_count` integer — Approximate byte size of the serialized content payload.
    - `title` ContentTitleBlock, required — A title content block representing the title of the document.
      - `text` string — Extracted document title
      - `sentences` Sentence[] — Index ranges for title text segments
        - `start` integer, required — Start character index of the sentence.
        - `end` integer, required — End character index of the sentence.
        - `sentiment` string — Sentiment score ranging from -1.00 (negative) to 1.00 (positive).
        - `sentiment_confidence` string — Confidence score for the sentiment analysis (0.00 to 1.00).
      - `entities` TextEntity[] — Entities detected inside the title text
        - `rp_entity_id` string, required — Bigdata.com unique entity identifier.
        - `name` string — Display name of the entity.
        - `type` 'COMPANY' | 'PERSON' | 'PLACE' | 'PRODUCT' | 'ORGANIZATION' | 'ETF' — Entity type classification.
        - `start` integer, required — Start character index where the entity appears in the text.
        - `end` integer, required — End character index where the entity appears in the text.
      - `events` ContentTitleInlineEvent[] — Optional title-span events with character offsets into the title text.
        - `event_similarity_key` string
        - `start` integer — Start character index in the title text.
        - `end` integer — End character index in the title text.
    - `body` union[], required — Array of content blocks extracted from the document. Each item represents a block of content such as text paragraphs, tables, or lists. All block types include the common fields defined in ContentBlockCommonFields.
      - union
        - TextBlock — A plain text block within a report section.
          - `block_type` 'text' — Block type identifier.
          - `content` string, required — Text content.
        - TableBlock — Common fields present in all content block types (TextBlock, TableBlock, ListBlock). These fields may appear alongside the block-specific fields.
          - `type` 'TABLE', required — Table block type.
          - `rows` TableRow[], required — Row definitions for the table.
            - `cells` TableCell[], required — Cells in the row.
              - …
          - `normalized_coordinates` NormalizedCoordinates[] — Bounding boxes normalized to page dimensions
            - `page` integer — Page number (1-indexed).
            - `x` number, float — X coordinate (left edge) normalized to page width.
            - `y` number, float — Y coordinate (top edge) normalized to page height.
            - `width` number, float — Width normalized to page width.
            - `height` number, float — Height normalized to page height.
          - `text` string — Extracted visible text (if any)
          - `sentences` Sentence[] — Index ranges for sentence segmentation
            - `start` integer, required — Start character index of the sentence.
            - `end` integer, required — End character index of the sentence.
            - `sentiment` string — Sentiment score ranging from -1.00 (negative) to 1.00 (positive).
            - `sentiment_confidence` string — Confidence score for the sentiment analysis (0.00 to 1.00).
          - `entities` TextEntity[] — Entities detected in the text
            - `rp_entity_id` string, required — Bigdata.com unique entity identifier.
            - `name` string — Display name of the entity.
            - `type` 'COMPANY' | 'PERSON' | 'PLACE' | 'PRODUCT' | 'ORGANIZATION' | 'ETF' — Entity type classification.
            - `start` integer, required — Start character index where the entity appears in the text.
            - `end` integer, required — End character index where the entity appears in the text.
        - ListBlock — Common fields present in all content block types (TextBlock, TableBlock, ListBlock). These fields may appear alongside the block-specific fields.
          - `type` 'LIST_ORDERED' | 'LIST_UNORDERED', required — List block type.
          - `entries` ListEntry[], required — List entries/items.
            - `key` string, required — Bullet character for unordered lists (e.g., '•') or list number for ordered lists (e.g., '1').
            - `content` CellContent[], required — Content objects within the list entry.
              - …
          - `normalized_coordinates` NormalizedCoordinates[] — Bounding boxes normalized to page dimensions
            - `page` integer — Page number (1-indexed).
            - `x` number, float — X coordinate (left edge) normalized to page width.
            - `y` number, float — Y coordinate (top edge) normalized to page height.
            - `width` number, float — Width normalized to page width.
            - `height` number, float — Height normalized to page height.
          - `text` string — Extracted visible text (if any)
          - `sentences` Sentence[] — Index ranges for sentence segmentation
            - `start` integer, required — Start character index of the sentence.
            - `end` integer, required — End character index of the sentence.
            - `sentiment` string — Sentiment score ranging from -1.00 (negative) to 1.00 (positive).
            - `sentiment_confidence` string — Confidence score for the sentiment analysis (0.00 to 1.00).
          - `entities` TextEntity[] — Entities detected in the text
            - `rp_entity_id` string, required — Bigdata.com unique entity identifier.
            - `name` string — Display name of the entity.
            - `type` 'COMPANY' | 'PERSON' | 'PLACE' | 'PRODUCT' | 'ORGANIZATION' | 'ETF' — Entity type classification.
            - `start` integer, required — Start character index where the entity appears in the text.
            - `end` integer, required — End character index where the entity appears in the text.
        - HeadingBlock — Common fields present in all content block types (TextBlock, TableBlock, ListBlock). These fields may appear alongside the block-specific fields.
          - `type` 'HEADING', required — Heading block type.
          - `normalized_coordinates` NormalizedCoordinates[] — Bounding boxes normalized to page dimensions
            - `page` integer — Page number (1-indexed).
            - `x` number, float — X coordinate (left edge) normalized to page width.
            - `y` number, float — Y coordinate (top edge) normalized to page height.
            - `width` number, float — Width normalized to page width.
            - `height` number, float — Height normalized to page height.
          - `text` string — Extracted visible text (if any)
          - `sentences` Sentence[] — Index ranges for sentence segmentation
            - `start` integer, required — Start character index of the sentence.
            - `end` integer, required — End character index of the sentence.
            - `sentiment` string — Sentiment score ranging from -1.00 (negative) to 1.00 (positive).
            - `sentiment_confidence` string — Confidence score for the sentiment analysis (0.00 to 1.00).
          - `entities` TextEntity[] — Entities detected in the text
            - `rp_entity_id` string, required — Bigdata.com unique entity identifier.
            - `name` string — Display name of the entity.
            - `type` 'COMPANY' | 'PERSON' | 'PLACE' | 'PRODUCT' | 'ORGANIZATION' | 'ETF' — Entity type classification.
            - `start` integer, required — Start character index where the entity appears in the text.
            - `end` integer, required — End character index where the entity appears in the text.
        - FooterBlock — Common fields present in all content block types (TextBlock, TableBlock, ListBlock). These fields may appear alongside the block-specific fields.
          - `type` 'FOOTER', required — Footer block type.
          - `normalized_coordinates` NormalizedCoordinates[] — Bounding boxes normalized to page dimensions
            - `page` integer — Page number (1-indexed).
            - `x` number, float — X coordinate (left edge) normalized to page width.
            - `y` number, float — Y coordinate (top edge) normalized to page height.
            - `width` number, float — Width normalized to page width.
            - `height` number, float — Height normalized to page height.
          - `text` string — Extracted visible text (if any)
          - `sentences` Sentence[] — Index ranges for sentence segmentation
            - `start` integer, required — Start character index of the sentence.
            - `end` integer, required — End character index of the sentence.
            - `sentiment` string — Sentiment score ranging from -1.00 (negative) to 1.00 (positive).
            - `sentiment_confidence` string — Confidence score for the sentiment analysis (0.00 to 1.00).
          - `entities` TextEntity[] — Entities detected in the text
            - `rp_entity_id` string, required — Bigdata.com unique entity identifier.
            - `name` string — Display name of the entity.
            - `type` 'COMPANY' | 'PERSON' | 'PLACE' | 'PRODUCT' | 'ORGANIZATION' | 'ETF' — Entity type classification.
            - `start` integer, required — Start character index where the entity appears in the text.
            - `end` integer, required — End character index where the entity appears in the text.
  - `analytics` FetchDocumentAnalytics — Structured analytics returned when downloading annotated RPJSON from the signed URL.
    - `document` FetchDocumentAnalyticsDocument — Document-level analytics and tone aggregates returned alongside RPJSON.
      - `analytics_version` string
      - `analytics_revision_number` integer
      - `document_type` string — High-level classified document type for analytics.
      - `document_record_count` integer — Count of body records or segments used for analytics.
      - `title_similarity_key` string — Fingerprint linking this title to similar documents.
      - `document_sentiment` number, float — Aggregate document sentiment score.
      - `document_sentiment_confidence` number, float — Confidence for aggregate document sentiment.
      - `composite_sentiment_score` number, float
      - `sentiment_impact_projection` number, float
      - `stock_tone_sentiment` integer
      - `earnings_tone_sentiment` integer
      - `commentary_sentiment` integer
      - `mergers_acquisitions_sentiment` integer
      - `corporate_actions_sentiment` integer
      - `earnings_release_sentiment` integer
      - `product_key` string
      - `realtime` string — Flag indicating whether the document was processed under realtime constraints.
    - `events` FetchDocumentAnalyticsEvent[] — Detected events with scored roles.
      - `event_similarity_key` string
      - `topic` string
      - `group` string
      - `type` string
      - `event_relevance` integer
      - `roles` FetchDocumentAnalyticsEventRole[]
        - `rp_entity_id` string
        - `category` string
        - `fact_level` string
        - `document_record_index` integer — Index of the body record where the role matched.
        - `match_type` string
        - `event_sentiment` number, float
        - `event_risk` number, float
        - `sustainability_sentiment` number, float
        - `credit_sentiment` number, float
        - `interest_rate_sentiment` number, float
        - `event_detection_distance` integer
        - `event_text` string — Supporting snippet for the detected event.
        - `rp_event_detected_entity_id` string
        - `event_detected_entity_name` string
    - `entities` FetchDocumentAnalyticsEntity[] — Detected entities with document-level relevance and sentiment.
      - `rp_entity_id` string
      - `entity_type` string
      - `entity_name` string
      - `country_code` string
      - `document_record_index` integer
      - `entity_hierarchy_level` integer
      - `entity_detection_type` string
      - `entity_detection_distance` integer
      - `entity_relevance` integer
      - `entity_sentiment` number, float
      - `entity_sentiment_confidence` number, float
      - `entity_text_sentiment` number, float
      - `entity_text_sent_confidence` number, float
      - `analyst_ratings_sentiment` integer
      - `multi_stock_sentiment` integer
  - `software_versions` SoftwareVersions — Optional pipeline build stamps included with some document payloads.
    - `collection_build` string
    - `classification_build` string
    - `metadata_build` string

## Other responses

- `400` — Invalid document_id
- `403` — Access to document denied
- `404` — Document not found.

---

[API](https://skmtc.dev/bigdata/apis/bigdata-structured-data-api.md) · [All operations](https://skmtc.dev/bigdata/apis/bigdata-structured-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bigdata/bigdata-structured-data-api/revisions/18082de268c4/schema)