Skip to content

Rumble-2-Flash is now open weights, Apache 2.0.

Read the announcement

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
Header Value
Authorization ApiKey <api_key> or Bearer <access_token>
Content-Type application/json

See Authentication for which header to use in different situations.

Parameter Type Description
id string ID of the custom model
Field Type Required Description
phrases string[] Yes Phrases to add (must not be empty, each at most 255 characters)
Terminal window
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"]
}'

200 OK

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

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

{
"added": 1,
"skipped": 1
}
Status Description
400 Bad Request Empty list, blank phrase, phrase is too long, or phrase limit exceeded
401 Unauthorized Missing or invalid credentials
404 Not Found Custom model not found
500 Internal Server Error Unexpected server error