Skip to content

Create custom language model

Create a custom language model for a specific language.

URL: POST https://api.scriptix.io/api/v3/custom_models

Request headers

The following headers need to be present

Parameter Value Description
content-type application/json
x-zoom-s2t-key Scriptix Batch API Token API key of type batch needed for authorization

JSON Body Schema

Key Type Description
name string Custom language name to be saved as.
language_id int The base language id that the custom language is based on.
organization_id string (Optional) Organization id, if provided will be verified from user organization, else if not provided will be used the one in user data organization.

JSON Payload

{
    "name": "Model with acoustic and language datasets",
    "language_id": "7",
    "organization_id": "20123"
}

Responses

Status code Description Payload
200 New custom language model created
400 Invalid language_id or organization_id or name
401 Unauthorized
415 Content Invalid
422 Body Invalid
500 Server Error

HTTP 201 Created

Content-type: application/json

Response: APIResultResponse<CustomModel>

JSON Response

{
    "result": {
        "id": 2,
        "name": "Model with acoustic and language datasets",
        "last_modified": "2021-01-25T10:31:46.960411+00:00",
        "organization_id": 20123,
        "language_data": null,
        "is_trainable": false,
        "type": 1,
        "base_language_id": 1,
        "base_language_key": nl-nl,
        "training_log": null
    },
    "count": 1,
    "total_results": 1
}