Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reson8 Custom Models API

Domain adaptation via custom phrase models.

Reson8 Custom Models API is one of 3 APIs that Reson8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Models. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

This API exposes 6 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.reson8.dev.

6 operations 4 paths 8 schemas 3 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.reson8.dev/v1
Authentication
API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 2

Reson8 Custom Models API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Server-to-server. Value form: ApiKey
  • BearerAuth — Short-lived access token from POST /v1/auth/token, for client-side use.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 3 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Models 6

Domain adaptation via custom phrase models.

POST
/v1/custom-model
Create a custom model
createCustomModel body → 201400401500
GET
/v1/custom-model
List custom models
listCustomModels → 200401500
GET
/v1/custom-model/{id}
Get a custom model
getCustomModel 1 param → 200401404500
GET
/v1/custom-model/{id}/phrases
List phrases
listPhrases 3 params → 200400401404500
POST
/v1/custom-model/{id}/phrases
Add phrases
addPhrases 1 param body → 200400401404500
POST
/v1/custom-model/{id}/phrases/delete
Delete phrases
deletePhrases 1 param body → 200400401404500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CustomModel (4 properties), PhrasePage (4 properties), CustomModelCreate (3 properties), DeletePhrasesResult (2 properties). Each schema is shown below with its type and property counts.

CustomModel
object
4 properties
CustomModelCreate
object
3 properties 3 required
Phrase
object
1 property
DeletePhrasesResult
object
2 properties
Error
object
1 property
PhrasePage
object
4 properties
PhraseList
object
1 property 1 required
AddPhrasesResult
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reson8-custom-models-api-openapi.yml Raw ↑

Other APIs Reson8 publishes across the network.

Reson8 Auth API
Reson8 Speech to Text API