Skip to main content

Custom Model Data Management

📁 Manage Custom Model Data​

Upload, list, retrieve, or delete training and test data used for fine-tuning your Scriptix custom language models.

📤 Upload Dataset​

URL: PUT /api/v3/custom_models/{model_id}/data/

Upload a transcript (data_type=1) or test dataset (data_type=2) file using a PUT request with plain text content.

Headers​

ParameterDescription
x-zoom-s2t-keyScriptix Reseller API Token
x-filenameFilename used to reference the file in the dashboard/API
Content-TypeMust be text/plain

Query Parameters​

ParameterTypeDescription
data_typestringType of data: 1 for transcript, 2 for test

✅ Response Codes​

Status CodeDescription
200Dataset uploaded successfully
400Invalid language
401Unauthorized – missing or invalid token
402Payment required – no active subscription
415Unsupported media type – use text/plain
422Invalid request body
500Internal server error

📄 List All Datasets​

URL: GET /api/v3/custom_models/data/

Retrieve all uploaded datasets across custom models.

Headers​

ParameterDescription
x-zoom-s2t-keyScriptix Reseller API Token

✅ Response Codes​

Status CodeDescription
200List returned successfully
400–500Standard error responses

📦 Example​

{
  "result": [
    {
      "id": 1,
      "name": "X-dataset.txt",
      "type": 1,
      "language_id": 2,
      "media_url": "https://xyz.com/txt",
      "url": "https://s3.ovh.xyz/X-dataset.txt"
    }
  ],
  "count": 1,
  "total_results": 1
}

🔍 Get Dataset by ID​

Retrieve a single dataset uploaded to a specific custom model by its ID.

URL: GET /api/v3/custom_models/{model_id}/data/{data_id}/

Path Parameters​

NameDescription
model_idID of the custom model
data_idID of the uploaded dataset

Headers​

ParameterDescription
x-zoom-s2t-keyScriptix Reseller API Token

Example​

{
  "result": {
    "id": 1,
    "name": "X-dataset.txt",
    "type": 1,
    "language_id": 2,
    "media_url": "https://xyz.com/txt",
    "url": "https://s3.ovh.xyz/X-dataset.txt"
  },
  "count": 1,
  "total_results": 1
}

❌ Remove Dataset​

Delete an individual transcript or test dataset associated with a specific custom model.

URL: DELETE /api/v3/custom_models/{model_id}/data/{data_id}/

🔢 Path Parameters​

NameDescription
model_idID of the custom model
data_idID of the dataset to delete

✅ Response Codes​

Status CodeDescription
204Dataset removed successfully
400–500Standard error responses

🧠 Use Cases​

  • Upload domain-specific transcript files for fine-tuning models
  • Test accuracy using predefined validation sets
  • Clean up outdated or irrelevant data
  • Automate dataset handling via back-office workflows

📘 Next Steps​