### Install audioshake via Setuptools Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Install the audioshake Python package using Setuptools. This can be done for the current user or for all users. ```sh python setup.py install --user ``` -------------------------------- ### Install audioshake via pip Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Install the audioshake Python package directly from a GitHub repository using pip. You might need root permissions. ```sh pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git ``` -------------------------------- ### Create a new job using audioshake Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Example of how to create a new job using the JobApi. This requires an instance of the API client and optionally a JobBody object. ```python # create an instance of the API class api_instance = audioshake.JobApi(audioshake.ApiClient(configuration)) body = audioshake.JobBody() # JobBody | (optional) try: # Create a new job. api_response = api_instance.job_post(body=body) pprint(api_response) except ApiException as e: print("Exception when calling JobApi->job_post: %s\n" % e) ``` -------------------------------- ### Get a job by ID using audioshake Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Example of how to retrieve a job by its ID using the JobApi. Ensure you have set your access token and handle potential API exceptions. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create the configuration configuration = audioshake.Configuration() configuration.access_token = "YOUR_BEARER_TOKEN" # create an instance of the API class api_instance = audioshake.JobApi(audioshake.ApiClient(configuration)) id = 'id_example' # str | try: # Get a job given an Id. api_response = api_instance.job_id_get(id) pprint(api_response) except ApiException as e: print("Exception when calling JobApi->job_id_get: %s\n" % e) ``` -------------------------------- ### Get Job by ID Source: https://github.com/cielo24/audioshake-python/blob/main/docs/JobApi.md Retrieves the details of a specific job using its unique identifier. ```APIDOC ## GET /job/{id} ### Description Get a job given an Id. ### Method GET ### Endpoint /job/{id} ### Parameters #### Path Parameters - **id** (str) - Required - The unique identifier of the job. ### Response #### Success Response (200) - **InlineResponse2XX** - Details of the requested job. ### Authorization [token](../README.md#token) ``` -------------------------------- ### Get Job by ID using JobApi Source: https://github.com/cielo24/audioshake-python/blob/main/docs/JobApi.md Retrieves a job using its unique identifier. Ensure the API client is properly configured and handle potential API exceptions. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = audioshake.JobApi(audioshake.ApiClient(configuration)) id = 'id_example' # str | try: # Get a job given an Id. api_response = api_instance.job_id_get(id) pprint(api_response) except ApiException as e: print("Exception when calling JobApi->job_id_get: %s\n" % e) ``` -------------------------------- ### Create Asset from Audio Link - Python Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md Use this method to create a new asset from a provided audio file link. Ensure the UploadAudiolinkBody is correctly populated. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = audioshake.UploadApi(audioshake.ApiClient(configuration)) body = audioshake.UploadAudiolinkBody() # UploadAudiolinkBody | try: # Create a new asset from a file link. api_response = api_instance.upload_audio_link_post(body) pprint(api_response) except ApiException as e: print("Exception when calling UploadApi->upload_audio_link_post: %s\n" % e) ``` -------------------------------- ### Upload Audio from Link Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Creates a new asset by uploading audio content from a provided URL. ```APIDOC ## POST /upload/audio-link ### Description Create a new asset from a file link. ### Method POST ### Endpoint /upload/audio-link ### Request Body - **body** (UploadAudiolinkBody) - Required - The request body containing the link to the audio file. ### Response #### Success Response (200) - **[Response Fields]** - Details of the created asset. ``` -------------------------------- ### Create Asset via Direct Upload - Python Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md Use this method for direct file uploads to create a new asset. The file path must be provided. Catch ApiException for error handling. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = audioshake.UploadApi(audioshake.ApiClient(configuration)) file = '/path/to/file' # file | try: # Create a new asset. api_response = api_instance.upload_post(file) pprint(api_response) except ApiException as e: print("Exception when calling UploadApi->upload_post: %s\n" % e) ``` -------------------------------- ### upload_audio_link_post Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md Create a new asset from a file link. ```APIDOC ## POST /upload/audio-link ### Description Create a new asset from a file link. ### Method POST ### Endpoint /upload/audio-link ### Parameters #### Request Body - **body** (UploadAudiolinkBody) - Required - ### Response #### Success Response (200) - **InlineResponse2XX1** - ### Authorization [token](../README.md#token) ``` -------------------------------- ### Upload from Link Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Creates a new asset by uploading content from a provided URL. This is a general upload endpoint. ```APIDOC ## POST /upload/link ### Description Create a new asset from a file link. ### Method POST ### Endpoint /upload/link ### Request Body - **body** (UploadLinkBody) - Required - The request body containing the link to the file. ### Response #### Success Response (200) - **[Response Fields]** - Details of the created asset. ``` -------------------------------- ### Create Job Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Creates a new job in the system. This is typically used to initiate a new audio processing task. ```APIDOC ## POST /job/ ### Description Create a new job. ### Method POST ### Endpoint /job/ ### Request Body - **body** (JobBody) - Optional - The request body containing job details. ### Response #### Success Response (200) - **[Response Fields]** - Details of the created job. ``` -------------------------------- ### upload_post Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md Create a new asset. ```APIDOC ## POST /upload/ ### Description Create a new asset. ### Method POST ### Endpoint /upload/ ### Parameters #### Request Body - **file** (file) - Required - ### Response #### Success Response (200) - **InlineResponse2XX1** - ### Authorization [token](../README.md#token) ``` -------------------------------- ### Create Job Source: https://github.com/cielo24/audioshake-python/blob/main/docs/JobApi.md Creates a new job within the AudioShake system. Optionally accepts job configuration in the request body. ```APIDOC ## POST /job/ ### Description Create a new job. ### Method POST ### Endpoint /job/ ### Parameters #### Request Body - **body** (JobBody) - Optional - Configuration for the new job. ### Response #### Success Response (200) - **InlineResponse2XX** - Details of the newly created job. ### Authorization [token](../README.md#token) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ``` -------------------------------- ### Upload File Source: https://github.com/cielo24/audioshake-python/blob/main/README.md Creates a new asset by uploading a file directly. ```APIDOC ## POST /upload/ ### Description Create a new asset. ### Method POST ### Endpoint /upload/ ### Request Body - **body** (UploadBody) - Required - The request body containing the file to upload. ### Response #### Success Response (200) - **[Response Fields]** - Details of the created asset. ``` -------------------------------- ### Create Asset from Link - Python Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md This method creates a new asset using a file link. It requires an UploadLinkBody object to be passed as a parameter. Handle potential API exceptions. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = audioshake.UploadApi(audioshake.ApiClient(configuration)) body = audioshake.UploadLinkBody() # UploadLinkBody | try: # Create a new asset from a file link. api_response = api_instance.upload_link_post(body) pprint(api_response) except ApiException as e: print("Exception when calling UploadApi->upload_link_post: %s\n" % e) ``` -------------------------------- ### upload_link_post Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadApi.md Create a new asset from a file link. ```APIDOC ## POST /upload/link ### Description Create a new asset from a file link. ### Method POST ### Endpoint /upload/link ### Parameters #### Request Body - **body** (UploadLinkBody) - Required - ### Response #### Success Response (200) - **InlineResponse2XX1** - ### Authorization [token](../README.md#token) ``` -------------------------------- ### Create Job using JobApi Source: https://github.com/cielo24/audioshake-python/blob/main/docs/JobApi.md Creates a new job with optional body parameters. Handle potential API exceptions during the creation process. ```python from __future__ import print_function import time import audioshake from audioshake.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = audioshake.JobApi(audioshake.ApiClient(configuration)) body = audioshake.JobBody() # JobBody | (optional) try: # Create a new job. api_response = api_instance.job_post(body=body) pprint(api_response) except ApiException as e: print("Exception when calling JobApi->job_post: %s\n" % e) ``` -------------------------------- ### UploadAudiolinkBody Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadAudiolinkBody.md The request body for uploading an audio link requires a 'link' property and optionally accepts a 'name' property. ```APIDOC ## UploadAudiolinkBody ### Description Represents the request body for uploading an audio link. ### Properties #### Request Body - **link** (str) - Required - The URL of the audio file. - **name** (str) - Optional - A custom name for the audio file. ``` -------------------------------- ### InlineResponse2XXJob Source: https://github.com/cielo24/audioshake-python/blob/main/docs/InlineResponse2XXJob.md Represents the response object for a stem generation job. ```APIDOC ## InlineResponse2XXJob ### Description This object represents the response for a stem generation job, providing comprehensive details about its status and associated data. ### Properties - **id** (string) - Unique identifier of the stem generation job. [optional] - **client_id** (string) - Identifier of the client making the request. [optional] - **created_at** (string) - Timestamp of when the stem generation job was created. [optional] - **started_at** (string) - Timestamp of when the stem generation job was started. [optional] - **updated_at** (string) - Timestamp of when the stem generation job was last updated. [optional] - **request_id** (string) - Unique identifier of the request that generated this stem generation job. [optional] - **license_id** (string) - Identifier of the license used for stem generation. [optional] - **stem_metadata** (InlineResponse2XXJobStemMetadata) - Metadata related to the generated stems. [optional] - **metadata** (InlineResponse2XXJobStemMetadata) - General metadata for the job. [optional] - **callback_url** (string) - URL for the callback function to receive updates on the stem generation job. [optional] - **status** (string) - Current status of the stem generation job. [optional] - **status_info** (InlineResponse2XXJobStatusInfo) - Detailed information about the job's status. [optional] - **source_asset** (InlineResponse2XXJobSourceAsset) - Information about the source asset used for generation. [optional] - **stem_assets** (list[InlineResponse2XXJobStemAssets]) - Array of assets representing the generated stems. [optional] - **output_assets** (list[InlineResponse2XXJobStemAssets]) - Array of assets representing the generated stems. [optional] ``` -------------------------------- ### InlineResponse2XXJobStatusInfo Source: https://github.com/cielo24/audioshake-python/blob/main/docs/InlineResponse2XXJobStatusInfo.md Represents the status information for a stem generation job. ```APIDOC ## InlineResponse2XXJobStatusInfo ### Description This object contains information about the status of a stem generation job. ### Properties #### code (float) - [optional] Code indicating the status of the stem generation job. #### message (str) - [optional] Message providing additional information on the status of the stem generation job. ### Response Example ```json { "code": 200.0, "message": "Job completed successfully." } ``` ``` -------------------------------- ### UploadLinkBody Model Properties Source: https://github.com/cielo24/audioshake-python/blob/main/docs/UploadLinkBody.md The UploadLinkBody model contains properties for specifying the link to the content and an optional name for the uploaded item. ```APIDOC ## UploadLinkBody ### Description Represents the request body for uploading content using a link. ### Properties #### `link` (str) - Required The URL of the content to be uploaded. #### `name` (str) - Optional A custom name for the uploaded item. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.