Skip to main content

Get Document Content

Use this endpoint to retrieve the detailed content and metadata of a specific document indexed in AddSearch.

GET /v1/indices/{index_public_key}/documents/{doc_id}/content

Constructing the Endpoint URL​

You can obtain the document's content link from the content property in the document status response. Append /content to that link to form the full endpoint URL.

Authentication​

This API requires authentication. See the authentication guide for details on how to include your credentials.

Example Response​

{
  "title": "An example page",
  "h1": "The heading on an example page",
  "h2": "",
  "mainContent": "The indexed content on an example page",
  "documentDate": "2015-02-10T14:11:13.000Z",
  "language": "en",
  "hiddenKeywords": null
}

Response Fields​

FieldDescriptionTypeNotes
titleDocument's titlestring
h1Document's primary headingsstringContains main headings extracted from the document.
h2Document's subheadingsstringContains subheadings if available.
mainContentDocument's contentstringThe main body content indexed for the document.
documentDateDocument's datestringISO 8601 format (YYYY-MM-DDTHH:mm:ss.sssZ). Reflects the creation date from the source or index date if unavailable.
languageDocument's languagestringTwo-letter language code, e.g., "en", "de", "es".
hiddenKeywordsDocument's hidden keywordsstringSpace- or comma-separated keywords manually added to improve search matching. See hidden keywords documentation.

Additional Notes​

  • The documentDate field shows when the document was created or first indexed.
  • hiddenKeywords are keywords not present in the document's visible content but used to improve search relevance.

For more information, visit related API sections: