Typesense API

Typesense API

API version: 30.0

Auth

ApiKey X-TYPESENSE-API-KEY in header

Base URL

http://localhost:8108

Setup

1. Set your API key in the appropriate header
2. GET /collections -- verify access
3. POST /collections -- create first collections

Endpoints

79 endpoints across 18 groups. See references/api-spec.lap for full details.

collections

synonym_sets

curation_sets

conversations

keys

aliases

debug

health

operations

config

multi_search

analytics

metrics.json

stats.json

stopwords

presets

stemming

nl_search_models

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all collections?" -> GET /collections
• "Create a collection?" -> POST /collections
• "Get collection details?" -> GET /collections/{collectionName}
• "Partially update a collection?" -> PATCH /collections/{collectionName}
• "Delete a collection?" -> DELETE /collections/{collectionName}
• "Create a document?" -> POST /collections/{collectionName}/documents
• "List all search?" -> GET /collections/{collectionName}/documents/search
• "List all synonym_sets?" -> GET /synonym_sets
• "Get synonym_set details?" -> GET /synonym_sets/{synonymSetName}
• "Update a synonym_set?" -> PUT /synonym_sets/{synonymSetName}
• "Delete a synonym_set?" -> DELETE /synonym_sets/{synonymSetName}
• "List all items?" -> GET /synonym_sets/{synonymSetName}/items
• "Get item details?" -> GET /synonym_sets/{synonymSetName}/items/{itemId}
• "Update a item?" -> PUT /synonym_sets/{synonymSetName}/items/{itemId}
• "Delete a item?" -> DELETE /synonym_sets/{synonymSetName}/items/{itemId}
• "List all curation_sets?" -> GET /curation_sets
• "Get curation_set details?" -> GET /curation_sets/{curationSetName}
• "Update a curation_set?" -> PUT /curation_sets/{curationSetName}
• "Delete a curation_set?" -> DELETE /curation_sets/{curationSetName}
• "List all items?" -> GET /curation_sets/{curationSetName}/items
• "Get item details?" -> GET /curation_sets/{curationSetName}/items/{itemId}
• "Update a item?" -> PUT /curation_sets/{curationSetName}/items/{itemId}
• "Delete a item?" -> DELETE /curation_sets/{curationSetName}/items/{itemId}
• "List all export?" -> GET /collections/{collectionName}/documents/export
• "Create a import?" -> POST /collections/{collectionName}/documents/import
• "Get document details?" -> GET /collections/{collectionName}/documents/{documentId}
• "Partially update a document?" -> PATCH /collections/{collectionName}/documents/{documentId}
• "Delete a document?" -> DELETE /collections/{collectionName}/documents/{documentId}
• "List all models?" -> GET /conversations/models
• "Create a model?" -> POST /conversations/models
• "Get model details?" -> GET /conversations/models/{modelId}
• "Update a model?" -> PUT /conversations/models/{modelId}
• "Delete a model?" -> DELETE /conversations/models/{modelId}
• "List all keys?" -> GET /keys
• "Create a key?" -> POST /keys
• "Get key details?" -> GET /keys/{keyId}
• "Delete a key?" -> DELETE /keys/{keyId}
• "List all aliases?" -> GET /aliases
• "Update a aliase?" -> PUT /aliases/{aliasName}
• "Get aliase details?" -> GET /aliases/{aliasName}
• "Delete a aliase?" -> DELETE /aliases/{aliasName}
• "List all debug?" -> GET /debug
• "List all health?" -> GET /health
• "List all schema_changes?" -> GET /operations/schema_changes
• "Create a snapshot?" -> POST /operations/snapshot
• "Create a vote?" -> POST /operations/vote
• "Create a clear?" -> POST /operations/cache/clear
• "Create a compact?" -> POST /operations/db/compact
• "Create a config?" -> POST /config
• "Create a multi_search?" -> POST /multi_search
• "Create a event?" -> POST /analytics/events
• "List all events?" -> GET /analytics/events
• "Create a flush?" -> POST /analytics/flush
• "List all status?" -> GET /analytics/status
• "Create a rule?" -> POST /analytics/rules
• "List all rules?" -> GET /analytics/rules
• "Update a rule?" -> PUT /analytics/rules/{ruleName}
• "Get rule details?" -> GET /analytics/rules/{ruleName}
• "Delete a rule?" -> DELETE /analytics/rules/{ruleName}
• "List all metrics.json?" -> GET /metrics.json
• "List all stats.json?" -> GET /stats.json
• "List all stopwords?" -> GET /stopwords
• "Update a stopword?" -> PUT /stopwords/{setId}
• "Get stopword details?" -> GET /stopwords/{setId}
• "Delete a stopword?" -> DELETE /stopwords/{setId}
• "List all presets?" -> GET /presets
• "Get preset details?" -> GET /presets/{presetId}
• "Update a preset?" -> PUT /presets/{presetId}
• "Delete a preset?" -> DELETE /presets/{presetId}
• "List all dictionaries?" -> GET /stemming/dictionaries
• "Get dictionary details?" -> GET /stemming/dictionaries/{dictionaryId}
• "Create a import?" -> POST /stemming/dictionaries/import
• "List all nl_search_models?" -> GET /nl_search_models
• "Create a nl_search_model?" -> POST /nl_search_models
• "Get nl_search_model details?" -> GET /nl_search_models/{modelId}
• "Update a nl_search_model?" -> PUT /nl_search_models/{modelId}
• "Delete a nl_search_model?" -> DELETE /nl_search_models/{modelId}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP