Skip to main content

Unofficial package to easily interact with the Kits.AI API

Project description

Unofficial Kits.AI API Implementation

kitsai is a Python package designed to streamline interactions with the Kits.AI API, offering convenient functionalities for voice models, voice conversions, vocal separations, and text-to-speech (TTS) tasks.

Installation

Install kitsai via pip:

pip install kitsai

Publish to PyPi

python setup.py sdist bdist_wheel

twine upload dist/*

Usage

Authentication

To utilize any functions within this package, authentication via your API key is necessary. Simply invoke the login function from the token module, providing your API key as an argument.

from kitsai import login



api_key = "YOUR_API_KEY_HERE"

login(api_key)

You can generate an API key by signing up on the https://app.kits.ai/api-access website.

Voice Models

Fetch Voice Models

Retrieve a list of available voice models.

from kitsai import fetch_voice_models



voice_models = fetch_voice_models(order="asc", page=1, per_page=10, my_models=False, instruments=False)

Fetch Voice Model by ID

Fetch details of a specific voice model using its ID.

from kitsai import fetch_voice_model_by_id



voice_model_id = 123

voice_model = fetch_voice_model_by_id(voice_model_id)

Voice Conversions

Create Voice Conversion

Initiate a voice conversion task with specified parameters.

from kitsai import create_voice_conversion



response = create_voice_conversion(

    voice_model_id=123,

    sound_file=open('input.wav', 'rb'),

    backing_sound_file=open('backing.wav', 'rb'),

    conversion_strength=0.5,

    model_volume_mix=0.8,

    pitch_shift=2,

    pre={

        "noiseGate": {

            "thresholdDb": -30,

            "ratio": 2,

            "attackMs": 10,

            "releaseMs": 20

        },

        "highPassFilter": {

            "cutoffFrequencyHz": 1000

        }

    }

)

Fetch Voice Conversion by ID

Retrieve details of a specific voice conversion task using its ID.

from kitsai import fetch_voice_conversion_by_id



voice_conversion = fetch_voice_conversion_by_id("JOB_ID_HERE")

Fetch Voice Conversions

Retrieve a list of voice conversion tasks.

from kitsai import fetch_voice_conversions



voice_conversions = fetch_voice_conversions(order="asc", page=1, per_page=10)

Vocal Separations

Create Vocal Separation

Initiate a vocal separation task with an audio input.

from kitsai import create_vocal_separation



response = create_vocal_separation(

    sound_file=open('input.wav', 'rb')

)

Fetch Vocal Separation by ID

Retrieve details of a specific vocal separation task using its ID.

from kitsai import fetch_vocal_separation_by_id



vocal_separation = fetch_vocal_separation_by_id("JOB_ID_HERE")

Fetch Vocal Separations

Retrieve a list of vocal separation tasks.

from kitsai import fetch_vocal_separations



vocal_separations = fetch_vocal_separations(order="asc", page=1, per_page=10)

Text-to-Speech (TTS)

Create TTS

Generate text-to-speech output using a specified voice model and input text.

from kitsai import create_tts



response = create_tts(

    voice_model_id=123,

    input_tts_text="Hello, how are you?"

)

Fetch TTS by ID

Retrieve details of a specific text-to-speech task using its ID.

from kitsai import fetch_tts_by_id



tts_job = fetch_tts_by_id("JOB_ID_HERE")

Fetch TTS

Retrieve a list of text-to-speech tasks.

from kitsai import fetch_tts



tts_jobs = fetch_tts(order="asc", page=1, per_page=10)

License

This project is licensed under the Attribution-NonCommercial 4.0 International - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kitsai-0.0.3.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

kitsai-0.0.3-py3-none-any.whl (17.9 kB view details)

Uploaded Python 3

File details

Details for the file kitsai-0.0.3.tar.gz.

File metadata

  • Download URL: kitsai-0.0.3.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.1

File hashes

Hashes for kitsai-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d3f5c62721c6f1e7906bdcc90398a9f34823b6016e8dce3248d9cec983a4aae0
MD5 519ad0fa5f0add4d85280a7fad87853b
BLAKE2b-256 5dbc2a0b8ad195cf6c3a6118a2319758b1957c3e824530e37a7cc6ebf0efc0c6

See more details on using hashes here.

File details

Details for the file kitsai-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: kitsai-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 17.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.1

File hashes

Hashes for kitsai-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 354d594cf043050f9dfcef03e95d8d22503b5315e90a09304628084f8ded1a16
MD5 34498736f55a62467331a165c9d74a16
BLAKE2b-256 f012ea458a223368c57313cdf21884030674c454c39dc19d25eea64987a267a3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page