This set of endpoints helps manage the calls, getting their summary and other details.
Initiate an instant call for an application
Trigger an immediate phone call for a candidate associated with a specific application using the application ID. This endpoint is typically used to initiate an interview or contact attempt directly through the system.
path Parameters
application_idstring · requiredThe ID of the application for which the instant call is triggered
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Instant call triggered successfully
statusstringStatus of the call trigger
call_idstringUnique ID of the triggered call
Retrieve call details for a specific call
The Call detail endpoint provides details about a specific call, including its status, intelligence assessment, summary, transcript, and detailed question responses.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful response containing complete details of the call.
call_idstring · requiredUnique identifier for the call.
call_statusstring · enum · requiredThe status of the call.
Enum values:call_completedcall_in_progresscall_failedninjahire_intelligencestring · enum · requiredThe intelligence assessment of the call.
Enum values:call_successcall_failedcall_inconclusive
call_directionstring · enumDirection of the call.
Enum values:outgoingincomingrecording_urlstring · uriThe URL to the recording of the call.
call_scoreinteger · min: 0 · max: 100The overall score of the call assessment (0-100).
call_summaryobjectDetailed breakdown of the call assessment by category.
call_digeststringA comprehensive summary of the call assessment and candidate evaluation.
transcriptstringFull transcript of the call conversation with speaker labels (BOT/HUMAN).
questions_responsestringJSON string array containing individual questions, responses, and their scores.
Retrieve all calls
Get all calls with optional filtering by job, candidate, or application. Returns a paginated list of calls with their basic information.
query Parameters
pageinteger · min: 0 · requiredPage number (0-indexed)
sizeinteger · min: 1 · max: 100 · requiredNumber of items per page
job_idstring · uuidFilter by job UUID
candidate_idstring · uuidFilter by candidate UUID
application_idstring · uuidFilter by application UUID
application_source_idstringFilter by source ID of the application
job_source_idstringFilter by source ID of the job
candidate_source_idstringFilter by source ID of the candidate
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Successful operation returning paginated list of calls
dataobject[] · requiredA list of calls retrieved.
countinteger · requiredTotal number of calls matching the query across all pages.