Skip to content

Get Custom Model

Get a single custom model by ID.

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

Request

Headers

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

Path Parameters

Parameter Type Description
id string ID of the custom model

Example

curl "https://api.reson8.dev/v1/custom-model/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: ApiKey <your_api_key>"
import requests

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

custom_model = response.json()

Response

200 OK

Field Type Description
id string Unique identifier of the custom model
name string Name of the custom model
description string Description of the custom model
phraseCount number Number of phrases in the custom model

Example

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Cardiology",
  "description": "Cardiology-specific terminology",
  "phraseCount": 3
}

Errors

Status Code Description
401 UNAUTHORIZED Invalid or expired credentials
404 NOT_FOUND Custom model not found
500 INTERNAL_ERROR Unexpected server error