Skip to main content
POST
/
api
/
velma-2-batch
Run velma-2 batch analysis on an uploaded audio file.
curl --request POST \
  --url https://modulate-developer-apis.com/api/velma-2-batch \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form upload_file='@example-file' \
  --form config=default
{
  "duration_ms": 1,
  "clips": [
    {
      "clip_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "text": "<string>",
      "start_ms": 1,
      "duration_ms": 1,
      "speaker_label": "<string>",
      "language": "<string>",
      "emotion": "<string>",
      "accent": "<string>",
      "deepfake_score": 0.5
    }
  ],
  "behaviors": [
    {
      "behavior_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "behavior_name": "<string>",
      "speaker_label": "<string>",
      "detected": true,
      "confidence": 0.5,
      "evidence_clip_uuids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "definitive_clip_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reasoning": "<string>",
      "skipped": false,
      "skip_reason": "<string>",
      "error_reason": "<string>"
    }
  ],
  "conversation_type_pick": {
    "conversation_type_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "confidence": 0.5,
    "detail": "<string>",
    "reasoning": "<string>"
  },
  "participant_role_picks": [
    {
      "speaker_label": "<string>",
      "participant_role_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "confidence": 0.5,
      "detail": "<string>",
      "reasoning": "<string>"
    }
  ],
  "topics": [
    "<string>"
  ],
  "topic_sentiments": [
    {
      "topic": "<string>",
      "speaker_label": "<string>",
      "sentiment_score": 0,
      "sentiment_label": "<string>"
    }
  ],
  "summary": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key used for authentication and usage tracking.

Body

multipart/form-data
​
upload_file
file
required

Audio file. Max 100 MB. Supported extensions: aac, aiff, flac, mp3, mp4, mov, ogg, opus, wav, webm.

​
config
string
default:default

Either the literal string default (which loads a built-in default configuration) or a JSON-encoded BatchConfig object (see schema). When omitted the default configuration is used. Sent as a string form field because multipart/form-data has no first-class object type.

Response

Batch processing completed.

​
duration_ms
integer
required
Required range: x >= 0
​
clips
object[]
required
​
behaviors
object[]
required
​
conversation_type_pick
object
​
participant_role_picks
object[]
​
topics
string[]
​
topic_sentiments
object[]
​
summary
string | null