# Get all English texts
curl -X GET "https://api.voxmind.ai/organisations/42/predefined-texts?filter=language=en-UK" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
resp = requests.get(
"https://api.voxmind.ai/organisations/42/predefined-texts",
headers={"Authorization": "Bearer YOUR_API_TOKEN"},
params={"filter": "language=en-UK"},
)
texts = resp.json()["results"]
{
"results": [
{
"id": 21,
"org_id": 42,
"language": "en-UK",
"text_code": 1,
"text": "Please say your full name to register your voice.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
},
{
"id": 22,
"org_id": 42,
"language": "en-UK",
"text_code": 2,
"text": "Please say your name and account number to verify your identity.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
}
]
}
Devices & Texts
List Predefined Texts
Retrieve all custom text prompts configured for your organisation, used to guide users during enrollment and verification.
GET
/
organisations
/
{orgId}
/
predefined-texts
# Get all English texts
curl -X GET "https://api.voxmind.ai/organisations/42/predefined-texts?filter=language=en-UK" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
resp = requests.get(
"https://api.voxmind.ai/organisations/42/predefined-texts",
headers={"Authorization": "Bearer YOUR_API_TOKEN"},
params={"filter": "language=en-UK"},
)
texts = resp.json()["results"]
{
"results": [
{
"id": 21,
"org_id": 42,
"language": "en-UK",
"text_code": 1,
"text": "Please say your full name to register your voice.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
},
{
"id": 22,
"org_id": 42,
"language": "en-UK",
"text_code": 2,
"text": "Please say your name and account number to verify your identity.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
}
]
}
Overview
Predefined texts are the voice prompts or on-screen instructions you configure to guide users through enrollment and verification. Because Voxmind is text-independent, users can say anything — but in a well-designed authentication UX, you’ll want to present them with a specific prompt that feels natural and consistent with your application. For example, a contact centre might configure: “Please say your name and account reference to verify your identity.” A banking app might use: “Please say your passphrase to confirm this transaction.” Each text is associated with a language code and atext_code integer that you define to categorise it (e.g. 1 = enrollment prompt, 2 = verification prompt).
Predefined texts are entirely optional configuration. If you don’t configure any, Voxmind still processes voice data correctly — you’d simply handle the user-facing prompt within your own application UI.
Path Parameters
string
required
Your organisation’s unique identifier.
Query Parameters
string
Filter texts. Example:
filter=language=en-UK for all English texts, or filter=text_code=1 for all enrollment prompts.string
Sort order. Example:
sort=language:ascinteger
default:"100"
Results per page. Maximum 300.
integer
default:"1"
Page number.
# Get all English texts
curl -X GET "https://api.voxmind.ai/organisations/42/predefined-texts?filter=language=en-UK" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
resp = requests.get(
"https://api.voxmind.ai/organisations/42/predefined-texts",
headers={"Authorization": "Bearer YOUR_API_TOKEN"},
params={"filter": "language=en-UK"},
)
texts = resp.json()["results"]
{
"results": [
{
"id": 21,
"org_id": 42,
"language": "en-UK",
"text_code": 1,
"text": "Please say your full name to register your voice.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
},
{
"id": 22,
"org_id": 42,
"language": "en-UK",
"text_code": 2,
"text": "Please say your name and account number to verify your identity.",
"created_at": "2025-02-01T09:00:00Z",
"updated_at": "2025-02-01T09:00:00Z"
}
]
}