Introduction

Overview

Choose the right Neurologyca API for your integration

Neurologyca currently exposes three different API patterns, each built for a different product experience. The right integration depends on whether you want to analyze a recorded video, embed a conversational coaching experience, or process live session data through the Engine pipeline.

SoftSkills API

Upload a recorded video and receive structured communication feedback as JSON.

Agents API

Build session-based chat and coaching experiences with traced multi-agent responses.

Engine API

Process live-session packages and retrieve Constellation insights after the session completes.

API options at a glance

APIBest forIntegration modelAuthenticationStart here
SoftSkills APIRecorded presentation or communication analysisSingle request/response workflowAPI key (Authorization: Bearer ng_... or X-API-Key)POST /api/v1/analyze-video or POST /api/v1/full-analysis
Agents APIChat, coaching, and guided conversational experiencesSession-based workflowBearer tokenPOST /api/v1/auth/firebase, then POST /api/v1/sessions
Engine APILive or step-based video session processingMulti-step pipelineEngine session token from POST /sessionPOST /session

Which API should you use?

  • Choose SoftSkills API if your application already has a finished video file and you want Neurologyca to return either a direct communication analysis or a combined advanced analysis with biometric outputs.
  • Choose Agents API if you want to embed a Neurologyca-powered assistant, preserve chat history, and display multi-agent traces or orchestration details in your UI.
  • Choose Engine API if your product captures a live assessment session, uploads .kpn packages over time, and needs a final Constellation analysis after processing completes.

Important integration differences

  • Auth is different for each API. SoftSkills uses API keys, Agents uses bearer auth from your application identity flow, and Engine uses the token returned when you create a session.
  • The request shapes are different. SoftSkills accepts multipart video uploads, Agents accepts JSON session and message payloads, and Engine accepts both JSON and multipart uploads with .kpn packages.
  • The workflow depth is different. SoftSkills is the simplest public integration, Agents is conversational and stateful, and Engine is designed for a staged processing pipeline.

Next step

If you already know your use case, go directly to the product section you need:

If you are still deciding, continue to Getting Started for a use-case-based guide.