# NeuronSearchLab

## Docs

- [Create access token](https://docs.neuronsearchlab.com/api-reference/endpoint/authenticate.md): Exchange SDK credentials for a short-lived access token.
- [Delete item](https://docs.neuronsearchlab.com/api-reference/endpoint/delete-item.md): Delete a catalog item.
- [Get recommendations](https://docs.neuronsearchlab.com/api-reference/endpoint/get-recommendations.md): Retrieve personalized recommendations.
- [List events](https://docs.neuronsearchlab.com/api-reference/endpoint/list-events.md): List ingested events with cursor pagination.
- [List items](https://docs.neuronsearchlab.com/api-reference/endpoint/list-items.md): List catalog items with cursor pagination.
- [Patch item](https://docs.neuronsearchlab.com/api-reference/endpoint/patch-item.md): Update an existing catalog item using the compatibility PATCH method.
- [Retrieve event](https://docs.neuronsearchlab.com/api-reference/endpoint/retrieve-event.md): Retrieve a single ingested event.
- [Retrieve item](https://docs.neuronsearchlab.com/api-reference/endpoint/retrieve-item.md): Retrieve a single catalog item.
- [Submit events](https://docs.neuronsearchlab.com/api-reference/endpoint/submit-events.md): Submit user interaction events.
- [Create items](https://docs.neuronsearchlab.com/api-reference/endpoint/submit-items.md): Create catalog items for recommendation.
- [Update item](https://docs.neuronsearchlab.com/api-reference/endpoint/update-item.md): Update an existing catalog item.
- [Core API Overview](https://docs.neuronsearchlab.com/api-reference/introduction.md): Integrate with the NeuronSearchLab Core API.
- [Compare item performance](https://docs.neuronsearchlab.com/api-reference/platform-api/analytics/compareItems.md)
- [Recommendation, event, and catalog analytics](https://docs.neuronsearchlab.com/api-reference/platform-api/analytics/getAnalytics.md)
- [Item analytics](https://docs.neuronsearchlab.com/api-reference/platform-api/analytics/getItemAnalytics.md)
- [Top items](https://docs.neuronsearchlab.com/api-reference/platform-api/analytics/getTopItems.md)
- [User analytics](https://docs.neuronsearchlab.com/api-reference/platform-api/analytics/getUserAnalytics.md)
- [Create API key](https://docs.neuronsearchlab.com/api-reference/platform-api/api-keys/createApiKey.md)
- [List API keys](https://docs.neuronsearchlab.com/api-reference/platform-api/api-keys/listApiKeys.md)
- [Revoke API key](https://docs.neuronsearchlab.com/api-reference/platform-api/api-keys/revokeApiKey.md)
- [Update API key](https://docs.neuronsearchlab.com/api-reference/platform-api/api-keys/updateApiKey.md)
- [Console assistant chat](https://docs.neuronsearchlab.com/api-reference/platform-api/assistant/assistantChat.md)
- [Studio assistant chat](https://docs.neuronsearchlab.com/api-reference/platform-api/assistant/studioChat.md)
- [Change billing plan](https://docs.neuronsearchlab.com/api-reference/platform-api/billing/changeBillingPlan.md)
- [Open billing portal](https://docs.neuronsearchlab.com/api-reference/platform-api/billing/openBillingPortal.md): Creates a Stripe billing portal session and returns the redirect URL.
- [Create ingest config](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/createCatalogueIngest.md)
- [Delete ingest config](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/deleteCatalogueIngest.md)
- [Scheduler status](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/getCatalogueIngestScheduler.md)
- [List ingest configs](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/listCatalogueIngest.md)
- [Trigger ingest run](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/triggerCatalogueIngest.md)
- [Update ingest config](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/updateCatalogueIngest.md)
- [Update scheduler](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog-ingest/updateCatalogueIngestScheduler.md)
- [Advanced item search](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog/advancedSearchItems.md)
- [Retrieve item](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog/getItemDetail.md)
- [List metadata keys](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog/listItemMetadataKeys.md)
- [Search items](https://docs.neuronsearchlab.com/api-reference/platform-api/catalog/searchItems.md)
- [Create context](https://docs.neuronsearchlab.com/api-reference/platform-api/contexts/createContext.md)
- [Resolve active model for context](https://docs.neuronsearchlab.com/api-reference/platform-api/contexts/getContextActiveModel.md)
- [List contexts](https://docs.neuronsearchlab.com/api-reference/platform-api/contexts/listContexts.md)
- [Update context](https://docs.neuronsearchlab.com/api-reference/platform-api/contexts/updateContext.md)
- [Dashboard metrics](https://docs.neuronsearchlab.com/api-reference/platform-api/dashboard/getDashboard.md)
- [Create event type](https://docs.neuronsearchlab.com/api-reference/platform-api/events/createEventType.md)
- [Create training template](https://docs.neuronsearchlab.com/api-reference/platform-api/events/createTrainingTemplate.md)
- [Delete event type](https://docs.neuronsearchlab.com/api-reference/platform-api/events/deleteEventType.md)
- [Delete training template](https://docs.neuronsearchlab.com/api-reference/platform-api/events/deleteTrainingTemplate.md)
- [List event types](https://docs.neuronsearchlab.com/api-reference/platform-api/events/listEventTypes.md)
- [List training templates](https://docs.neuronsearchlab.com/api-reference/platform-api/events/listTrainingTemplates.md)
- [Save event value configuration](https://docs.neuronsearchlab.com/api-reference/platform-api/events/saveEventValues.md)
- [Update event type](https://docs.neuronsearchlab.com/api-reference/platform-api/events/updateEventType.md)
- [Update training template](https://docs.neuronsearchlab.com/api-reference/platform-api/events/updateTrainingTemplate.md)
- [Create experiment](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/createExperiment.md)
- [Delete experiment](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/deleteExperiment.md)
- [Retrieve experiment](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/getExperiment.md)
- [List experiments](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/listExperiments.md)
- [Refresh experiment metrics](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/refreshExperimentMetrics.md)
- [Update experiment](https://docs.neuronsearchlab.com/api-reference/platform-api/experiments/updateExperiment.md)
- [Explain a recommendation](https://docs.neuronsearchlab.com/api-reference/platform-api/explainability/explainRecommendation.md): Pass either request_id (preferred) or user_id + context_id + item_id.
- [List integrations](https://docs.neuronsearchlab.com/api-reference/platform-api/integrations/listIntegrations.md)
- [Save integration](https://docs.neuronsearchlab.com/api-reference/platform-api/integrations/saveIntegration.md)
- [Platform API Overview](https://docs.neuronsearchlab.com/api-reference/platform-api/introduction.md): Authentication, scopes, and error format for the NeuronSearchLab control-plane API.
- [Deploy model family](https://docs.neuronsearchlab.com/api-reference/platform-api/model-families/deployModelFamily.md)
- [Retrieve model family](https://docs.neuronsearchlab.com/api-reference/platform-api/model-families/getModelFamily.md)
- [Family details](https://docs.neuronsearchlab.com/api-reference/platform-api/model-families/getModelFamilyDetails.md)
- [List model families](https://docs.neuronsearchlab.com/api-reference/platform-api/model-families/listModelFamilies.md)
- [Family lifecycle action](https://docs.neuronsearchlab.com/api-reference/platform-api/model-families/modelFamilyLifecycle.md): Promote, deprecate, or retire a model family version.
- [Create model metadata](https://docs.neuronsearchlab.com/api-reference/platform-api/models/createModel.md)
- [Delete model](https://docs.neuronsearchlab.com/api-reference/platform-api/models/deleteModel.md)
- [Retrieve model](https://docs.neuronsearchlab.com/api-reference/platform-api/models/getModel.md)
- [List models](https://docs.neuronsearchlab.com/api-reference/platform-api/models/listModels.md)
- [Update model](https://docs.neuronsearchlab.com/api-reference/platform-api/models/updateModel.md)
- [Create pipeline](https://docs.neuronsearchlab.com/api-reference/platform-api/pipelines/createPipeline.md)
- [Delete pipeline](https://docs.neuronsearchlab.com/api-reference/platform-api/pipelines/deletePipeline.md)
- [Retrieve pipeline](https://docs.neuronsearchlab.com/api-reference/platform-api/pipelines/getPipeline.md)
- [List pipelines](https://docs.neuronsearchlab.com/api-reference/platform-api/pipelines/listPipelines.md)
- [Update pipeline](https://docs.neuronsearchlab.com/api-reference/platform-api/pipelines/updatePipeline.md)
- [Read rerank controls](https://docs.neuronsearchlab.com/api-reference/platform-api/rerank-controls/getRerankControls.md)
- [Save rerank controls](https://docs.neuronsearchlab.com/api-reference/platform-api/rerank-controls/saveRerankControls.md)
- [Create rule](https://docs.neuronsearchlab.com/api-reference/platform-api/rules/createRule.md)
- [Delete rule](https://docs.neuronsearchlab.com/api-reference/platform-api/rules/deleteRule.md)
- [Retrieve rule](https://docs.neuronsearchlab.com/api-reference/platform-api/rules/getRule.md)
- [List rules](https://docs.neuronsearchlab.com/api-reference/platform-api/rules/listRules.md)
- [Update rule](https://docs.neuronsearchlab.com/api-reference/platform-api/rules/updateRule.md)
- [Console-wide search](https://docs.neuronsearchlab.com/api-reference/platform-api/search/consoleSearch.md)
- [Create segment](https://docs.neuronsearchlab.com/api-reference/platform-api/segments/createSegment.md)
- [Delete segment](https://docs.neuronsearchlab.com/api-reference/platform-api/segments/deleteSegment.md)
- [Retrieve segment](https://docs.neuronsearchlab.com/api-reference/platform-api/segments/getSegment.md)
- [List segments](https://docs.neuronsearchlab.com/api-reference/platform-api/segments/listSegments.md)
- [Update segment](https://docs.neuronsearchlab.com/api-reference/platform-api/segments/updateSegment.md)
- [Create serving endpoint](https://docs.neuronsearchlab.com/api-reference/platform-api/serving-endpoints/createModelEndpoint.md)
- [Delete serving endpoint](https://docs.neuronsearchlab.com/api-reference/platform-api/serving-endpoints/deleteModelEndpoint.md)
- [List serving endpoints](https://docs.neuronsearchlab.com/api-reference/platform-api/serving-endpoints/listModelEndpoints.md)
- [Update serving endpoint](https://docs.neuronsearchlab.com/api-reference/platform-api/serving-endpoints/updateModelEndpoint.md)
- [Current team metadata](https://docs.neuronsearchlab.com/api-reference/platform-api/team/getTeam.md)
- [Invite team member](https://docs.neuronsearchlab.com/api-reference/platform-api/team/inviteTeamMember.md)
- [Approve training job](https://docs.neuronsearchlab.com/api-reference/platform-api/training/approveTrainingJob.md)
- [Resolve training job endpoint](https://docs.neuronsearchlab.com/api-reference/platform-api/training/getTrainingJobEndpoint.md)
- [Training job logs](https://docs.neuronsearchlab.com/api-reference/platform-api/training/getTrainingJobLogs.md)
- [Training job metrics](https://docs.neuronsearchlab.com/api-reference/platform-api/training/getTrainingJobMetrics.md)
- [List training jobs](https://docs.neuronsearchlab.com/api-reference/platform-api/training/listTrainingJobs.md)
- [Promote training job](https://docs.neuronsearchlab.com/api-reference/platform-api/training/promoteTrainingJob.md)
- [Start training run](https://docs.neuronsearchlab.com/api-reference/platform-api/training/startTraining.md)
- [Stop training job](https://docs.neuronsearchlab.com/api-reference/platform-api/training/stopTrainingJob.md)
- [Streaming training logs](https://docs.neuronsearchlab.com/api-reference/platform-api/training/streamTrainingJobLogs.md): Server-sent events stream of live log lines.
- [Update training job](https://docs.neuronsearchlab.com/api-reference/platform-api/training/updateTrainingJob.md)
- [Authentication](https://docs.neuronsearchlab.com/authentication.md): Secure access to NeuronSearchLab APIs and SDKs.
- [Changelog](https://docs.neuronsearchlab.com/changelog.md): Release history for the NeuronSearchLab console, SDKs, and MCP server.
- [Console Changelog](https://docs.neuronsearchlab.com/changelog/console.md): Release history for the NeuronSearchLab admin console.
- [MCP Changelog](https://docs.neuronsearchlab.com/changelog/mcp.md): Release history for the NeuronSearchLab MCP server.
- [SDK Changelog](https://docs.neuronsearchlab.com/changelog/sdk.md): Release history for the NeuronSearchLab TypeScript and PHP SDKs.
- [Connect Your Data](https://docs.neuronsearchlab.com/connect-your-data.md): Prepare your catalog, contexts, and events for NeuronSearchLab.
- [Contexts](https://docs.neuronsearchlab.com/contexts.md): Model the experiences where recommendations appear.
- [Generate Recommendations](https://docs.neuronsearchlab.com/generate-recommendations.md): Request personalized results from the API or official JavaScript and PHP SDKs.
- [A/B Testing](https://docs.neuronsearchlab.com/guides/ab-testing.md): Run controlled experiments to compare ranking strategies and measure their impact on user engagement.
- [Analytics](https://docs.neuronsearchlab.com/guides/analytics.md): Understand how your recommendation engine is performing and use data to guide configuration decisions.
- [API Keys](https://docs.neuronsearchlab.com/guides/api-keys.md): Create Bearer tokens for programmatic access to the NeuronSearchLab console API.
- [Configuring Contexts](https://docs.neuronsearchlab.com/guides/contexts.md): Define retrieval defaults and pre-query filters for each recommendation surface.
- [Configuring Events and Signal Templates](https://docs.neuronsearchlab.com/guides/events.md): Define the user actions that teach the recommendation engine what matters, and group them into reusable training templates.
- [Explainability](https://docs.neuronsearchlab.com/guides/explainability.md): Debug why a specific item was recommended to a specific user by inspecting scores, rules, and pipeline stages.
- [How-To: Connect Catalog and Events](https://docs.neuronsearchlab.com/guides/how-to-connect-catalog-and-events.md): Set up reliable item ingestion and event tracking for recommendation quality.
- [How-To: Launch a New Context](https://docs.neuronsearchlab.com/guides/how-to-launch-a-new-context.md): Create and release a new recommendation surface with context-specific logic.
- [How-To: Measure Recommendation Performance](https://docs.neuronsearchlab.com/guides/how-to-measure-recommendation-performance.md): Track recommendation outcomes and iterate on contexts with analytics.
- [How-To: Serve Personalized Recommendations](https://docs.neuronsearchlab.com/guides/how-to-serve-recommendations.md): Implement real-time recommendation serving for web and mobile product surfaces.
- [Models](https://docs.neuronsearchlab.com/guides/models.md): Manage the trained models that power your recommendations and control which version is live in production.
- [Pipeline Config](https://docs.neuronsearchlab.com/guides/pipeline-config.md): Configure the multi-stage recommendation pipeline — enable or disable stages, set candidate limits, and control page sizes.
- [Quick Search](https://docs.neuronsearchlab.com/guides/quick-search.md): Use Cmd/Ctrl+K to search pages, rules, pipelines, experiments, users, and items from anywhere in the console.
- [Rerank Controls](https://docs.neuronsearchlab.com/guides/rerank-controls.md): Configure reranking behaviour per context to tune relevance and personalisation.
- [Rules Engine](https://docs.neuronsearchlab.com/guides/rules-engine.md): Create post-scoring ranking rules that boost, bury, pin, filter, cap, dedupe, reorder, group, and otherwise reshape recommendation results.
- [Scenarios and Walkthroughs](https://docs.neuronsearchlab.com/guides/scenarios.md): Step-by-step examples showing how to combine segments, rules, scheduling, pipelines, and A/B testing to achieve real business goals.
- [NeuronSearchLab AI](https://docs.neuronsearchlab.com/guides/studio-workflow.md): Use the built-in AI assistant to manage your recommendation engine through natural language conversation.
- [User Segments](https://docs.neuronsearchlab.com/guides/user-segments.md): Define user cohorts by behaviour, demographics, or item interactions and use them to target ranking rules.
- [Exploring Users and Items](https://docs.neuronsearchlab.com/guides/users-and-items.md): Inspect your catalog and user embeddings to understand how the engine sees your data.
- [Introduction](https://docs.neuronsearchlab.com/introduction.md): NeuronSearchLab is your engine for fast, flexible, and intelligent recommendations.
- [Quickstart](https://docs.neuronsearchlab.com/quickstart.md): Start building with NeuronSearchLab in just a few minutes
- [JavaScript SDK](https://docs.neuronsearchlab.com/sdk/introduction.md): Install, configure, and use the official NeuronSearchLab JavaScript SDK in your applications.
- [MCP Integration](https://docs.neuronsearchlab.com/sdk/mcp.md): Connect NeuronSearchLab to AI assistants like Claude, Cursor, and Windsurf using the Model Context Protocol.
- [PHP SDK](https://docs.neuronsearchlab.com/sdk/php.md): Install, configure, and use the official NeuronSearchLab PHP SDK in Laravel or any PHP application.

## OpenAPI Specs

- [openapi](https://docs.neuronsearchlab.com/api-reference/openapi.json)
- [NeuronSearchLab-API-prod-oas30](https://docs.neuronsearchlab.com/api-reference/NeuronSearchLab-API-prod-oas30.json)
- [platform-openapi](https://docs.neuronsearchlab.com/api-reference/platform-openapi.json)

## Optional

- [Console](https://console.neuronsearchlab.com/login)
- [GitHub](https://github.com/neuronsearchlab)
- [Support](mailto:contact@neuronsearchlab.com)