Quickstart

Quickstart checklist

• Sign in to your SuggestAPI tenant and confirm your active tenant context.
• Create or reveal API keys for your environment.
• Create an index and ingest a few documents from the web app.
• Call /v1/autocomplete and /v1/typeahead.
• Review schema, ranking, and merchandising settings.
• Turn on event tracking if you want popularity and personalization inputs.

1. Create an index

curl -X POST https://api.suggestapi.com/v1/indexes \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "index_id": "products",
    "name": "Products"
  }'

2. Ingest a few documents

curl -X POST https://api.suggestapi.com/v1/indexes/products/documents \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "documents": [
      {
        "id": "sku_1001",
        "title": "PTFE Diaphragm Pump",
        "desc": "Chemical-resistant pump for demanding transfer jobs",
        "manufacturer": "LMI",
        "raw": {
          "category": "Pumps",
          "price": 499.99,
          "product_url": "https://example.com/products/sku_1001"
        }
      }
    ]
  }'

3. Run autocomplete

curl "https://api.suggestapi.com/v1/autocomplete?index=products&query=ptfe%20pump&limit=5" \
  -H "x-api-key: <public-or-private-key>"

4. Run typeahead

curl "https://api.suggestapi.com/v1/typeahead?index=products&query=ptf&limit=5" \
  -H "x-api-key: <public-or-private-key>"

5. Validate the basics

• Confirm the index appears in /v1/indexes.
• Confirm document_count increases after ingestion.
• Confirm /v1/typeahead returns short labels while /v1/autocomplete returns richer payloads.
• Confirm your document raw fields include the display data your frontend needs.

Common next steps

• Authentication and API keys
• Index lifecycle
• Bulk imports and ingestion jobs