Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.humanly.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Narrators define the voice and language options available for text-to-speech (TTS) audio generation when creating questions.

​
List Narrators

List all available narrators for TTS. Endpoint: GET /qsi/gather/narrators 
{
  "data": [
    {
      "id": "uuid",
      "name": "Default Narrator",
      "language": "en",
      "voices": [
        {
          "id": "voice-uuid",
          "name": "Voice Name",
          "gender": "male",
          "description": "Professional male voice"
        }
      ]
    }
  ],
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

​
Get Narrator

Get narrator details including available voices. Endpoint: GET /qsi/gather/narrators/{narratorId}
​
narratorId
string
required
UUID of the narrator
{
  "data": {
    "id": "uuid",
    "name": "Default Narrator",
    "language": "en",
    "voices": [
      {
        "id": "voice-uuid",
        "name": "Voice Name",
        "gender": "male",
        "description": "Professional male voice"
      }
    ]
  },
  "meta": {
    "requestId": "uuid",
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

​
Using Narrators

When creating questions with generateAudio: true, you can specify a narratorId: 
{
  "title": "Tell me about yourself",
  "questionScript": "Tell me about yourself and your background.",
  "narratorId": "uuid",
  "generateAudio": true
}
If no narratorId is specified, the default narrator for your organization will be used.

Questions

Learn how to create questions with TTS audio

Creating Your First Interview

Step-by-step guide for creating interviews