Getting Started | Neurologyca

This page is the fastest way to decide which Neurologyca API you should integrate with. Start with the user experience you want to build, then follow the corresponding section for setup details and endpoint-level documentation.

Start with your use case

I have a recorded video

Use the SoftSkills API if you want to upload one completed video file and receive structured feedback.

I want a coaching chat

Use the Agents API if you want sessions, conversation history, and assistant replies in your app.

I process live sessions

Use the Engine API if your workflow uploads session packages over time and retrieves final analysis later.

Choose the right integration path

If your use case is…	Choose this API	Why	First endpoint
Upload a single recorded presentation or practice video	SoftSkills API	Simplest external integration for standard or combined recorded-video analysis	`POST /api/v1/analyze-video` or `POST /api/v1/full-analysis`
Add a Neurologyca-powered assistant or coach to your product	Agents API	Supports session creation, history retrieval, and traced responses	`POST /api/v1/auth/firebase`
Run a live or step-based assessment pipeline	Engine API	Built for session creation, `.kpn` processing, and final Constellation insights	`POST /session`

Decision guide

Use SoftSkills API when

Your app already has a finished video file.
You want a JSON response with scores and recommendations, or the extended combined analysis payload.
You prefer an API-key-based integration with minimal state management.

Use Agents API when

You are building a conversational UI.
You need persistent sessions and conversation history.
You want the assistant reply plus per-agent traces from the orchestration layer.

Use Engine API when

You capture session data incrementally instead of sending one final file.
Your client can produce .kpn packages.
You need a session token first, then upload processing inputs, then fetch final analysis.

What you will need before integrating

SoftSkills API: a Neurologyca API key from the dashboard and a supported video file.
Agents API: an authenticated user flow that can send bearer tokens to the Agent backend.
Engine API: tenant credentials for POST /session and the ability to upload .kpn packages.

Suggested next step

Pick the API that matches your product flow, not just the data format you have today.
Read that section’s overview page to understand the workflow and authentication model.
Move into the API reference once you are ready to implement endpoint calls.