cielo24 - the C# library for the 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 C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencies

• RestSharp - 106.13.0 or later
• Json.NET - 12.0.3 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using cielo24.Api;
using cielo24.Client;
using cielo24.Model;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using cielo24.Api;
using cielo24.Client;
using cielo24.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.cielo24.com/api";
            // Configure API key authorization: ApiKeyAuth
            config.ApiKey.Add("api_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("api_token", "Bearer");

            var apiInstance = new AccountApi(config);
            var v = 1;  // int |  (default to 1)

            try
            {
                Object result = apiInstance.GetSettings(v);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AccountApi.GetSettings: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AccountApi	GetSettings	GET /account/get_settings
AccountApi	Login	POST /account/login
AccountApi	Logout	POST /account/logout
AccountApi	VerifyKey	GET /account/verify_key
JobApi	AddMediaFile	POST /job/add_media
JobApi	AddMediaUrl	GET /job/add_media
JobApi	AuthorizeJob	POST /job/authorize
JobApi	GetCaption	GET /job/get_caption
JobApi	JobInfo	GET /job/info
JobApi	NewJob	POST /job/new
JobApi	PerformTranscription	POST /job/perform_transcription
JobApi	PerformTranslation	POST /job/translate

Documentation for Models

• Model.AddMediaResponse
• Model.ErrorResponse
• Model.IWPEnum
• Model.JobInfoResponse
• Model.JobOptions
• Model.LoginBody
• Model.LoginResponse
• Model.NewJobBody
• Model.NewJobResponse
• Model.PerformTranscriptionBody
• Model.PerformTranscriptionResponse
• Model.PerformTranslationResponse
• Model.VerifyKeyResponse

Documentation for Authorization

ApiKeyAuth

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