SoftSkillsAPI Reference

Analyze Video

Upload a recorded video file. The API analyzes it and returns a structured JSON response with scores (likeability, authenticity, clarity, confidence), strengths, areas for improvement, detailed feedback, and more.

Authentication

AuthorizationBearer

Your API key (e.g. ng_xxx…). The Try it and generated code send it as Authorization: Bearer <key>. Alternatively use the X-API-Key header with the raw key.

Request

This endpoint expects a multipart form containing a file.
videofileRequired

Video file to analyze (MP4, WebM, MOV, AVI, MKV)

Response

Analysis result
overall_scoredouble
Overall performance score from 0 to 100.
category_scoresobject

Per-category scores (likeability, authenticity, clarity, confidence), typically 0–10 each.

strengthslist of strings
List of identified strengths in the delivery.
areas_for_improvementlist of strings
Suggested areas for improvement.
filler_word_countinteger

Total count of filler words (e.g. um, uh) detected in the video.

speaking_pace_wpmdouble
Speaking pace in words per minute.
key_momentslist of any

Notable moments or highlights in the video (if provided).

labeled_momentslist of objects
Timestamped moments with a label and transcribed text.
time_series_scoreslist of objects

Scores per category at regular time intervals (e.g. every 10 seconds).

detailed_feedbackstring
Narrative feedback on the performance.
session_summarystring
Short summary of the session content and performance.
recommendationstring
Actionable recommendation based on the analysis.
sessionIdstring or null

The session ID assigned to this analysis. Use this to retrieve the session later via GET /api/v1/sessions/{session_id}. Null if the session could not be persisted.

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error