Skip to content

Read one voice profile

GET
/v1/voice-profiles/{profile_id}
curl --request GET \
--url https://api.vocapable.com/v1/voice-profiles/example \
--header 'Authorization: Bearer <token>'
profile_id
required
Profile Id
string

Successful Response

Media typeapplication/json
VoiceProfileSummary

A voice profile as its tenant sees it.

consent_proof_uri being null is exactly the gate: a profile cannot reach approved without one, enforced in the repository and again by a table CHECK constraint.

object
id
required
Id
string
name
required
Name
string
provider
required
Provider
string
language
Any of:
string
status
required
Status
string
Allowed values: pending_review approved rejected revoked
sample_recording_uri
Any of:
string
model_artifact_uri
Any of:
string
consent_proof_uri
Any of:
string
consent_verified_by
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
"status": "pending_review"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}