Skip to main content
POST
/
v1
/
call-analysis
Submit a call recording for analysis
curl --request POST \
  --url https://api.example.com/v1/call-analysis \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'external_id=<string>' \
  --form 'agent_id=<string>' \
  --form 'agent_name=<string>' \
  --form 'model_name=<string>' \
  --form audio_file='@example-file' \
  --form 'additional_parameters=<string>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "external_id": "CALL-2024-001234",
  "status": "PENDING",
  "enabled": true,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "agent_id": "AGT-001",
  "agent_name": "John Smith",
  "model_id": 1,
  "error_message": "<string>",
  "original_file_name": "support_call_20240115.mp3",
  "additional_parameters": {
    "campaign": "Q4_Retention",
    "department": "Support"
  },
  "analysis_result": {},
  "neurascore_result": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Opening",
      "total_score": 45,
      "expected_total_score": 50,
      "score_percentage": 90,
      "expected_score_percentage": 100,
      "variables": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "greeting_quality",
          "readable_name": "Greeting Quality",
          "description": "Evaluates the warmth and professionalism of the agent's greeting",
          "score": 8,
          "expected_score": 10
        }
      ]
    }
  ],
  "total_score": 425,
  "expected_score": 500,
  "score_percentage": 85,
  "summary": "The agent handled a billing inquiry efficiently, resolving the customer's concern about an unexpected charge.",
  "insights": [
    "Agent demonstrated excellent product knowledge",
    "Consider offering proactive follow-up"
  ],
  "keywords": [
    "billing",
    "refund",
    "subscription",
    "satisfaction"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
external_id
string
required

Your unique identifier for this call (e.g., CRM call ID)

​
agent_id
string
required

Identifier of the agent who handled the call

​
agent_name
string
required

Display name of the agent

​
model_name
string
required

Name of the analysis model to use for evaluation

​
audio_file
file
required

Audio file to analyze (MP3, WAV, M4A, FLAC, OGG, WEBM)

​
additional_parameters
string

JSON string with custom metadata (e.g., campaign, department)

Response

Successful Response

Complete call analysis result with scores, insights, and metadata

​
id
string<uuid>
required

Unique identifier for this analysis

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
external_id
string
required

Your reference ID for this call

Example:

"CALL-2024-001234"

​
status
enum<string>
required

Current processing status: PENDING, PROCESSING, COMPLETED, or FAILED

Available options:
PENDING,
AUDIO_CONVERSION_IN_PROGRESS,
AUDIO_CONVERTED,
AUDIO_TRANSCRIPTION_IN_PROGRESS,
AUDIO_TRANSCRIBED,
TRANSCRIPTION_ANALYZE_IN_PROGRESS,
TRANSCRIPTION_ANALYZED,
TRANSCRIPTION_SUMMARIZE_IN_PROGRESS,
TRANSCRIPTION_SUMMARIZED,
TRANSCRIPTION_FAILED,
PROCESS_COMPLETED,
ERROR
​
enabled
boolean
required

Whether this record is active

Example:

true

​
created_at
string<date-time>
required

Timestamp when analysis was created (UTC)

​
created_by
string
required

System identifier that created this record

​
agent_id
string

Identifier of the agent who handled the call

Example:

"AGT-001"

​
agent_name
string

Display name of the agent

Example:

"John Smith"

​
model_id
integer

ID of the analysis model used for evaluation

Example:

1

​
error_message
string

Error details if status is FAILED

​
original_file_name
string

Name of the uploaded audio file

Example:

"support_call_20240115.mp3"

​
additional_parameters
Additional Parameters · object

Custom metadata provided during submission

Example:
{
  "campaign": "Q4_Retention",
  "department": "Support"
}
​
analysis_result
Analysis Result · object

Extracted variables and data from the analysis

​
neurascore_result
Category · object[]

Detailed scoring breakdown organized by evaluation categories

​
total_score
integer

Total achieved score across all categories

Example:

425

​
expected_score
integer

Maximum possible total score

Example:

500

​
score_percentage
number

Overall achievement percentage (0-100)

Example:

85

​
summary
string

AI-generated summary of the conversation

Example:

"The agent handled a billing inquiry efficiently, resolving the customer's concern about an unexpected charge."

​
insights
string[]

Key observations and recommendations from the analysis

Example:
[
  "Agent demonstrated excellent product knowledge",
  "Consider offering proactive follow-up"
]
​
keywords
string[]

Key topics and themes discussed in the call

Example:
[
  "billing",
  "refund",
  "subscription",
  "satisfaction"
]
​
updated_at
string<date-time>

Timestamp of last update (UTC)

​
updated_by
string

System identifier that last updated this record