List Phrases

List the phrases in a custom model. Results are paginated. See the Custom Models guide for how phrases affect transcription.

GET https://api.reson8.dev/v1/custom-model/{id}/phrases

Request

Headers

Header	Value
Authorization	ApiKey <api_key> or Bearer <access_token>

See Authentication for which header to use in different situations.

Path Parameters

Parameter	Type	Description
id	string	ID of the custom model

Query Parameters

Parameter	Type	Default	Description
page	number	0	Zero-based page index
size	number	100	Page size (between 1 and 10000)

Example

curl

curl "https://api.reson8.dev/v1/custom-model/a1b2c3d4-e5f6-7890-abcd-ef1234567890/phrases?page=0&size=100" \
  -H "Authorization: ApiKey <your_api_key>"

Python

import requests

response = requests.get(
    "https://api.reson8.dev/v1/custom-model/a1b2c3d4-e5f6-7890-abcd-ef1234567890/phrases",
    headers={"Authorization": "ApiKey <your_api_key>"},
    params={"page": 0, "size": 100},
)

phrases = response.json()

Response

200 OK

Field	Type	Description
phrases	object[]	Phrases on this page
phrases[].value	string	The phrase text
page	number	Zero-based index of the returned page
size	number	Page size used
total	number	Total number of phrases in the custom model

Example

{
  "phrases": [
    { "value": "myocardial infarction" },
    { "value": "atrial fibrillation" },
    { "value": "echocardiogram" }
  ],
  "page": 0,
  "size": 100,
  "total": 3
}

Errors

Status	Description
400 Bad Request	Invalid pagination parameters
401 Unauthorized	Missing or invalid credentials
404 Not Found	Custom model not found
500 Internal Server Error	Unexpected server error