# Models

## The Error object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean"},"statusCode":{"type":"integer"},"message":{"type":"string"}}}}}}
```

## The Voice object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"Voice":{"type":"object","properties":{"id":{"type":"string","description":"The voice ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the voice"},"gender":{"type":"string","enum":["male","female","neutral"],"description":"Gender of the voice"},"description":{"type":"string","description":"Description of the voice"}}}}}}
```

## The Model object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"Model":{"type":"object","properties":{"id":{"type":"string","description":"The model ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the model"},"description":{"type":"string","description":"Description of the model"},"provider":{"type":"string","description":"Provider of the model (e.g., elevenlabs, openai, sarvam)"},"type":{"type":"string","description":"Type of service (e.g., tts)"},"voices":{"type":"array","description":"Available voices for this model","items":{"$ref":"#/components/schemas/Voice"}}}},"Voice":{"type":"object","properties":{"id":{"type":"string","description":"The voice ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the voice"},"gender":{"type":"string","enum":["male","female","neutral"],"description":"Gender of the voice"},"description":{"type":"string","description":"Description of the voice"}}}}}}
```

## The TTSGenerateRequestElevenLabs object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"TTSGenerateRequestElevenLabs":{"type":"object","required":["model","voice","text"],"properties":{"model":{"type":"string","description":"The model ID to use (e.g., eleven_multilingual_v2)"},"voice":{"type":"string","description":"The voice ID to use (e.g., aria, roger)"},"text":{"type":"string","description":"The text to convert to speech"},"config":{"type":"object","properties":{"stability":{"type":"number","default":0.5,"description":"Voice stability (0.0 to 1.0)"},"similarityBoost":{"type":"number","default":0.75,"description":"Similarity boost (0.0 to 1.0)"},"style":{"type":"number","default":0,"description":"Style control (0.0 to 1.0)"},"useSpeakerBoost":{"type":"boolean","default":true,"description":"Whether to use speaker boost"},"format":{"type":"string","default":"mp3","enum":["mp3","wav","ogg"],"description":"Audio format"}}}}}}}}
```

## The TTSGenerateRequestSarvam object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"TTSGenerateRequestSarvam":{"type":"object","required":["model","voice","text"],"properties":{"model":{"type":"string","description":"The model ID to use (e.g., bulbul:v1, bulbul:v2)"},"voice":{"type":"string","description":"The voice ID to use (e.g., anushka, abhilash)"},"text":{"type":"string","description":"The text to convert to speech"},"config":{"type":"object","properties":{"target_language_code":{"type":"string","default":"en-IN","description":"Language code for the speech"},"speed":{"type":"number","default":1,"description":"Speech speed (0.5 to 2.0)"},"format":{"type":"string","default":"mp3","enum":["mp3"],"description":"Audio format"}}}}}}}}
```

## The TTSGenerateRequestWhisper object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"TTSGenerateRequestWhisper":{"type":"object","required":["model","voice","text"],"properties":{"model":{"type":"string","description":"The model ID to use (e.g., tts-1, tts-1-hd)"},"voice":{"type":"string","description":"The voice ID to use (e.g., alloy, echo, fable, onyx, nova, shimmer)"},"text":{"type":"string","description":"The text to convert to speech"},"config":{"type":"object","properties":{"speed":{"type":"number","default":1,"description":"Speech speed (0.5 to 2.0)"},"format":{"type":"string","default":"mp3","enum":["mp3","wav"],"description":"Audio format"}}}}}}}}
```

## The TTSResponse object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"TTSResponse":{"type":"object","properties":{"success":{"type":"boolean"},"statusCode":{"type":"integer"},"request":{"type":"object","properties":{"ip":{"type":"string"},"method":{"type":"string"},"url":{"type":"string"}}},"message":{"type":"string"},"data":{"type":"object","properties":{"audioUrl":{"type":"string","description":"URL to the generated audio file"}}}}}}}}
```

## The ModelsResponse object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"ModelsResponse":{"type":"object","properties":{"success":{"type":"boolean"},"statusCode":{"type":"integer"},"message":{"type":"string"},"data":{"type":"object","properties":{"models":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}}}}},"Model":{"type":"object","properties":{"id":{"type":"string","description":"The model ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the model"},"description":{"type":"string","description":"Description of the model"},"provider":{"type":"string","description":"Provider of the model (e.g., elevenlabs, openai, sarvam)"},"type":{"type":"string","description":"Type of service (e.g., tts)"},"voices":{"type":"array","description":"Available voices for this model","items":{"$ref":"#/components/schemas/Voice"}}}},"Voice":{"type":"object","properties":{"id":{"type":"string","description":"The voice ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the voice"},"gender":{"type":"string","enum":["male","female","neutral"],"description":"Gender of the voice"},"description":{"type":"string","description":"Description of the voice"}}}}}}
```

## The ModelResponse object

```json
{"openapi":"3.0.0","info":{"title":"KidJig Text-to-Speech API","version":"2.0.0"},"components":{"schemas":{"ModelResponse":{"type":"object","properties":{"success":{"type":"boolean"},"statusCode":{"type":"integer"},"message":{"type":"string"},"data":{"type":"object","properties":{"model":{"$ref":"#/components/schemas/Model"}}}}},"Model":{"type":"object","properties":{"id":{"type":"string","description":"The model ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the model"},"description":{"type":"string","description":"Description of the model"},"provider":{"type":"string","description":"Provider of the model (e.g., elevenlabs, openai, sarvam)"},"type":{"type":"string","description":"Type of service (e.g., tts)"},"voices":{"type":"array","description":"Available voices for this model","items":{"$ref":"#/components/schemas/Voice"}}}},"Voice":{"type":"object","properties":{"id":{"type":"string","description":"The voice ID used in API requests"},"name":{"type":"string","description":"Human-readable name of the voice"},"gender":{"type":"string","enum":["male","female","neutral"],"description":"Gender of the voice"},"description":{"type":"string","description":"Description of the voice"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://kidjig.gitbook.io/kidjig-docs/api-provider/voice-speech-models/api-reference/models.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.