Skip to content

Repository files navigation

cielo24

The cielo24 Web Services Platform API allows developers to easily integrate transcription, captioning and keyword extraction into their applications without having to use a manual web portal.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/cielo24/cielo24-python.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/cielo24/cielo24-python.git)

Then import the package:

importcielo24

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

importcielo24

Getting Started

Please follow the installation procedure and then run the following:

importtimeimportcielo24frompprintimportpprintfromcielo24.apiimportaccount_apifromcielo24.model.error_responseimportErrorResponsefromcielo24.model.login_bodyimportLoginBodyfromcielo24.model.login_responseimportLoginResponsefromcielo24.model.verify_key_responseimportVerifyKeyResponse# Defining the host is optional and defaults to https://api.cielo24.com/api# See configuration.py for a list of all supported configuration parameters.configuration=cielo24.Configuration(
host="https://api.cielo24.com/api"
)
# The client must configure the authentication and authorization parameters# in accordance with the API server security policy.# Examples for each auth method are provided below, use the example that# satisfies your auth use case.# Configure API key authorization: ApiKeyAuthconfiguration.api_key['ApiKeyAuth'] ='YOUR_API_KEY'# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'# Enter a context with an instance of the API clientwithcielo24.ApiClient(configuration) asapi_client:
# Create an instance of the API classapi_instance=account_api.AccountApi(api_client)
v=1# int | (default to 1)try:
api_response=api_instance.get_settings(v)
pprint(api_response)
exceptcielo24.ApiExceptionase:
print("Exception when calling AccountApi->get_settings: %s\n"%e)

Documentation for API Endpoints

All URIs are relative to https://api.cielo24.com/api

ClassMethodHTTP requestDescription
AccountApiget_settingsGET /account/get_settings
AccountApiloginPOST /account/login
AccountApilogoutPOST /account/logout
AccountApiverify_keyGET /account/verify_key
JobApiadd_media_filePOST /job/add_media
JobApiadd_media_urlGET /job/add_media
JobApiauthorize_jobPOST /job/authorize
JobApiget_captionGET /job/get_caption
JobApijob_infoGET /job/info
JobApinew_jobPOST /job/new
JobApiperform_transcriptionPOST /job/perform_transcription
JobApiperform_translationPOST /job/translate

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key
  • API key parameter name: api_token
  • Location: URL query string

Author

devs@cielo24.com

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in cielo24.apis and cielo24.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from cielo24.api.default_api import DefaultApi
  • from cielo24.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import cielo24
from cielo24.apis import *
from cielo24.models import *

About

cielo24 Python API Library

Resources

Stars

0 stars

Watchers

16 watching

Forks

Releases

Packages

Contributors

Languages