SoftSkills

Overview

This API provides recorded-session analysis for SoftSkills. You upload a video and receive either an immediate result for short videos or a job to poll for completion when processing needs to continue asynchronously.

What this API does

  • Surfaced endpoints: POST /api/v1/full-analysis and GET /api/v1/full-analysis/{session_id}.
  • Authentication: API keys only. Send either Authorization: Bearer ng_... or X-API-Key: ng_....
  • Flow: Upload video -> receive 200 sync result or 202 async job -> poll until complete if needed.

Main endpoints

PropertyValue
Submit analysisPOST /api/v1/full-analysis
Fetch statusGET /api/v1/full-analysis/{session_id}

Response behavior

EndpointBest forReturns
POST /api/v1/full-analysisStarting a recorded-session analysis200 with final analysis for short videos, or 202 with sessionId, optional jobId, and pollingUrl
GET /api/v1/full-analysis/{session_id}Fetching saved analysis stateIn-flight status, completed result, or failure details for the session

High-level workflow

  1. Create an API key in the dashboard (API Keys tab).
  2. Submit a multipart request with the required video field and any optional analysis parameters.
  3. Handle the response:
    • 200 means the final analysis is already available.
    • 202 means you should fetch the returned pollingUrl, which now resolves by sessionId.
  4. Fetch until terminal state if the run is async. Sessions can return pending, processing, complete, or failed.