NeuralSpace VoiceAI (1.0.1)

Download OpenAPI specification:Download

URL: https://www.neuralspace.ai

NeuralSpace APIs for advanced Speech-To-Text.

File Transcription

APIs to carry out creation, listing and deletion of file transcription jobs.

Create Job

Endpoint to create a file transcription job.

Authorizations:

PlatformToken

header Parameters

Authorization

required

string <apiKey>

Request Body schema: multipart/form-data

files	string <binary> Not required if rerun is passed in config.
	object (JobConfig)

Responses

Request samples

cURL
Node.js
Python

curl --location 'https://voice.neuralspace.ai/api/v1/jobs' \
  --header 'Authorization: {{NS_API_KEY}}' \
  --form 'files=@"{{LOCAL_AUDIO_FILE_PATH}}"' \
  --form 'config="{\"file_transcription\":{\"mode\":\"advanced\"}}"'

Response samples

200
400
401
413

Content type

application/json

{"success": true,
"message": "string",
"data": {"jobId": "3fdb03ee-7788-4ea0-9231-26cbd7579b4e"
}
}

Get Jobs

Get details of multiple transcription jobs.

Authorizations:

PlatformToken

query Parameters

page	number The page of results to return.
pageSize	integer >= 1 Default: 20 Example: pageSize=20 The number of jobs to return per page.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v1/jobs' \
  --header 'Authorization: {{API_KEY}}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"jobs": [{"timestamp": 0,
"filename": "string",
"jobId": "string",
"params": {"transcription": {"language_id": "en",
"mode": "advanced",
"number_formatting": "words"
},
"speaker_diarization": {"mode": "speakers",
"num_speakers": 0,
"overrides": {"clustering": {"threshold": 1
},
"segmentation": {"threshold": 1
}
}
},
"subtitles_guidelines": {"line_count": 0,
"duration": 0,
"character_count": 0
},
"summarize": true,
"sentiment_detect": true,
"translation": {"source_language": "string",
"target_languages": ["ar"
]
},
"dictionary": {"words": ["string"
]
},
"rerun": "3fdb03ee-7788-4ea0-9231-26cbd7579b4e"
},
"status": "string",
"audioDuration": 25
}
],
"total": "string",
"pageSize": "string",
"page": "string"
}
}

Get Job

Get details of a transcription job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the job to retrieve.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js
Python

curl --location 'https://voice.neuralspace.ai/api/v1/jobs/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"timestamp": 0,
"filename": "string",
"jobId": "string",
"params": {"transcription": {"language_id": "en",
"mode": "advanced",
"number_formatting": "words"
},
"speaker_diarization": {"mode": "speakers",
"num_speakers": 0,
"overrides": {"clustering": {"threshold": 1
},
"segmentation": {"threshold": 1
}
}
},
"subtitles_guidelines": {"line_count": 0,
"duration": 0,
"character_count": 0
},
"summarize": true,
"sentiment_detect": true,
"translation": {"source_language": "string",
"target_languages": ["ar"
]
},
"dictionary": {"words": ["string"
]
},
"rerun": "3fdb03ee-7788-4ea0-9231-26cbd7579b4e"
},
"status": "string",
"audioDuration": null,
"result": {"transcription": {"transcript": "string",
"timestamps": [{"word": "string",
"start": 0,
"end": 0,
"conf": 0
}
],
"summary": "string",
"segments": [{"text": "string",
"speaker": "string",
"start": "string",
"end": "string",
"sentiment": "string"
}
]
},
"translation": {"hi": {"text": "string",
"segments": {"text": "string",
"speaker": "string",
"start": "string",
"end": "string",
"sentiment": "string"
},
"summary": "string"
}
},
"sentiment_detection": {"overall": "positive"
}
}
}
}

Update Job

Update a transcription job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the job to update

header Parameters

Authorization

required

string <apiKey>

Request Body schema: application/json

filename

string

The new filename to set for the transcription job.

Responses

Request samples

Payload
cURL
Node.js

Content type

application/json

{"filename": "string"
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"modifiedCount": 0,
"jobId": "string"
}
}

Delete Job

Endpoint to delete a file transcription job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the job to delete

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location --request DELETE 'https://voice.neuralspace.ai/api/v1/jobs/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"deletedCount": 0
}
}

Ask Me Anything

APIs to answer natural language queries on the content of your file transcription jobs.

Create Prompt Job

Endpoint to create a prompt job.

Authorizations:

PlatformToken

header Parameters

Authorization

required

string <apiKey>

Request Body schema: application/json

jobId	string The jobId the prompts should be asked against.
prompts	Array of strings An array of prompts to answer.

Responses

Request samples

Payload

Content type

application/json

