Create New Document

POST /v2/indices/{index public key}/documents/

Create a new document to the index.

By default, the Documents API endpoint creates a random id for each new document. If you want to define the id for the document or generate the id using the URL field, use the Update Document endpoint.

Payload

The request body should be a JSON object containing the standard and custom fields describing the document contents.

{
  "url": "https://www.example.com",
  "language": "en",
  "title": "Page title",
  "main_content": "The page content",
  "doc_date": "2023-12-31",
  "custom_fields": {
    "description": "Description for example product",
    "price_cents": 599,
    "average_customer_rating": 4.5,
    "release_date": 1589200255
  }
}

Document fields

• Standard fields consists of key value pairs for pre-defined standard fields. The type for all standard fields is string.
• Custom fields is a map of key-value pairs for custom fields. Multiple data types are supported. See “Custom field data types” below.

{
  "url": "https://www.example.com/",
  "language": "en",
  "title": "An example article title",
  "main_content": "The text content of the article. The automatic highlight in search results will only be generated from the content of this field.",
  "doc_date": "2023-12-31",
  "custom_fields": {
    "description": "Description for example product",
    "price_cents": 599,
    "average_customer_rating": 4.5,
    "release_date": 1589200255
   "image_url": "https://www.example.com/page.png",
    "article_categories": ["Blog post", "Article"]
  }
}

Custom field data types

Data types for custom fields are automatically collected from the fields content/value. Supported data types are:

• string
• integer
• double

Dates as custom fields should be defined as UNIX timestamps with integer values.

Please note that once you have defined a specific data type for the custom field, the data type cannot be changed.

Indexing unsupported values will fail. If you have defined an unsupported data type, create a new custom field with a different name.

Response

A request to create a new document adds the document to a queue. On success, the endpoint will return a response HTTP 201 Created, with a URL pointing to the created document in the response header “Location.” It might take a few seconds for the document to become available.