Skip to main content
POST
Complete Clarity Image Upload

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

id
string<uuid>
required

The clarity process ID

captureId
string<uuid>
required

The capture ID

Body

application/json
fileName
string
required

Name of the uploaded image file

Minimum string length: 1

Response

Default Response

id
string<uuid>
required
processId
string<uuid>
required
userId
string<uuid>
required
type
string
required
videoUrl
string | null
required
videoTranscript
string | null
required
transcript
object[] | null
required
status
enum<string>
required
Available options:
pending,
recording,
processing,
complete,
failed
usabilityStatus
enum<string>
default:usable
required
Available options:
usable,
excluded
usabilityReason
string | null
required
usabilitySource
enum<string> | null
required
Available options:
agent,
interviewee,
manager
usabilityConfidence
enum<string> | null
required
Available options:
high,
medium,
low
createdAt
string
required
updatedAt
string
required
userName
string
documentFileName
string | null
documentTextMetadata
object | null
hasTranscript
boolean
hasVideoTranscript
boolean
transcriptQuestionCount
integer
Required range: 0 <= x <= 9007199254740991