Getting Started with Cloudmersive and .NET Framework - Cloudmersive C# Client Documentation

.NET Core Client - Validate API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.Validate -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.Validate.Api;
using Cloudmersive.APIClient.NETCore.Validate.Client;
using Cloudmersive.APIClient.NETCore.Validate.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
				
var apiInstance = new EmailApi();
var email = email_example;  // string | Email address to validate, e.g. \"support@cloudmersive.com\".    The input is a string so be sure to enclose it in double-quotes.

try
{
	// Fully validate an email address
	FullEmailValidationResponse result = apiInstance.EmailFullValidation(email);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling EmailApi.EmailFullValidation: " + e.Message );
}

.NET Core Client - Security API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.Security -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.Security.Api;
using Cloudmersive.APIClient.NETCore.Security.Client;
using Cloudmersive.APIClient.NETCore.Security.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");



var apiInstance = new ContentThreatDetectionApi();
var value = value_example;  // string | User-facing text input.

try
{
    // Automatically detect threats in an input string
    StringAutomaticThreatDetection result = apiInstance.ContentThreatDetectionAutomaticThreatDetectionString(value);
    Debug.WriteLine(result);
}
catch (Exception e)
{
    Debug.Print("Exception when calling ContentThreatDetectionApi.ContentThreatDetectionAutomaticThreatDetectionString: " + e.Message );
}

.NET Core Client - Image API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.ImageRecognition -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.ImageRecognition.Api;
using Cloudmersive.APIClient.NETCore.ImageRecognition.Client;
using Cloudmersive.APIClient.NETCore.ImageRecognition.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");

var apiInstance = new ArtisticApi();
var style = style_example;  // string | The style of the painting to apply.  To start, try \"udnie\" a modernist\" painting style.  Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".
var imageFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.

try
{
	// Transform an image into an artistic painting automatically
	Object result = apiInstance.ArtisticPainting(style, imageFile);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling ArtisticApi.ArtisticPainting: " + e.Message );
}

.NET Core Client - Convert API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.DocumentAndDataConvert -Version 2.0.7

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Api;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Client;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");

var apiInstance = new ConvertDocumentApi();
var inputFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Input file to perform the operation on.

try
{
	// Word DOCX to PDF
	Object result = apiInstance.ConvertDocumentDocxToPdf(inputFile);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling ConvertDocumentApi.ConvertDocumentDocxToPdf: " + e.Message );
}

.NET Core Client - NLP API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.NLP -Version 2.1.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.NLP.Api;
using Cloudmersive.APIClient.NETCore.NLP.Client;
using Cloudmersive.APIClient.NETCore.NLP.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");

var apiInstance = new LanguageDetectionApi();
var textToDetect = textToDetect_example;  // string | Text to detect language of

try
{
	// Detect language of text
	LanguageDetectionResponse result = apiInstance.LanguageDetectionPost(textToDetect);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling LanguageDetectionApi.LanguageDetectionPost: " + e.Message );
}

.NET Core Client - OCR API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.OCR -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.OCR.Api;
using Cloudmersive.APIClient.NETCore.OCR.Client;
using Cloudmersive.APIClient.NETCore.OCR.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");

var apiInstance = new ImageOcrApi();
var imageFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Image file to perform OCR on.  Common file formats such as PNG, JPEG are supported.

try
{
	// Converts an uploaded image in common formats such as JPEG, PNG into text via Optical Character Recognition.
	ImageToTextResponse result = apiInstance.ImageOcrPost(imageFile);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling ImageOcrApi.ImageOcrPost: " + e.Message );
}

.NET Core Client - Barcode API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.Barcode -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.Barcode.Api;
using Cloudmersive.APIClient.NETCore.Barcode.Client;
using Cloudmersive.APIClient.NETCore.Barcode.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");

var apiInstance = new BarcodeLookupApi();
var value = value_example;  // string | Barcode value

try
{
	// Lookup a barcode value and return product data
	BarcodeLookupResponse result = apiInstance.BarcodeLookupEanLookup(value);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling BarcodeLookupApi.BarcodeLookupEanLookup: " + e.Message );
}

