Upload Pronunciations Csv

POST/api/v1/pronunciations/csv

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Request body

multipart/form-data

body Body_pronunciations_upload_csv required

1 field

filestring (binary)required

CSV file containing pronunciation overrides

Request example

{
  "file": "string"
}

Responses

202Successful Response

application/json

response PronunciationsCsvUploadResponse required

5 fields

revisionintegerrequired

hashstringrequired

entriesintegerrequired

uploaded_atstring (date-time)optional

uploaded_bystringrequired

Response example

{
  "revision": 0,
  "hash": "string",
  "entries": 0,
  "uploaded_at": "string",
  "uploaded_by": "string"
}

422Validation Error

application/json

response HTTPValidationError required

1 field

detailValidationError[]optional

Item schema

itemsValidationErrorrequired

3 fields

locstring | integer[]required

Item schema

itemsstring | integerrequired

2 options

Option 1stringrequired

Option 2integerrequired

msgstringrequired

typestringrequired

Response example

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Code examples

import { openAsBlob } from "node:fs";
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLE_API_KEY"] ?? "",
});

async function run() {
  const result = await syllableSDK.pronunciations.pronunciationsUploadCsv({
    file: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLE_API_KEY", ""),
) as ss_client:

    res = ss_client.pronunciations.pronunciations_upload_csv(request={
        "file": {
            "file_name": "example.file",
            "content": open("example.file", "rb"),
        },
    })

    # Handle response
    print(res)

curl --request POST \
  --url 'https://api.syllable.cloud/api/v1/pronunciations/csv' \
  --header 'content-type: multipart/form-data' \
  --data '{
  "file": "string"
}'