Sign in

v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
Documents

Enrich document

Request a pre-signed URL to upload a document directly to Bigdata.com. The response contains a single-use url and the document id. Send a PUT request to that URL with the document file as the body to complete the upload. Bigdata then enriches the document (extraction, structure and annotation of the content) and indexes it; when done, it is available for the Search and Research Agent.

post/contents/v1/documents

Request body

file_namestring required

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

published_tsstring date-time

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

tagsstring[]

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.

share_with_orgboolean

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 request

{
  "file_name": "research_report.pdf",
  "published_ts": "2025-06-15T10:30:00Z",
  "tags": [
    "Research Team"
  ],
  "share_with_org": 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.

urlstring uri required

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

idstring required

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