Typesense · Example Payload

Typesense Create Collection Example

Full-Text SearchOpen-SourceSearch EnginesTypo ToleranceVector Search

Typesense Create Collection Example is an example object payload from Typesense, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

Raw ↑
{
  "request": {
    "method": "POST",
    "url": "http://localhost:8108/collections",
    "headers": {
      "X-TYPESENSE-API-KEY": "{api_key}",
      "Content-Type": "application/json"
    },
    "body": {
      "name": "products",
      "fields": [
        {"name": "name", "type": "string"},
        {"name": "description", "type": "string"},
        {"name": "brand", "type": "string", "facet": true},
        {"name": "category", "type": "string", "facet": true},
        {"name": "price", "type": "float"},
        {"name": "rating", "type": "float"},
        {"name": "in_stock", "type": "bool"},
        {"name": "num_reviews", "type": "int32"},
        {"name": "location", "type": "geopoint"}
      ],
      "default_sorting_field": "num_reviews"
    }
  },
  "response": {
    "status": 201,
    "body": {
      "name": "products",
      "num_documents": 0,
      "fields": [
        {"name": "name", "type": "string", "facet": false, "optional": false, "index": true},
        {"name": "description", "type": "string", "facet": false, "optional": false, "index": true},
        {"name": "brand", "type": "string", "facet": true, "optional": false, "index": true},
        {"name": "category", "type": "string", "facet": true, "optional": false, "index": true},
        {"name": "price", "type": "float", "facet": false, "optional": false, "index": true},
        {"name": "rating", "type": "float", "facet": false, "optional": false, "index": true},
        {"name": "in_stock", "type": "bool", "facet": false, "optional": false, "index": true},
        {"name": "num_reviews", "type": "int32", "facet": false, "optional": false, "index": true},
        {"name": "location", "type": "geopoint", "facet": false, "optional": false, "index": true}
      ],
      "default_sorting_field": "num_reviews",
      "created_at": 1636223420
    }
  }
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/typesense-create-collection-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.