Documents

Get Document Contents

GET /v2/indices/{index public key}/documents/{document id}

Retrieve the content of a single document from the index.

Response

{
  "id": "8700a03070a37982924597d6baa87be7",
  "thumbnail_external_src": "https://www.example.com/thumbnail-image.jpg",
  "custom_fields": {
    "title": "Example product",
    "description": "Description for example product",
    "price_cents": 599,
    "average_customer_rating": 4.5
  }
}

FieldDescriptionTypeNotes
idDocument's idstringURL encoded as md5 hash.
thumbnail_external_srcThumbnails's URLstringA URL of an image used as a thumbnail for the document by default
Standard fieldAny of the standard fields described here except the URL.Dependent on the fieldEach field should be a separate key-value pair.
custom_fieldsTop levelA map of custom fields key value pairsSupported data-types: text, integer, and double.

⚠️ Having indexing issues with Cloudflare? Here’s how to fix it.