Get document metadata

curl --request GET \
  --url https://api.bigdata.com/contents/v1/documents/{content_id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/contents/v1/documents/{content_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bigdata.com/contents/v1/documents/{content_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigdata.com/contents/v1/documents/{content_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/documents/{content_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "E0618D0E9D3A960C1731A620EDE56B5C",
  "file_name": "Weekly summary report.pdf",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "rp_collection_id": "2CBDC7DA8AE42A8A078DECC3C9FCADFB",
  "rp_source_id": "E5A77C",
  "raw_size": 18974,
  "pages": 50,
  "request_origin": "email",
  "content_type": "application/pdf",
  "status": "completed",
  "shared_with_orgs": [
    "org_id_001"
  ],
  "created_at": "2026-08-10T14:21:40.333178Z",
  "updated_at": "2026-08-10T14:21:40.333181Z",
  "published_at": "2026-08-10T12:00:00Z",
  "connector_id": "019dbfd9-f1ea-7024-888d-e52af8c87b03",
  "error_code": null,
  "delete_started_ts": null,
  "file_metadata": null,
  "tags": [
    {
      "id": "019d448a-8511-75de-b5ff-9770fdf91d4b",
      "name": "to:user1@email.com"
    },
    {
      "id": "019e21c9-40c8-7857-ae52-a3b51c84108f",
      "name": "from:user2@email.com"
    }
  ],
  "usage": {
    "private_data_tokens": 171079
  },
  "enrichments_requested": [
    "translation"
  ],
  "enrichments_applied": []
}

GET

contents

documents

{content_id}

Get document metadata

curl --request GET \
  --url https://api.bigdata.com/contents/v1/documents/{content_id} \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/contents/v1/documents/{content_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bigdata.com/contents/v1/documents/{content_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bigdata.com/contents/v1/documents/{content_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/contents/v1/documents/{content_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "E0618D0E9D3A960C1731A620EDE56B5C",
  "file_name": "Weekly summary report.pdf",
  "user_id": "user_id_001",
  "org_id": "org_id_001",
  "rp_collection_id": "2CBDC7DA8AE42A8A078DECC3C9FCADFB",
  "rp_source_id": "E5A77C",
  "raw_size": 18974,
  "pages": 50,
  "request_origin": "email",
  "content_type": "application/pdf",
  "status": "completed",
  "shared_with_orgs": [
    "org_id_001"
  ],
  "created_at": "2026-08-10T14:21:40.333178Z",
  "updated_at": "2026-08-10T14:21:40.333181Z",
  "published_at": "2026-08-10T12:00:00Z",
  "connector_id": "019dbfd9-f1ea-7024-888d-e52af8c87b03",
  "error_code": null,
  "delete_started_ts": null,
  "file_metadata": null,
  "tags": [
    {
      "id": "019d448a-8511-75de-b5ff-9770fdf91d4b",
      "name": "to:user1@email.com"
    },
    {
      "id": "019e21c9-40c8-7857-ae52-a3b51c84108f",
      "name": "from:user2@email.com"
    }
  ],
  "usage": {
    "private_data_tokens": 171079
  },
  "enrichments_requested": [
    "translation"
  ],
  "enrichments_applied": []
}

Authorizations

X-API-KEY

string

header

required

Your API key. Include it in every request as the X-API-KEY header. Create and manage keys in the Developer Platform.

Path Parameters

content_id

string

required

Content ID of the document: a 32-character uppercase hexadecimal string (MD5-based identifier).

Pattern: ^[A-F0-9]{32}$

Example:

"E0618D0E9D3A960C1731A620EDE56B5C"

Response

Document metadata (id, file_name, status, connector_id, tags, etc.). Use Get annotated document or Get original document with this id to download content.

Metadata for a single document. Returned by List documents and Get document. Use the id (content_id) with Get annotated document or Get original document to retrieve the file content.

string

required

Content ID: unique 32-character uppercase hexadecimal identifier for the document. Use this when calling Get document, Get annotated document, or Get original document.

Example:

"E0618D0E9D3A960C1731A620EDE56B5C"

file_name

string

required

Original file name of the uploaded document.

Example:

"Weekly summary report.eml"

user_id

string

required

ID of the user who uploaded the document.

Example:

"user_id_001"

org_id

string

required

ID of the organization the document belongs to.

Example:

"org_id_001"

status

enum<string>

required

Processing status of the document.

Available options:

pending,

processing,

completed,

failed

created_at

string<date-time>

required

Timestamp when the document was created.

Example:

"2026-02-03T08:43:02.729356Z"

updated_at

string<date-time>

required

Timestamp when the document was last updated.

Example:

"2026-02-03T08:43:02.729359Z"

published_at

string<date-time>

required

Timestamp when the document was published. This is the reference timestamp used for search and retrieval.

Example:

"2026-02-03T08:43:02.729359Z"

rp_collection_id

string | null

ID of the collection the document belongs to. This is applicable only for emails and attachments.

Example:

"2CBDC7DA8AE42A8A078DECC3C9FCADFB"

rp_source_id

string | null

Identifier of the RavenPack source associated with this document. This source is used to filter documents in the Search and Research Agent.

Example:

"E5A77C"

raw_size

integer

Size of the raw document in bytes.

Example:

18974

pages

integer | null

Number of pages in the document when page count is available (for example PDFs).

Example:

50

request_origin

enum<string>

Origin of the content ingestion request: how the document entered the platform.

Available options:

email,

investment_research,

sharepoint,

file_upload

content_type

string

MIME type of the document.

Example:

"message/rfc822"

shared_with_orgs

string[]

List of organization IDs the document is shared with.

Example:

["org_id_001"]

connector_id

string<uuid> | null

ID of the connector used to upload the document.

Example:

"019a9612-bfad-758c-884e-37dd8c6ad2cb"

error_code

string | null

Error code if the document processing failed.

Example:

null

delete_started_ts

string<date-time> | null

Timestamp when document deletion started, if applicable.

Example:

null

file_metadata

object | null

Additional metadata about the file.

Example:

null

API

Knowledge Graph

Search Service

Watchlists

Monitors

Research Service

Content

Structured Data

Subscription

SDK

Authorizations

Path Parameters

Response