Skip to main content

instinct api documentation

Welcome to the official API documentation for the Nexstem Instinct headset. This documentation provides comprehensive guides, references, and tutorials for developers working with the Instinct platform.

api overview​

important

The Instinct API server runs exclusively on the Instinct headset and is the only way to interact with the device. There is no separate server or cloud-based API available.

The Instinct API provides a unified interface for interacting with the headset, offering capabilities for:

  • Data Processing: Create and manage data processing pipelines
  • Device Control: Configure and control the EEG headset
  • Data Acquisition: Stream EEG data
  • System Management: Monitor device status and health

These capabilities are provided through a single API with a consistent structure, making it simple to build comprehensive applications that utilize the full power of the Instinct headset.

base url​

All API requests should be made to the headset's local API server at:

http://localhost:42069

getting started​

  1. Connect to your Instinct headset using the companion app.
  2. Explore the Concepts section to understand the platform
  3. Follow our Guides & Tutorials for step-by-step instructions
  4. Review the API Reference for detailed endpoint information

documentation structure​

This documentation is organized into three main sections:

concepts​

This section explains the fundamental principles of the Instinct platform:

  • Headset Architecture: Overview of the headset components
  • EEG Streaming: How EEG data capture works
  • Data Pipelines: Understanding nodes, streams, and data processing

guides & tutorials​

This section provides practical guidance for working with the Instinct platform:

  • Tutorials: Step-by-step instructions for common tasks
  • Developer Guides: Best practices and common workflows
  • Troubleshooting: Solutions to common issues

api reference​

This section provides detailed technical information about the API:

  • Authentication: How to authenticate with the API
  • Error Handling: Understanding error responses
  • API Endpoints: Complete specifications for all endpoints

Use the navigation menu to explore these sections and find the information you need.