test_framework

Correct an audio clip's transcript and word timings

Changed on

Correct an audio clip's transcript and word timings

patch/test_framework/v1/scenarios/{id}/condition-audio/{audio_id}/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v1/scenarios/{id}/condition-audio/{audio_id}/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Path parameters

idinteger required

A unique integer value identifying this scenario.

audio_idstring required

Request body

transcriptstring

What the clip actually says, as plain text. The testing agent records these words as what it said when the clip plays, and speaks them if the audio cannot be loaded. Only a clip whose status is ready can be edited; replacing its audio transcribes it again and discards the edit.

Response

audio_idstring nullable
actionstring nullable
condition_idstring

First condition referencing this clip, or null when no action references it. Kept for compatibility - prefer condition_ids.

condition_idsinteger[]

Every condition referencing this clip, in authored order. Empty when the clip is uploaded but not referenced by any action yet.

stepsstring

Every step referencing this clip, as paths into the conditional actions (e.g. first_message, conditions[1].then[0]).

tagstring

The reference to paste into an action, e.g. <audio id="greeting"/>

statusstring nullable
transcriptstring nullable
durationnumber double nullable
filenamestring nullable
timing_sourcestring nullable

Where the word timings came from: deepgram (measured), interpolated (spread evenly), or manual (sent with a transcript edit).

errorstring nullable
updated_atstring nullable
playback_urlstring

S3 URL of the recorded audio clip

Changes