Skip to main content
POST
/
contents
/
v1
/
documents
Enrich document
curl --request POST \
  --url https://api.bigdata.com/contents/v1/documents \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "file_name": "research_report.pdf",
  "published_ts": "2025-06-15T10:30:00Z",
  "tags": [
    "Research Team"
  ],
  "share_with_org": true
}
'
{
  "url": "https://s3.amazonaws.com/com.ravenpack.private-content-drop.smart-topics-prod-nvirginia/uploads/F22BC027BCE166BC89DD2A81358DA2F1?AWSAccessKeyId=...",
  "id": "F22BC027BCE166BC89DD2A81358DA2F1"
}

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.

Body

application/json
​
file_name
string
required

Name of the file being uploaded (e.g. research_report.pdf).

Example:

"research_report.pdf"

​
published_ts
string<date-time>

Optional publication date/time for the document (ISO 8601). This date will be used as the reference timestamp for search and retrieval.

Example:

"2025-06-15T10:30:00Z"

​
tags
string[]

Optional list of tag names to apply to the document. Tags can be used to search and filter documents in the Search and Research-Agent services.

Example:
["Research Team"]
​
share_with_org
boolean

If true, all members of your organization can access the file once it is processed. If false, only you can access the processed content.

Example:

true

Response

Pre-signed URL and document id. PUT the file to the URL to complete the upload; use the id with Get document to poll for status.

​
url
string<uri>
required

Single-use pre-signed URL. Send a PUT request to this URL with the document file as the body.

​
id
string
required

Document content ID (32-character uppercase hexadecimal). Use this with Get document to check processing status and perform operations on the document.