{"jobId": "string",
"prompts": ["string"
]
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": [{"id": "string",
"createdAt": 0,
"userId": "string",
"jobId": "string",
"prompt": "string",
"answer": "string"
}
]
}

Get Prompt Jobs

Get details of multiple prompt jobs.

Authorizations:

PlatformToken

query Parameters

jobId	string The jobId the prompts were run against
pageNumber	number The page of results to return.
pageSize	integer >= 1 Default: 20 Example: pageSize=20 The number of jobs to return per page.
sort	string Enum: "asc" "desc" The sort order of results.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v2/prompts' \
  --header 'Authorization: {{API_KEY}}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"prompts": [{"id": "string",
"createdAt": 0,
"userId": "string",
"jobId": "string",
"prompt": "string",
"answer": "string"
}
],
"total": 0,
"pageSize": 0,
"page": 0
}
}

Get Prompt Job

Get details of a prompt job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the prompt to retrieve.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v2/prompts/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"id": "string",
"createdAt": 0,
"userId": "string",
"jobId": "string",
"prompt": "string",
"answer": "string"
}
}

Delete Prompt Job

Endpoint to delete a prompt job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the prompt to delete

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location --request DELETE 'https://voice.neuralspace.ai/api/v2/prompts/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"deletedCount": 0
}
}

Text to Speech

APIs to carry out creation, listing and deletion of text to speech jobs.

Create TTS Job

Endpoint to create a text to speech job.

Authorizations:

PlatformToken

header Parameters

Authorization

required

string <apiKey>

Request Body schema: application/json

text	string The text that should be used to generate speech.
speaker_id	string The id of the voice to be used to generate speech. From /tts/voices.
stream	boolean Whether to return a byte stream as the API response.
	object (TTSConfig)

Responses

Request samples

Payload

Content type

application/json

{"text": "string",
"speaker_id": "string",
"stream": true,
"config": {"pace": 0,
"volume": 100,
"pitch_shift": -20,
"pitch_scale": -20
}
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"jobId": "3fdb03ee-7788-4ea0-9231-26cbd7579b4e"
}
}

Get TTS Jobs

Get details of multiple text to speech jobs.

Authorizations:

PlatformToken

query Parameters

pageNumber	number The page of results to return.
pageSize	integer >= 1 Default: 20 Example: pageSize=20 The number of jobs to return per page.
sort	string Enum: "asc" "desc" The sort order of results.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v1/tts' \
  --header 'Authorization: {{API_KEY}}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"jobs": [{"timestamp": 0,
"text": "string",
"jobId": "string",
"params": {"pace": 0,
"volume": 100,
"pitch_shift": -20,
"pitch_scale": -20
},
"status": "string",
"audioDuration": 25,
"result": {"save_path": "string"
}
}
],
"total": 0,
"pageSize": 0,
"page": 0
}
}

Get TTS Job

Get details of a text to speech job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the job to retrieve.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v1/tts/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"timestamp": 0,
"text": "string",
"jobId": "string",
"params": {"pace": 0,
"volume": 100,
"pitch_shift": -20,
"pitch_scale": -20
},
"status": "string",
"audioDuration": 25,
"result": {"save_path": "string"
}
}
}

Delete TTS Job

Endpoint to delete a text to speech job.

Authorizations:

PlatformToken

path Parameters

id

required

string <uuid>

The ID of the job to delete

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location --request DELETE 'https://voice.neuralspace.ai/api/v1/tts/{YOUR_JOB_ID}' \
  --header 'Authorization: {YOUR_API_KEY}'

Response samples

200
400
401

Content type

application/json

{"success": true,
"message": "string",
"data": {"deletedCount": 0
}
}

Languages

APIs to find supported languages and their identifiers.

Get Supported Voices

Get supported speaker IDs.

Authorizations:

PlatformToken

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js

curl --location 'https://voice.neuralspace.ai/api/v1/tts/voices' \
  --header 'Authorization: {{API_KEY}}'

Response samples

200
400

Content type

application/json

{"success": true,
"data": {"languages": [{"language": "string",
"gender": "string",
"name": "string",
"dialect": "string",
"style": "string",
"speaker_id": "string"
}
]
}
}

Get Supported Languages

Get supported language codes.

Authorizations:

PlatformToken

query Parameters

type

required

string

Enum: "file" "stream"

The transcription mode to get supported languages for.

header Parameters

Authorization

required

string <apiKey>

Responses

Request samples

cURL
Node.js
Python

curl --location 'https://voice.neuralspace.ai/api/v1/languages?type=file' \
  --header 'Authorization: {{API_KEY}}'

Response samples

200
400

Content type

application/json

{"success": true,
"message": "string",
"data": {"languages": ["string"
]
}
}