Skip to content

List this tenant's voice profiles

GET
/v1/voice-profiles
curl --request GET \
--url 'https://api.vocapable.com/v1/voice-profiles?limit=50' \
--header 'Authorization: Bearer <token>'
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string
created_at
Any of:
string

Filter on created_at. Comma-separated values are OR.

created_at.gte
Any of:
string

Filter on created_at with the gte operator.

created_at.lte
Any of:
string

Filter on created_at with the lte operator.

created_at.gt
Any of:
string

Filter on created_at with the gt operator.

created_at.lt
Any of:
string

Filter on created_at with the lt operator.

created_at.in
Any of:
string

Filter on created_at with the in operator.

language
Any of:
string

Filter on language. Comma-separated values are OR.

language.gte
Any of:
string

Filter on language with the gte operator.

language.lte
Any of:
string

Filter on language with the lte operator.

language.gt
Any of:
string

Filter on language with the gt operator.

language.lt
Any of:
string

Filter on language with the lt operator.

language.in
Any of:
string

Filter on language with the in operator.

status
Any of:
string

Filter on status. Comma-separated values are OR.

status.gte
Any of:
string

Filter on status with the gte operator.

status.lte
Any of:
string

Filter on status with the lte operator.

status.gt
Any of:
string

Filter on status with the gt operator.

status.lt
Any of:
string

Filter on status with the lt operator.

status.in
Any of:
string

Filter on status with the in operator.

Successful Response

Media typeapplication/json
CursorPage[VoiceProfileSummary]
object
data
required
Data
Array<object>
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
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
"data": [
{
"status": "pending_review"
}
],
"has_more": false
}

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": {}
}
]
}