API Reference
Health
Evaluation
Simulation
Metric Definitions
Create call evaluation job
Create a evaluation job for a single call or dataset of calls
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const response = await client.evaluation.createJob({ evaluators: ['string'] });
console.log(response.data);{
"data": {
"jobId": "<string>",
"status": "PENDING",
"callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
List of evaluators slugs to evaluate the calls or "all" to evaluate all evaluators
1Call input to evaluate
Show child attributes
Show child attributes
URL of source recording (must be an accessible WAV, MP3, or MP4 file). Can be a signed URL.
When the call started (ISO 8601 format)
Interface type of the call (PHONE or WEB)
PHONE, WEB Direction of the call (INBOUND or OUTBOUND)
INBOUND, OUTBOUND Exactly two participants in the call
1Show child attributes
Show child attributes
AGENT, CUSTOMER 13URL of source stereo recording. Must be accessible. Can be a signed URL. While optional it allows for a richer audio player. Supported formats: WAV, MP3, MP4.
High-level call end status, indicating how the call terminated
PARTICIPANTS_DID_NOT_SPEAK, AGENT_DID_NOT_ANSWER, AGENT_DID_NOT_SPEAK, AGENT_STOPPED_SPEAKING, AGENT_ENDED_CALL, AGENT_TRANSFERRED_CALL, AGENT_BUSY, AGENT_ERROR, CUSTOMER_ENDED_CALL, VOICE_MAIL_REACHED, SILENCE_TIME_OUT, PHONE_CALL_PROVIDER_CONNECTION_ERROR, CUSTOMER_DID_NOT_ANSWER, CUSTOMER_DID_NOT_SPEAK, CUSTOMER_STOPPED_SPEAKING, CUSTOMER_BUSY, DIAL_ERROR, MAX_DURATION_REACHED, UNKNOWN Additional context on why the call terminated with the endedStatus
List of tool invocations made during the call
Show child attributes
Show child attributes
Name of the tool that was invoked
Parameters provided to the tool during invocation
Show child attributes
Show child attributes
Result returned by the tool after execution. Can be a string or a JSON object
Offset in milliseconds from the start of the call when the tool was invoked
Description of when the tool should be invoked
Offset in milliseconds from the start of the call when the tool execution completed. Used to calculate duration of the tool execution
Whether this is a test call
Vapi call ID if call is being imported from Vapi
Retell call ID if call is being imported from Retell
Show child attributes
Show child attributes
Name of the dataset
List of calls input to evaluate
Show child attributes
Show child attributes
URL of source recording (must be an accessible WAV, MP3, or MP4 file). Can be a signed URL.
When the call started (ISO 8601 format)
Interface type of the call (PHONE or WEB)
PHONE, WEB Direction of the call (INBOUND or OUTBOUND)
INBOUND, OUTBOUND Exactly two participants in the call
1Show child attributes
Show child attributes
AGENT, CUSTOMER 13URL of source stereo recording. Must be accessible. Can be a signed URL. While optional it allows for a richer audio player. Supported formats: WAV, MP3, MP4.
High-level call end status, indicating how the call terminated
PARTICIPANTS_DID_NOT_SPEAK, AGENT_DID_NOT_ANSWER, AGENT_DID_NOT_SPEAK, AGENT_STOPPED_SPEAKING, AGENT_ENDED_CALL, AGENT_TRANSFERRED_CALL, AGENT_BUSY, AGENT_ERROR, CUSTOMER_ENDED_CALL, VOICE_MAIL_REACHED, SILENCE_TIME_OUT, PHONE_CALL_PROVIDER_CONNECTION_ERROR, CUSTOMER_DID_NOT_ANSWER, CUSTOMER_DID_NOT_SPEAK, CUSTOMER_STOPPED_SPEAKING, CUSTOMER_BUSY, DIAL_ERROR, MAX_DURATION_REACHED, UNKNOWN Additional context on why the call terminated with the endedStatus
List of tool invocations made during the call
Show child attributes
Show child attributes
Name of the tool that was invoked
Parameters provided to the tool during invocation
Show child attributes
Show child attributes
Result returned by the tool after execution. Can be a string or a JSON object
Offset in milliseconds from the start of the call when the tool was invoked
Description of when the tool should be invoked
Offset in milliseconds from the start of the call when the tool execution completed. Used to calculate duration of the tool execution
Whether this is a test call
Vapi call ID if call is being imported from Vapi
Retell call ID if call is being imported from Retell
Response
Created evaluation job
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const response = await client.evaluation.createJob({ evaluators: ['string'] });
console.log(response.data);{
"data": {
"jobId": "<string>",
"status": "PENDING",
"callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}