# D-ID Python API Wrapper
This Python library allows you to interact with the D-ID API easily. You can use it to create text-to-video clips and retrieve clip information, among other things.
## Installation
You can install the `did-api` module using `pip`:
```bash
pip install did-api
```
## Getting Started
1. Obtain your D-ID API Key from [D-ID Studio](https://studio.d-id.com/account-settings).
2. Import the library and initialize it with your API Key:
```python
from D_ID import Clips
api_key = "your_api_key_here"
d_id = Clips(api_key)
```
## Creating a Text-to-Video Clip
To create a text-to-video clip, use the `create_text_to_video_clip` method:
```python
text = "Your text here"
result = d_id.create_text_to_video_clip(text)
```
This function takes the following optional parameters:
- `presenter_id` (default: 'amy-jcwCkr1grs')
- `driver_id` (default: 'uM00QMwJ9x')
- `voice_provider_name` (default: 'microsoft')
- `voice_id` (default: 'en-US-JennyNeural')
- `WEBHOOK_URL` (default: None)
- `background_color` (default: '#ffffff')
- `extra_data` (default: {})
The `result` variable will contain the API response, including information about the created clip.
## Retrieving Clip Information
You can retrieve clip information using the `get_clip_by_id` method:
```python
clip_id = "your_clip_id_here"
clip_info = d_id.get_clip_by_id(clip_id)
```
The `clip_info` variable will contain the API response, providing details about the specified clip.
## Examples
Here are some examples of how to use this library:
```python
# Create a text-to-video clip
text = "Hello, D-ID!"
result = d_id.create_text_to_video_clip(text)
"result => {'id': 'clip_id', 'created_at': '2023-09-06T21:45:50.298Z', 'object': 'clip', 'status': 'created'}"
# Get information about a specific clip
clip_id = "your_clip_id_here"
clip_info = d_id.get_clip_by_id(clip_id)
```
## License
This library is provided under the [MIT License](LICENSE).
For more information about the D-ID API, please refer to the [official documentation](https://docs.d-id.com/).
Raw data
{
"_id": null,
"home_page": "https://github.com/Circuit-Minds/d-id",
"name": "did-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "D ID API,text to video,t2s,D ID Python library",
"author": "Shubham Gupta",
"author_email": "gshubham533@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ee/69/5d03ba436302a4b5f54a40743d665e6de642e6aac87b1b04b18b5f4d0239/did-api-0.0.6.tar.gz",
"platform": null,
"description": "# D-ID Python API Wrapper\r\n\r\nThis Python library allows you to interact with the D-ID API easily. You can use it to create text-to-video clips and retrieve clip information, among other things.\r\n\r\n## Installation\r\n\r\nYou can install the `did-api` module using `pip`:\r\n\r\n```bash\r\npip install did-api\r\n```\r\n\r\n## Getting Started\r\n\r\n1. Obtain your D-ID API Key from [D-ID Studio](https://studio.d-id.com/account-settings).\r\n\r\n2. Import the library and initialize it with your API Key:\r\n\r\n```python\r\nfrom D_ID import Clips\r\n\r\napi_key = \"your_api_key_here\"\r\nd_id = Clips(api_key)\r\n```\r\n\r\n## Creating a Text-to-Video Clip\r\n\r\nTo create a text-to-video clip, use the `create_text_to_video_clip` method:\r\n\r\n```python\r\ntext = \"Your text here\"\r\nresult = d_id.create_text_to_video_clip(text)\r\n```\r\n\r\nThis function takes the following optional parameters:\r\n- `presenter_id` (default: 'amy-jcwCkr1grs')\r\n- `driver_id` (default: 'uM00QMwJ9x')\r\n- `voice_provider_name` (default: 'microsoft')\r\n- `voice_id` (default: 'en-US-JennyNeural')\r\n- `WEBHOOK_URL` (default: None)\r\n- `background_color` (default: '#ffffff')\r\n- `extra_data` (default: {})\r\n\r\nThe `result` variable will contain the API response, including information about the created clip.\r\n\r\n## Retrieving Clip Information\r\n\r\nYou can retrieve clip information using the `get_clip_by_id` method:\r\n\r\n```python\r\nclip_id = \"your_clip_id_here\"\r\nclip_info = d_id.get_clip_by_id(clip_id)\r\n```\r\n\r\nThe `clip_info` variable will contain the API response, providing details about the specified clip.\r\n\r\n## Examples\r\n\r\nHere are some examples of how to use this library:\r\n\r\n```python\r\n# Create a text-to-video clip\r\ntext = \"Hello, D-ID!\"\r\nresult = d_id.create_text_to_video_clip(text) \r\n\"result => {'id': 'clip_id', 'created_at': '2023-09-06T21:45:50.298Z', 'object': 'clip', 'status': 'created'}\"\r\n\r\n# Get information about a specific clip\r\nclip_id = \"your_clip_id_here\"\r\nclip_info = d_id.get_clip_by_id(clip_id)\r\n```\r\n\r\n## License\r\n\r\nThis library is provided under the [MIT License](LICENSE).\r\n\r\nFor more information about the D-ID API, please refer to the [official documentation](https://docs.d-id.com/).\r\n",
"bugtrack_url": null,
"license": "",
"summary": "D-ID API Python Library",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/Circuit-Minds/d-id"
},
"split_keywords": [
"d id api",
"text to video",
"t2s",
"d id python library"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be758d408bd842e51875a738ddb541d96b8184b8b9cabae1b8da292a5c532fd7",
"md5": "c645e803f0d8877f1fa43a043f6d439c",
"sha256": "b17f71ce2d075e519393a988d74f0a9ff9230d0aa2b0a5c5307ed2a60a0da3af"
},
"downloads": -1,
"filename": "did_api-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c645e803f0d8877f1fa43a043f6d439c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4057,
"upload_time": "2023-09-06T22:24:04",
"upload_time_iso_8601": "2023-09-06T22:24:04.555961Z",
"url": "https://files.pythonhosted.org/packages/be/75/8d408bd842e51875a738ddb541d96b8184b8b9cabae1b8da292a5c532fd7/did_api-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee695d03ba436302a4b5f54a40743d665e6de642e6aac87b1b04b18b5f4d0239",
"md5": "9fbb930025afc219b72108f188d79715",
"sha256": "d5c40be1b9485a5eb759ecdf02c00ebf28445c010e46fbac57b98eb31089f126"
},
"downloads": -1,
"filename": "did-api-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "9fbb930025afc219b72108f188d79715",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3865,
"upload_time": "2023-09-06T22:24:05",
"upload_time_iso_8601": "2023-09-06T22:24:05.850446Z",
"url": "https://files.pythonhosted.org/packages/ee/69/5d03ba436302a4b5f54a40743d665e6de642e6aac87b1b04b18b5f4d0239/did-api-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-06 22:24:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Circuit-Minds",
"github_project": "d-id",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "did-api"
}
JSON
