Skip to content

List PhrasesView as MarkdownView this page as plain textOpen in ClaudeAsk questions about this pageOpen in ChatGPTAsk questions about this page

List the phrases in a custom model. Results are paginated.

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

Request

Headers

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

Path Parameters

Parameter Type Description
id string ID of the custom model

Query Parameters

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

Example

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

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 Code Description
400 INVALID_REQUEST Invalid pagination parameters
401 UNAUTHORIZED Invalid or expired credentials
404 NOT_FOUND Custom model not found
500 INTERNAL_ERROR Unexpected server error