{"id":18716956,"url":"https://github.com/iahispano/applio-api","last_synced_at":"2025-04-12T13:31:47.785Z","repository":{"id":206566301,"uuid":"717199950","full_name":"IAHispano/Applio-API","owner":"IAHispano","description":"Robust functionality, focused on granting convenient access to AI models developed using the RVC technology.","archived":false,"fork":false,"pushed_at":"2024-04-20T20:55:17.000Z","size":132,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-20T21:29:02.138Z","etag":null,"topics":["ai","api","applio","rvc","vc","voice","voice-clone","voice-cloning"],"latest_commit_sha":null,"homepage":"https://api.applio.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IAHispano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-11-10T19:42:36.000Z","updated_at":"2024-04-20T20:55:21.000Z","dependencies_parsed_at":"2023-11-16T14:41:16.816Z","dependency_job_id":"4069a5d0-28b4-48bb-8b20-4ce861751f38","html_url":"https://github.com/IAHispano/Applio-API","commit_stats":null,"previous_names":["iahispano/applio-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAHispano%2FApplio-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAHispano%2FApplio-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAHispano%2FApplio-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IAHispano%2FApplio-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IAHispano","download_url":"https://codeload.github.com/IAHispano/Applio-API/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223518415,"owners_count":17158689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","api","applio","rvc","vc","voice","voice-clone","voice-cloning"],"created_at":"2024-11-07T13:14:21.842Z","updated_at":"2024-11-07T13:14:22.280Z","avatar_url":"https://github.com/IAHispano.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Applio API\n\nWelcome to the Applio API, your gateway to a vast repository of more than 20,000 RVC models and over 500,000 kits.ai components.\n\n\n## Installation\n\nTo get started with the Applio API, follow these simple installation steps:\n\n1. Install Applio-API using npm:\n\n```bash\nnpm install\n```\n\n2. Start the API with the following command:\n\n```bash\nnpm run dev\n```\n\n## API Reference\n\n### Get All Models\n\nRetrieve information about multiple models using the following API endpoint:\n\n```http\nGET /key=(secret)/models/perpage=(number)/page=(number)?type=(kits.ai / rvc)\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `perpage`  | `number` | **Required**. Number of models to view (max 25). |\n| `page`  | `number` | **Required**. Page number to be displayed |\n| `type`  | `string` | Optional. Type of model to fetch |\n\n\n\n### Search Models\n\nSearch for specific models by name using the following API endpoint:\n\n```http\nGET /key=(secret)/models/search?name=(model_name)\u0026type=(kits.ai / rvc)\n```\n\n| Parameter | Type     | Description                       |\n| :-------- | :------- | :-------------------------------- |\n| `search`      | `string` | **Required**. Name of model to fetch (min 3 letters). |\n| `type`      | `string` | Optional. Type of model to fetch |\n\n\n\n### Search User Models\n\nTo find specific models based on their associated usernames:\n\n```http\nGET /key=(secret)/models/user=(username)?type=(kits.ai / rvc)\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `user`  | `string` | **Required**. User owner of the models you want to see (min 3 letters).  |\n| `type`      | `string` | Optional. Type of model to fetch |\n\n\n### Upload Model\n\nUpload a model, you must have an administrator API KEY.\n\n```http\nPOST /key=(secret)/upload/:id/:name/:link/:image_url/:type/:epochs/:created_at/:algorithm/:author_id/:author_username\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `key`  | `string` | **Required**. This action requires an ADMIN API KEY for authorization. |\n| `id` | `string` | **Required**. Unique identifier for the model. |\n| `name` | `string` | **Required**. Name of the model. |\n| `link` | `string` | **Required**. Link associated with the model. |\n| `image_url` | `string` | **Required**. URL of the model's image. |\n| `type` | `string` | **Required**. Type of the model. |\n| `epochs` | `string` | **Required**. Number of epochs for the model. |\n| `created_at` | `string` | **Required**. Creation date of the model. |\n| `algorithm` | `string` | **Required**. Algorithm used by the model. |\n| `author_id` | `string` | **Required**. Identifier of the model's author. |\n| `author_username` | `string` | **Required**. Username of the model's author. |\n\n\n### Get All Blogs\n\nRetrieve information about multiple blogs using the following API endpoint:\n\n```http\nGET /key=(secret)/blog/perpage=(number)/page=(number)\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `perpage`  | `number` | **Required**. Number of models to view (max 25). |\n| `page`  | `number` | **Required**. Page number to be displayed |\n\n\n### Get All Users\n\nRetrieve information about multiple users using the following API endpoint, you must have an administrator API KEY:\n\n```http\nGET /key=(secret)/user/perpage=(number)/page=(number)\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `perpage`  | `number` | **Required**. Number of models to view (max 25). |\n| `page`  | `number` | **Required**. Page number to be displayed |\n\n\n### Generate an API KEY\n\nGenerate a user API KEY, you must have an administrator API KEY.\n\n```http\nPOST /key=(secret)/generateToken\n```\n\n| Parameter  | Type     | Description                            |\n| :--------- | :------- | :------------------------------------- |\n| `key`  | `string` | **Required**. This action requires an ADMIN API KEY for authorization. |\n\n\n### Check API Status\n\nCheck the latency of the API.\n\n```http\nGET /ping\n```\n\nMake sure to replace `(secret)` in the API endpoints with your actual API KEY to authenticate your requests.\n\n\n## Performance Testing\n\nIn the table below, you will find the results of our performance tests for the Applio API. We run these tests with every new release, and you can access all the logs here:\n\n\n| Request Count | Response Time | Version          |\n| ------------- | ------------------------| -----------------|\n| 100           | 1.0s                      | Beta      |\n| 250           | 1.1s                      | Beta      |\n| 500           | 1.4s                      | Beta      |\n| 1000          | 1.6s                      | Beta    |\n| 100           | 0.3s                      | 1.0     |\n| 250           | 0.5s                      | 1.0        |\n| 500           | 0.9s                      | 1.0       |\n| 1000          | 1.3s                      | 1.0      |\n| 100           | 0.3s                      | 1.2     |\n| 250           | 0.4s                      | 1.2        |\n| 500           | 0.6s                      | 1.2       |\n| 1000          | 1.2s                      | 1.2      |\n\n\n#### Attempts to scrape data from our API are strictly prohibited.\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://docs.applio.org/assets/applio_banner.png\" alt=\"applio\" /\u003e\n\u003c/p\u003e\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiahispano%2Fapplio-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiahispano%2Fapplio-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiahispano%2Fapplio-api/lists"}