Add Phrases

Add phrases to a custom model. Adding is idempotent: phrases already present are left unchanged and reported as skipped. See the Custom Models guide for guidance on choosing phrases.

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

Request

Headers

Header	Value
Authorization	ApiKey <api_key> or Bearer <access_token>
Content-Type	application/json

See Authentication for which header to use in different situations.

Path Parameters

Parameter	Type	Description
id	string	ID of the custom model

Body

Field	Type	Required	Description
phrases	string[]	Yes	Phrases to add (must not be empty)

Example

curl

curl -X POST "https://api.reson8.dev/v1/custom-model/a1b2c3d4-e5f6-7890-abcd-ef1234567890/phrases" \
  -H "Authorization: ApiKey <your_api_key>" \
  -H "Content-Type: application/json" \
  -d '{
    "phrases": ["pericarditis", "atrial fibrillation"]
  }'

Python

import requests

response = requests.post(
    "https://api.reson8.dev/v1/custom-model/a1b2c3d4-e5f6-7890-abcd-ef1234567890/phrases",
    headers={
        "Authorization": "ApiKey <your_api_key>",
        "Content-Type": "application/json",
    },
    json={"phrases": ["pericarditis", "atrial fibrillation"]},
)

result = response.json()

Response

200 OK

Field	Type	Description
added	number	Number of phrases newly added
skipped	number	Number of submitted phrases not added (already present or duplicate)

Example

In the request above atrial fibrillation was already in the model:

{
  "added": 1,
  "skipped": 1
}

Errors

Status	Description
400 Bad Request	Empty list, blank phrase, or phrase limit exceeded
401 Unauthorized	Missing or invalid credentials
404 Not Found	Custom model not found
500 Internal Server Error	Unexpected server error