Schemas

ErrorResponse

error

string · required

Human-readable error message

code

string

Machine-parseable stable error code

requestId

string

Gateway request identifier

HealthResponse

status

string · enum · required

Enum values:

version

string

VoiceUploadRequest

audio

string · binary · required

Raw voice recording (required). Must be sent as multipart/form-data file field named audio.

VoiceAnalysisResponse

id

string · required

transcript

string · required

createdAt

string · date-time · required

object

voiceType

string

object

duration

number

object

processingTime

number

notification

string | null

TextPayload

text

string · minLength: 1 · maxLength: 10000 · required

Text message for analysis

context

object

Optional context metadata forwarded to the model prompt

CoachingTextPayload

text

string · minLength: 1 · maxLength: 10000

Optional coaching question or topic

context

object

Optional context metadata forwarded to the model prompt

ChatResponse

response

string · required

CoachingResponse

advice

string · required

question

string · required

InsightsResponse

object | null · required

tips

string[] · required

milestone

string | null

HistoryItem

id

string · required

createdAt

string · date-time · required

transcript

string · required

duration

number

sentiment

string | number | null

HistoryResponse

object[] · required

Vocal Journaling API Gateway

Schemas

ErrorResponse

error

string · required

Human-readable error message

code

string

Machine-parseable stable error code

requestId

string

Gateway request identifier

HealthResponse

status

string · enum · required

Enum values:

version

string

VoiceUploadRequest

audio

string · binary · required

Raw voice recording (required). Must be sent as multipart/form-data file field named audio.

VoiceAnalysisResponse

id

string · required

transcript

string · required

createdAt

string · date-time · required

object

voiceType

string

object

duration

number

object

processingTime

number

notification

string | null

TextPayload

text

string · minLength: 1 · maxLength: 10000 · required

Text message for analysis

context

object

Optional context metadata forwarded to the model prompt

CoachingTextPayload

text

string · minLength: 1 · maxLength: 10000

Optional coaching question or topic

context

object

Optional context metadata forwarded to the model prompt

ChatResponse

response

string · required

CoachingResponse

advice

string · required

question

string · required

InsightsResponse

object | null · required

tips

string[] · required

milestone

string | null

HistoryItem

id

string · required

createdAt

string · date-time · required

transcript

string · required

duration

number

sentiment

string | number | null

HistoryResponse

object[] · required