Sign in

v1

latestOpenAPI 3.0.3GPL-3.02026-07-177978150.2 KB
collections

Retrieve a single collection

Retrieve the details of a collection, given its name.

get/collections/{collectionName}

Path parameters

collectionNamestring required

The name of the collection to retrieve

Response

Collection fetched

namestring required

Name of the collection

default_sorting_fieldstring

The name of an int32 / float field that determines the order in which the search results are ranked when a sort_by clause is not provided during searching. This field must indicate some kind of popularity.

token_separatorsstring[]

List of symbols or special characters to be used for splitting the text into individual words in addition to space and new-line characters.

synonym_setsstring[]

List of synonym set names to associate with this collection

enable_nested_fieldsboolean

Enables experimental support at a collection level for nested object or object array fields. This field is only available if the Typesense server is version 0.24.0.rcn34 or later.

symbols_to_indexstring[]

List of symbols or special characters to be indexed.

metadataobject

Optional details about the collection, e.g., when it was created, who created it etc.

num_documentsinteger required

Number of documents in the collection

created_atinteger required

Timestamp of when the collection was created (Unix epoch in seconds)

Example response

{
  "name": "companies",
  "fields": [
    {
      "name": "num_employees",
      "type": "int32",
      "facet": false
    },
    {
      "name": "company_name",
      "type": "string",
      "facet": false
    },
    {
      "name": "country",
      "type": "string",
      "facet": true
    }
  ],
  "default_sorting_field": "num_employees",
  "synonym_sets": [
    "synonym_set_1"
  ],
  "enable_nested_fields": true,
  "voice_query_model": {
    "model_name": "ts/whisper/base.en"
  }
}