SuggestAPI Documentation
Contact us Open app
Reference

Indexes API

Reference for index creation, stats, schema, merchandising, promotion, and related index management routes.

Copy page
Open in ChatGPT Open with page context Open in Claude Open with page context

Core index routes

  • GET /v1/indexes
  • GET /v1/indexes/stream
  • POST /v1/indexes
  • GET /v1/indexes/{index_id}/stats
  • POST /v1/indexes/{index_id}/allocate-physical-id
  • POST /v1/indexes/{index_id}/promote
  • DELETE /v1/indexes/{index_id}

Schema and merchandising

  • GET /v1/indexes/{index_id}/schema
  • PUT /v1/indexes/{index_id}/schema
  • GET /v1/indexes/{index_id}/merchandising
  • PUT /v1/indexes/{index_id}/merchandising

Tasks and exports

  • GET /v1/indexes/{index_id}/tasks
  • GET /v1/indexes/{index_id}/export

Create index request

{
  "index_id": "products",
  "name": "Products"
}

Operational notes

  • index IDs must be alphanumeric with dashes or underscores
  • plans can block new index creation
  • list responses expose active_physical_index_id and document counts