.NET Core Client - Video and Media Services API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.VideoAndMediaServices -Version 2.0.1

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.VideoAndMediaServices.Api;
using Cloudmersive.APIClient.NETCore.VideoAndMediaServices.Client;
using Cloudmersive.APIClient.NETCore.VideoAndMediaServices.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");



var apiInstance = new VideoApi();
var inputFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Input file to perform the operation on.
var fileUrl = fileUrl_example;  // string | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. (optional) 
var maxWidth = 56;  // int? | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. (optional) 
var maxHeight = 56;  // int? | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. (optional) 
var preserveAspectRatio = true;  // bool? | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true. (optional) 
var frameRate = 56;  // int? | Optional; Specify the frame rate of the output video. Defaults to original video frame rate. (optional) 
var quality = 56;  // int? | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. (optional) 
var extendProcessingTime = true;  // bool? | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes. (optional) 

try
{
	// Convert Video to MP4 format.
	byte[] result = apiInstance.VideoConvertToMp4(inputFile, fileUrl, maxWidth, maxHeight, preserveAspectRatio, frameRate, quality, extendProcessingTime);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling VideoApi.VideoConvertToMp4: " + e.Message );
}

.NET Core Client - Data Integration API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.DataIntegration -Version 2.0.2

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.DataIntegration.Api;
using Cloudmersive.APIClient.NETCore.DataIntegration.Client;
using Cloudmersive.APIClient.NETCore.DataIntegration.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");



var apiInstance = new BackupConvertApi();
var tableName = tableName_example;  // string | Name of the table to return (optional) 
var inputFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Input file to perform the operation on (optional) 

try
{
	// Converts a SQL Server Backup (.BAK) file into CSV for a specified table
	byte[] result = apiInstance.DataintegrationBackupConvertMssqlBakToCsvPost(tableName, inputFile);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling BackupConvertApi.DataintegrationBackupConvertMssqlBakToCsvPost: " + e.Message );
}

.NET Core Client - Currency API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.Currency -Version 2.0.1

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.Currency.Api;
using Cloudmersive.APIClient.NETCore.Currency.Client;
using Cloudmersive.APIClient.NETCore.Currency.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");



var apiInstance = new CurrencyExchangeApi();
var source = source_example;  // string | Source currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
var destination = destination_example;  // string | Destination currency three-digit code (ISO 4217), e.g. USD, EUR, etc.
var sourcePrice = 1.2;  // double? | Input price, such as 19.99 in source currency

try
{
	// Converts a price from the source currency into the destination currency
	ConvertedCurrencyResult result = apiInstance.CurrencyExchangeConvertCurrency(source, destination, sourcePrice);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling CurrencyExchangeApi.CurrencyExchangeConvertCurrency: " + e.Message );
}

.NET Core Client - Virus Scan API

Step 1 - Add the Client with the NuGet Package Manager

Run this command in the Package Manager console:

Install-Package Cloudmersive.APIClient.NETCore.VirusScan -Version 2.0.3

Or install it using the NuGet gallery

Step 2 - Add using statements

Import the API Client by adding using statements at the top of your file:

using Cloudmersive.APIClient.NETCore.VirusScan.Api;
using Cloudmersive.APIClient.NETCore.VirusScan.Client;
using Cloudmersive.APIClient.NETCore.VirusScan.Model;

Step 3 - Make the API call

Get your API Key (available in your Account Dashboard) and instantiate the API Client object:

// Configure API key authorization: Apikey
Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

var apiInstance = new ScanApi();
var inputFile = new System.IO.FileStream("C:\\temp\\inputfile", System.IO.FileMode.Open); // System.IO.Stream | Input file to perform the operation on.

try
{
	// Scan a file for viruses
	VirusScanResult result = apiInstance.ScanFile(inputFile);
	Debug.WriteLine(result);
}
catch (Exception e)
{
	Debug.Print("Exception when calling ScanApi.ScanFile: " + e.Message );
}

800 free API calls/month, no credit card required

Get started now!