{
  "opencollection": "1.0.0",
  "info": {
    "name": "Typesense Analytics Analytics Events Search API",
    "version": "30.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-TYPESENSE-API-KEY",
      "value": "{{X-TYPESENSE-API-KEY}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search For Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{protocol}://{hostname}:{port}/collections/:collectionName/documents/search",
            "params": [
              {
                "name": "collectionName",
                "value": "",
                "type": "path",
                "description": "Name of the collection."
              },
              {
                "name": "q",
                "value": "",
                "type": "query",
                "description": "The search query string. Use * for wildcard queries."
              },
              {
                "name": "query_by",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to search against."
              },
              {
                "name": "query_by_weights",
                "value": "",
                "type": "query",
                "description": "Comma-separated weights for each query_by field."
              },
              {
                "name": "text_match_type",
                "value": "",
                "type": "query",
                "description": "How text matching is calculated. Options are max_score or max_weight."
              },
              {
                "name": "prefix",
                "value": "",
                "type": "query",
                "description": "Whether prefix search is enabled for query_by fields."
              },
              {
                "name": "infix",
                "value": "",
                "type": "query",
                "description": "Enable infix search for specified fields."
              },
              {
                "name": "filter_by",
                "value": "",
                "type": "query",
                "description": "Filter conditions for narrowing search results."
              },
              {
                "name": "sort_by",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields and sort directions."
              },
              {
                "name": "facet_by",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to facet on."
              },
              {
                "name": "max_facet_values",
                "value": "",
                "type": "query",
                "description": "Maximum number of facet values to return."
              },
              {
                "name": "facet_query",
                "value": "",
                "type": "query",
                "description": "Facet query for filtering facet values."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number for pagination."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page."
              },
              {
                "name": "group_by",
                "value": "",
                "type": "query",
                "description": "Field to group results by."
              },
              {
                "name": "group_limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of hits per group."
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include in results."
              },
              {
                "name": "exclude_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to exclude from results."
              },
              {
                "name": "highlight_fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to highlight."
              },
              {
                "name": "highlight_full_fields",
                "value": "",
                "type": "query",
                "description": "Fields for which full highlights are returned."
              },
              {
                "name": "num_typos",
                "value": "",
                "type": "query",
                "description": "Number of typographical errors to tolerate per token."
              },
              {
                "name": "typo_tokens_threshold",
                "value": "",
                "type": "query",
                "description": "Minimum token count to enable typo tolerance."
              },
              {
                "name": "drop_tokens_threshold",
                "value": "",
                "type": "query",
                "description": "Token threshold below which tokens are dropped from query."
              },
              {
                "name": "pinned_hits",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of document IDs to pin at specific positions."
              },
              {
                "name": "hidden_hits",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of document IDs to hide from results."
              },
              {
                "name": "enable_overrides",
                "value": "",
                "type": "query",
                "description": "Whether to apply curations and overrides."
              },
              {
                "name": "preset",
                "value": "",
                "type": "query",
                "description": "Name of a preset to use for search parameters."
              },
              {
                "name": "vector_query",
                "value": "",
                "type": "query",
                "description": "Vector query for nearest-neighbor search."
              },
              {
                "name": "conversation",
                "value": "",
                "type": "query",
                "description": "Whether to enable conversational search (RAG)."
              },
              {
                "name": "conversation_model_id",
                "value": "",
                "type": "query",
                "description": "ID of the conversation model to use."
              },
              {
                "name": "conversation_id",
                "value": "",
                "type": "query",
                "description": "ID of an existing conversation to continue."
              }
            ]
          },
          "docs": "Searches for documents in a collection using full-text search with typo tolerance, faceting, filtering, sorting, grouping, geo search, and vector search capabilities."
        }
      ]
    }
  ],
  "bundled": true
}