bytescout.io

Default

barcodeGenerateGet

Barcode generation via GET request.


/barcode/generate

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/barcode/generate?name=&type=&value="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Filename for the generated image.
        String type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
        String value = value_example; // String | Barcode value.
        try {
            SingleResponseModel result = apiInstance.barcodeGenerateGet(name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeGenerateGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Filename for the generated image.
        String type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
        String value = value_example; // String | Barcode value.
        try {
            SingleResponseModel result = apiInstance.barcodeGenerateGet(name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeGenerateGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // Filename for the generated image. (optional)
String *type = type_example; // Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional)
String *value = value_example; // Barcode value. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance barcodeGenerateGetWith:name
    type:type
    value:value
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} Filename for the generated image.
  'type': type_example, // {String} Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
  'value': value_example // {String} Barcode value.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodeGenerateGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class barcodeGenerateGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | Filename for the generated image. (optional) 
            var type = type_example;  // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional) 
            var value = value_example;  // String | Barcode value. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.barcodeGenerateGet(name, type, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.barcodeGenerateGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | Filename for the generated image.
$type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
$value = value_example; // String | Barcode value.

try {
    $result = $api_instance->barcodeGenerateGet($name, $type, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->barcodeGenerateGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | Filename for the generated image.
my $type = type_example; # String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
my $value = value_example; # String | Barcode value.

eval { 
    my $result = $api_instance->barcodeGenerateGet(name => $name, type => $type, value => $value);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->barcodeGenerateGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | Filename for the generated image. (optional)
type = type_example # String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional)
value = value_example # String | Barcode value. (optional)

try: 
    api_response = api_instance.barcodeGenerateGet(name=name, type=type, value=value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->barcodeGenerateGet: %s\n" % e)

Parameters

Query parameters
Name Description
name
type
value

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


barcodeGeneratePost

Barcode generation via POST request.


/barcode/generate

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/barcode/generate?name=&type=&value="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Filename for the generated image.
        String type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
        String value = value_example; // String | Barcode value.
        try {
            SingleResponseModel result = apiInstance.barcodeGeneratePost(name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeGeneratePost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | Filename for the generated image.
        String type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
        String value = value_example; // String | Barcode value.
        try {
            SingleResponseModel result = apiInstance.barcodeGeneratePost(name, type, value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeGeneratePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // Filename for the generated image. (optional)
String *type = type_example; // Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional)
String *value = value_example; // Barcode value. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance barcodeGeneratePostWith:name
    type:type
    value:value
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} Filename for the generated image.
  'type': type_example, // {String} Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
  'value': value_example // {String} Barcode value.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodeGeneratePost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class barcodeGeneratePostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | Filename for the generated image. (optional) 
            var type = type_example;  // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional) 
            var value = value_example;  // String | Barcode value. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.barcodeGeneratePost(name, type, value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.barcodeGeneratePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | Filename for the generated image.
$type = type_example; // String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
$value = value_example; // String | Barcode value.

try {
    $result = $api_instance->barcodeGeneratePost($name, $type, $value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->barcodeGeneratePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | Filename for the generated image.
my $type = type_example; # String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14.
my $value = value_example; # String | Barcode value.

eval { 
    my $result = $api_instance->barcodeGeneratePost(name => $name, type => $type, value => $value);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->barcodeGeneratePost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | Filename for the generated image. (optional)
type = type_example # String | Barcode type. Valid values: Code128, Code39, Postnet, UPCA, EAN8, ISBN, Codabar, I2of5, Code93, EAN13, JAN13, Bookland, UPCE, PDF417, PDF417Truncated, DataMatrix, QRCode, Aztec, Planet, EAN128, GS1_128, USPSSackLabel, USPSTrayLabel, DeutschePostIdentcode, DeutschePostLeitcode, Numly, PZN, OpticalProduct, SwissPostParcel, RoyalMail, DutchKix, SingaporePostalCode, EAN2, EAN5, EAN14, MacroPDF417, MicroPDF417, GS1_DataMatrix, Telepen, IntelligentMail, GS1_DataBar_Omnidirectional, GS1_DataBar_Truncated, GS1_DataBar_Stacked, GS1_DataBar_Stacked_Omnidirectional, GS1_DataBar_Limited, GS1_DataBar_Expanded, GS1_DataBar_Expanded_Stacked, MaxiCode, Plessey, MSI, ITF14, GTIN12, GTIN8, GTIN13, GTIN14. (optional)
value = value_example # String | Barcode value. (optional)

try: 
    api_response = api_instance.barcodeGeneratePost(name=name, type=type, value=value)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->barcodeGeneratePost: %s\n" % e)

Parameters

Query parameters
Name Description
name
type
value

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

barcodeReadFromUrlGet

Read barcodes via GET request.


/barcode/read/from/url

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/barcode/read/from/url?async=&types=&url=&pages="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String async = async_example; // String | 
        String types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
        String url = url_example; // String | URL of the image to decode barcodes from.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        try {
            BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlGet(async, types, url, pages);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeReadFromUrlGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String async = async_example; // String | 
        String types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
        String url = url_example; // String | URL of the image to decode barcodes from.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        try {
            BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlGet(async, types, url, pages);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeReadFromUrlGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *async = async_example; //  (optional)
String *types = types_example; // Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional)
String *url = url_example; // URL of the image to decode barcodes from. (optional)
String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance barcodeReadFromUrlGetWith:async
    types:types
    url:url
    pages:pages
              completionHandler: ^(BarcodeReaderResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'async': async_example, // {String} 
  'types': types_example, // {String} Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
  'url': url_example, // {String} URL of the image to decode barcodes from.
  'pages': pages_example // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodeReadFromUrlGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class barcodeReadFromUrlGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var async = async_example;  // String |  (optional) 
            var types = types_example;  // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional) 
            var url = url_example;  // String | URL of the image to decode barcodes from. (optional) 
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 

            try
            {
                BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlGet(async, types, url, pages);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.barcodeReadFromUrlGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$async = async_example; // String | 
$types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
$url = url_example; // String | URL of the image to decode barcodes from.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.

try {
    $result = $api_instance->barcodeReadFromUrlGet($async, $types, $url, $pages);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->barcodeReadFromUrlGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $async = async_example; # String | 
my $types = types_example; # String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
my $url = url_example; # String | URL of the image to decode barcodes from.
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.

eval { 
    my $result = $api_instance->barcodeReadFromUrlGet(async => $async, types => $types, url => $url, pages => $pages);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->barcodeReadFromUrlGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
async = async_example # String |  (optional)
types = types_example # String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional)
url = url_example # String | URL of the image to decode barcodes from. (optional)
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)

try: 
    api_response = api_instance.barcodeReadFromUrlGet(async=async, types=types, url=url, pages=pages)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->barcodeReadFromUrlGet: %s\n" % e)

Parameters

Query parameters
Name Description
async
types
url
pages

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


barcodeReadFromUrlPost

Read barcodes via POST request.


/barcode/read/from/url

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/barcode/read/from/url?types=&pages=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String url = url_example; // String | URL of the image to decode barcodes from.
        try {
            BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlPost(types, pages, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeReadFromUrlPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String url = url_example; // String | URL of the image to decode barcodes from.
        try {
            BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlPost(types, pages, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#barcodeReadFromUrlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *types = types_example; // Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional)
String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *url = url_example; // URL of the image to decode barcodes from. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance barcodeReadFromUrlPostWith:types
    pages:pages
    url:url
              completionHandler: ^(BarcodeReaderResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'types': types_example, // {String} Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'url': url_example // {String} URL of the image to decode barcodes from.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.barcodeReadFromUrlPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class barcodeReadFromUrlPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var types = types_example;  // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional) 
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var url = url_example;  // String | URL of the image to decode barcodes from. (optional) 

            try
            {
                BarcodeReaderResponseModel result = apiInstance.barcodeReadFromUrlPost(types, pages, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.barcodeReadFromUrlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$types = types_example; // String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$url = url_example; // String | URL of the image to decode barcodes from.

try {
    $result = $api_instance->barcodeReadFromUrlPost($types, $pages, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->barcodeReadFromUrlPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $types = types_example; # String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU.
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $url = url_example; # String | URL of the image to decode barcodes from.

eval { 
    my $result = $api_instance->barcodeReadFromUrlPost(types => $types, pages => $pages, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->barcodeReadFromUrlPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
types = types_example # String | Comma-separated list of barcode types to decode. Valid types: AustralianPostCode, Aztec, CircularI2of5, Codabar, CodablockF, Code128, Code16K, Code39, Code39Extended, Code39Mod43, Code39Mod43Extended, Code93, DataMatrix, EAN13, EAN2, EAN5, EAN8, GS1, GS1DataBarExpanded, GS1DataBarExpandedStacked, GS1DataBarLimited, GS1DataBarOmnidirectional, GS1DataBarStacked, GTIN12, GTIN13, GTIN14, GTIN8, IntelligentMail, Interleaved2of5, ITF14, MaxiCode, MICR, MicroPDF, MSI, PatchCode, PDF417, Pharmacode, PostNet, PZN, QRCode, RoyalMail, RoyalMailKIX, Trioptic, UPCA, UPCE, UPU. (optional)
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
url = url_example # String | URL of the image to decode barcodes from. (optional)

try: 
    api_response = api_instance.barcodeReadFromUrlPost(types=types, pages=pages, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->barcodeReadFromUrlPost: %s\n" % e)

Parameters

Query parameters
Name Description
types
pages
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

fileHashGet


/file/hash

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/hash?url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | 
        try {
            FileHashResponseModel result = apiInstance.fileHashGet(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileHashGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | 
        try {
            FileHashResponseModel result = apiInstance.fileHashGet(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileHashGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileHashGetWith:url
              completionHandler: ^(FileHashResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileHashGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileHashGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var url = url_example;  // String |  (optional) 

            try
            {
                FileHashResponseModel result = apiInstance.fileHashGet(url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileHashGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$url = url_example; // String | 

try {
    $result = $api_instance->fileHashGet($url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileHashGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->fileHashGet(url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileHashGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
url = url_example # String |  (optional)

try: 
    api_response = api_instance.fileHashGet(url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileHashGet: %s\n" % e)

Parameters

Query parameters
Name Description
url

Responses

Status: 200 - 200 response



fileHashPost


/file/hash

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/hash?url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | 
        try {
            FileHashResponseModel result = apiInstance.fileHashPost(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileHashPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | 
        try {
            FileHashResponseModel result = apiInstance.fileHashPost(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileHashPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileHashPostWith:url
              completionHandler: ^(FileHashResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileHashPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileHashPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var url = url_example;  // String |  (optional) 

            try
            {
                FileHashResponseModel result = apiInstance.fileHashPost(url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileHashPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$url = url_example; // String | 

try {
    $result = $api_instance->fileHashPost($url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileHashPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->fileHashPost(url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileHashPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
url = url_example # String |  (optional)

try: 
    api_response = api_instance.fileHashPost(url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileHashPost: %s\n" % e)

Parameters

Query parameters
Name Description
url

Responses

Status: 200 - 200 response



fileUploadBase64Post

Upload a file to the cloud to use in other API methods. Uploaded files are automatically deleted after 1 hour.


/file/upload/base64

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/upload/base64?name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        FileUploadBase64RequestModel fileUploadBase64RequestModel = ; // FileUploadBase64RequestModel | 
        String name = name_example; // String | The name the file will be stored with.
        try {
            SingleResponseModel result = apiInstance.fileUploadBase64Post(fileUploadBase64RequestModel, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadBase64Post");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        FileUploadBase64RequestModel fileUploadBase64RequestModel = ; // FileUploadBase64RequestModel | 
        String name = name_example; // String | The name the file will be stored with.
        try {
            SingleResponseModel result = apiInstance.fileUploadBase64Post(fileUploadBase64RequestModel, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadBase64Post");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

FileUploadBase64RequestModel *fileUploadBase64RequestModel = ; // 
String *name = name_example; // The name the file will be stored with. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileUploadBase64PostWith:fileUploadBase64RequestModel
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var fileUploadBase64RequestModel = ; // {FileUploadBase64RequestModel} 

var opts = { 
  'name': name_example // {String} The name the file will be stored with.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileUploadBase64Post(fileUploadBase64RequestModel, opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileUploadBase64PostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var fileUploadBase64RequestModel = new FileUploadBase64RequestModel(); // FileUploadBase64RequestModel | 
            var name = name_example;  // String | The name the file will be stored with. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.fileUploadBase64Post(fileUploadBase64RequestModel, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileUploadBase64Post: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$fileUploadBase64RequestModel = ; // FileUploadBase64RequestModel | 
$name = name_example; // String | The name the file will be stored with.

try {
    $result = $api_instance->fileUploadBase64Post($fileUploadBase64RequestModel, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileUploadBase64Post: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $fileUploadBase64RequestModel = BytescoutApi::Object::FileUploadBase64RequestModel->new(); # FileUploadBase64RequestModel | 
my $name = name_example; # String | The name the file will be stored with.

eval { 
    my $result = $api_instance->fileUploadBase64Post(fileUploadBase64RequestModel => $fileUploadBase64RequestModel, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileUploadBase64Post: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
fileUploadBase64RequestModel =  # FileUploadBase64RequestModel | 
name = name_example # String | The name the file will be stored with. (optional)

try: 
    api_response = api_instance.fileUploadBase64Post(fileUploadBase64RequestModel, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileUploadBase64Post: %s\n" % e)

Parameters

Body parameters
Name Description
fileUploadBase64RequestModel *
Query parameters
Name Description
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

fileUploadGetPresignedUrlGet

Gets preassigned URL for binary file upload to the cloud to use in other API methods. Uploaded files are automatically deleted after 1 hour.


/file/upload/get-presigned-url

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/upload/get-presigned-url?contenttype=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String contenttype = contenttype_example; // String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
        String name = name_example; // String | The name the file will be stored with.
        try {
            PresignedUrlResponseModel result = apiInstance.fileUploadGetPresignedUrlGet(contenttype, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadGetPresignedUrlGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String contenttype = contenttype_example; // String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
        String name = name_example; // String | The name the file will be stored with.
        try {
            PresignedUrlResponseModel result = apiInstance.fileUploadGetPresignedUrlGet(contenttype, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadGetPresignedUrlGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *contenttype = contenttype_example; // Content-Type describing the data contained in the request body, Use 'binary/octet-stream'. (optional)
String *name = name_example; // The name the file will be stored with. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileUploadGetPresignedUrlGetWith:contenttype
    name:name
              completionHandler: ^(PresignedUrlResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'contenttype': contenttype_example, // {String} Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
  'name': name_example // {String} The name the file will be stored with.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileUploadGetPresignedUrlGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileUploadGetPresignedUrlGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var contenttype = contenttype_example;  // String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'. (optional) 
            var name = name_example;  // String | The name the file will be stored with. (optional) 

            try
            {
                PresignedUrlResponseModel result = apiInstance.fileUploadGetPresignedUrlGet(contenttype, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileUploadGetPresignedUrlGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$contenttype = contenttype_example; // String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
$name = name_example; // String | The name the file will be stored with.

try {
    $result = $api_instance->fileUploadGetPresignedUrlGet($contenttype, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileUploadGetPresignedUrlGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $contenttype = contenttype_example; # String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
my $name = name_example; # String | The name the file will be stored with.

eval { 
    my $result = $api_instance->fileUploadGetPresignedUrlGet(contenttype => $contenttype, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileUploadGetPresignedUrlGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
contenttype = contenttype_example # String | Content-Type describing the data contained in the request body, Use 'binary/octet-stream'. (optional)
name = name_example # String | The name the file will be stored with. (optional)

try: 
    api_response = api_instance.fileUploadGetPresignedUrlGet(contenttype=contenttype, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileUploadGetPresignedUrlGet: %s\n" % e)

Parameters

Query parameters
Name Description
contenttype
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


fileUploadUrlGet


/file/upload/url

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/upload/url?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.fileUploadUrlGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadUrlGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.fileUploadUrlGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadUrlGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileUploadUrlGetWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileUploadUrlGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileUploadUrlGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                SingleResponseModel result = apiInstance.fileUploadUrlGet(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileUploadUrlGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->fileUploadUrlGet($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileUploadUrlGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->fileUploadUrlGet(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileUploadUrlGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.fileUploadUrlGet(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileUploadUrlGet: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


fileUploadUrlPost


/file/upload/url

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/file/upload/url?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.fileUploadUrlPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadUrlPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.fileUploadUrlPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#fileUploadUrlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance fileUploadUrlPostWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fileUploadUrlPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class fileUploadUrlPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                SingleResponseModel result = apiInstance.fileUploadUrlPost(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.fileUploadUrlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->fileUploadUrlPost($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->fileUploadUrlPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->fileUploadUrlPost(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->fileUploadUrlPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.fileUploadUrlPost(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->fileUploadUrlPost: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

jobCheckGet


/job/check

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/job/check?jobid="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | 
        try {
            JobStatusResponseModel result = apiInstance.jobCheckGet(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | 
        try {
            JobStatusResponseModel result = apiInstance.jobCheckGet(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *jobid = jobid_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance jobCheckGetWith:jobid
              completionHandler: ^(JobStatusResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'jobid': jobid_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobCheckGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class jobCheckGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var jobid = jobid_example;  // String |  (optional) 

            try
            {
                JobStatusResponseModel result = apiInstance.jobCheckGet(jobid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.jobCheckGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$jobid = jobid_example; // String | 

try {
    $result = $api_instance->jobCheckGet($jobid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->jobCheckGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $jobid = jobid_example; # String | 

eval { 
    my $result = $api_instance->jobCheckGet(jobid => $jobid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->jobCheckGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
jobid = jobid_example # String |  (optional)

try: 
    api_response = api_instance.jobCheckGet(jobid=jobid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->jobCheckGet: %s\n" % e)

Parameters

Query parameters
Name Description
jobid

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


jobCheckPost


/job/check

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/job/check?jobid="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | 
        try {
            JobStatusResponseModel result = apiInstance.jobCheckPost(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | 
        try {
            JobStatusResponseModel result = apiInstance.jobCheckPost(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *jobid = jobid_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance jobCheckPostWith:jobid
              completionHandler: ^(JobStatusResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'jobid': jobid_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.jobCheckPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class jobCheckPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var jobid = jobid_example;  // String |  (optional) 

            try
            {
                JobStatusResponseModel result = apiInstance.jobCheckPost(jobid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.jobCheckPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$jobid = jobid_example; // String | 

try {
    $result = $api_instance->jobCheckPost($jobid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->jobCheckPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $jobid = jobid_example; # String | 

eval { 
    my $result = $api_instance->jobCheckPost(jobid => $jobid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->jobCheckPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
jobid = jobid_example # String |  (optional)

try: 
    api_response = api_instance.jobCheckPost(jobid=jobid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->jobCheckPost: %s\n" % e)

Parameters

Query parameters
Name Description
jobid

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertFromCsvGet

CSV to PDF conversion via GET request.


/pdf/convert/from/csv

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/csv?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromCsvGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromCsvGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromCsvGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromCsvGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // URL of the source CSV file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromCsvGetWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} URL of the source CSV file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromCsvGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromCsvGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | URL of the source CSV file. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromCsvGet(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromCsvGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | URL of the source CSV file.

try {
    $result = $api_instance->pdfConvertFromCsvGet($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromCsvGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | URL of the source CSV file.

eval { 
    my $result = $api_instance->pdfConvertFromCsvGet(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromCsvGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | URL of the source CSV file. (optional)

try: 
    api_response = api_instance.pdfConvertFromCsvGet(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromCsvGet: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertFromCsvPost

CSV to PDF conversion via POST request.


/pdf/convert/from/csv

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/csv?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromCsvPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromCsvPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromCsvPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromCsvPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // URL of the source CSV file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromCsvPostWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} URL of the source CSV file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromCsvPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromCsvPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | URL of the source CSV file. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromCsvPost(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromCsvPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | URL of the source CSV file.

try {
    $result = $api_instance->pdfConvertFromCsvPost($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromCsvPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | URL of the source CSV file.

eval { 
    my $result = $api_instance->pdfConvertFromCsvPost(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromCsvPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | URL of the source CSV file. (optional)

try: 
    api_response = api_instance.pdfConvertFromCsvPost(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromCsvPost: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertFromDocGet


/pdf/convert/from/doc

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/doc?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromDocGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromDocGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromDocGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromDocGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromDocGetWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromDocGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromDocGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromDocGet(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromDocGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->pdfConvertFromDocGet($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromDocGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->pdfConvertFromDocGet(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromDocGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.pdfConvertFromDocGet(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromDocGet: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertFromDocPost


/pdf/convert/from/doc

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/doc?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromDocPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromDocPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromDocPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromDocPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromDocPostWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} 
  'url': url_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromDocPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromDocPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromDocPost(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromDocPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->pdfConvertFromDocPost($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromDocPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->pdfConvertFromDocPost(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromDocPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.pdfConvertFromDocPost(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromDocPost: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertFromHtmlPost

HTML to PDF conversion via POST request.


/pdf/convert/from/html

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/html?name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        Text text = ; // Text | HTML data to convert to PDF.
        String name = name_example; // String | File name for the generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(text, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromHtmlPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        Text text = ; // Text | HTML data to convert to PDF.
        String name = name_example; // String | File name for the generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(text, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromHtmlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

Text *text = ; // HTML data to convert to PDF.
String *name = name_example; // File name for the generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromHtmlPostWith:text
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var text = ; // {Text} HTML data to convert to PDF.

var opts = { 
  'name': name_example // {String} File name for the generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromHtmlPost(text, opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromHtmlPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var text = new Text(); // Text | HTML data to convert to PDF.
            var name = name_example;  // String | File name for the generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(text, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromHtmlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$text = ; // Text | HTML data to convert to PDF.
$name = name_example; // String | File name for the generated result.

try {
    $result = $api_instance->pdfConvertFromHtmlPost($text, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromHtmlPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $text = BytescoutApi::Object::Text->new(); # Text | HTML data to convert to PDF.
my $name = name_example; # String | File name for the generated result.

eval { 
    my $result = $api_instance->pdfConvertFromHtmlPost(text => $text, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromHtmlPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
text =  # Text | HTML data to convert to PDF.
name = name_example # String | File name for the generated result. (optional)

try: 
    api_response = api_instance.pdfConvertFromHtmlPost(text, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromHtmlPost: %s\n" % e)

Parameters

Body parameters
Name Description
text *
Query parameters
Name Description
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertFromImageGet

Image to PDF conversion via GET request.


/pdf/convert/from/image

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/image?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source image file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromImageGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source image file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromImageGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // URL of the source image file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromImageGetWith:name
    url:url
              completionHandler: ^(JobSingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} URL of the source image file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromImageGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromImageGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | URL of the source image file. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromImageGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | URL of the source image file.

try {
    $result = $api_instance->pdfConvertFromImageGet($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromImageGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | URL of the source image file.

eval { 
    my $result = $api_instance->pdfConvertFromImageGet(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromImageGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | URL of the source image file. (optional)

try: 
    api_response = api_instance.pdfConvertFromImageGet(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromImageGet: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertFromImagePost

Image to PDF conversion via POST request.


/pdf/convert/from/image

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/image?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source image file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromImagePost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source image file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromImagePost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // URL of the source image file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromImagePostWith:name
    url:url
              completionHandler: ^(JobSingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} URL of the source image file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromImagePost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromImagePostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | URL of the source image file. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromImagePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | URL of the source image file.

try {
    $result = $api_instance->pdfConvertFromImagePost($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromImagePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | URL of the source image file.

eval { 
    my $result = $api_instance->pdfConvertFromImagePost(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromImagePost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | URL of the source image file. (optional)

try: 
    api_response = api_instance.pdfConvertFromImagePost(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromImagePost: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertFromUrlGet

Saves a web page to PDF document via GET request.


/pdf/convert/from/url

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/url?url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromUrlGet(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromUrlGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromUrlGet(url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromUrlGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *url = url_example; // URL of the web page to be saved as PDF document. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromUrlGetWith:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'url': url_example // {String} URL of the web page to be saved as PDF document.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromUrlGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromUrlGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var url = url_example;  // String | URL of the web page to be saved as PDF document. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromUrlGet(url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromUrlGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$url = url_example; // String | URL of the web page to be saved as PDF document.

try {
    $result = $api_instance->pdfConvertFromUrlGet($url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromUrlGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $url = url_example; # String | URL of the web page to be saved as PDF document.

eval { 
    my $result = $api_instance->pdfConvertFromUrlGet(url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromUrlGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
url = url_example # String | URL of the web page to be saved as PDF document. (optional)

try: 
    api_response = api_instance.pdfConvertFromUrlGet(url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromUrlGet: %s\n" % e)

Parameters

Query parameters
Name Description
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

Status: 400 - 400 response

Status: 500 - 500 response



pdfConvertFromUrlPost

Saves a web page to PDF document via POST request.


/pdf/convert/from/url

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/from/url?name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromUrlPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromUrlPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        try {
            SingleResponseModel result = apiInstance.pdfConvertFromUrlPost(name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertFromUrlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // URL of the web page to be saved as PDF document. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertFromUrlPostWith:name
    url:url
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} URL of the web page to be saved as PDF document.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertFromUrlPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertFromUrlPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | URL of the web page to be saved as PDF document. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertFromUrlPost(name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertFromUrlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | URL of the web page to be saved as PDF document.

try {
    $result = $api_instance->pdfConvertFromUrlPost($name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertFromUrlPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | URL of the web page to be saved as PDF document.

eval { 
    my $result = $api_instance->pdfConvertFromUrlPost(name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertFromUrlPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | URL of the web page to be saved as PDF document. (optional)

try: 
    api_response = api_instance.pdfConvertFromUrlPost(name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertFromUrlPost: %s\n" % e)

Parameters

Query parameters
Name Description
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertToCsvGet

PDF to CSV conversion via GET request.


/pdf/convert/to/csv

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/csv?inline=&url=&pages=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToCsvGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToCsvGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *inline = inline_example; //  (optional)
String *url = url_example; // URL of the source PDF file. (optional)
String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *name = name_example; // File name for generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToCsvGetWith:inline
    url:url
    pages:pages
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'inline': inline_example, // {String} 
  'url': url_example, // {String} URL of the source PDF file.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'name': name_example // {String} File name for generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToCsvGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToCsvGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var inline = inline_example;  // String |  (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, pages, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToCsvGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$inline = inline_example; // String | 
$url = url_example; // String | URL of the source PDF file.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$name = name_example; // String | File name for generated result.

try {
    $result = $api_instance->pdfConvertToCsvGet($inline, $url, $pages, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToCsvGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $inline = inline_example; # String | 
my $url = url_example; # String | URL of the source PDF file.
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $name = name_example; # String | File name for generated result.

eval { 
    my $result = $api_instance->pdfConvertToCsvGet(inline => $inline, url => $url, pages => $pages, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToCsvGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
inline = inline_example # String |  (optional)
url = url_example # String | URL of the source PDF file. (optional)
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
name = name_example # String | File name for generated result. (optional)

try: 
    api_response = api_instance.pdfConvertToCsvGet(inline=inline, url=url, pages=pages, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToCsvGet: %s\n" % e)

Parameters

Query parameters
Name Description
inline
url
pages
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertToCsvPost

PDF to CSV conversion via POST request.


/pdf/convert/to/csv

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/csv?inline=&url=&pages=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToCsvPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToCsvPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *inline = inline_example; //  (optional)
String *url = url_example; // URL of the source PDF file. (optional)
String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *name = name_example; // File name for generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToCsvPostWith:inline
    url:url
    pages:pages
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'inline': inline_example, // {String} 
  'url': url_example, // {String} URL of the source PDF file.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'name': name_example // {String} File name for generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToCsvPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToCsvPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var inline = inline_example;  // String |  (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, pages, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToCsvPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$inline = inline_example; // String | 
$url = url_example; // String | URL of the source PDF file.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$name = name_example; // String | File name for generated result.

try {
    $result = $api_instance->pdfConvertToCsvPost($inline, $url, $pages, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToCsvPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $inline = inline_example; # String | 
my $url = url_example; # String | URL of the source PDF file.
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $name = name_example; # String | File name for generated result.

eval { 
    my $result = $api_instance->pdfConvertToCsvPost(inline => $inline, url => $url, pages => $pages, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToCsvPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
inline = inline_example # String |  (optional)
url = url_example # String | URL of the source PDF file. (optional)
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
name = name_example # String | File name for generated result. (optional)

try: 
    api_response = api_instance.pdfConvertToCsvPost(inline=inline, url=url, pages=pages, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToCsvPost: %s\n" % e)

Parameters

Query parameters
Name Description
inline
url
pages
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertToHtmlGet

PDF to HTML conversion via GET request.


/pdf/convert/to/html

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/html?simple=&columns=&url=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
        String columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
        String url = url_example; // String | URL of the source PDF file.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, columns, url, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToHtmlGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
        String columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
        String url = url_example; // String | URL of the source PDF file.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, columns, url, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToHtmlGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *simple = simple_example; // Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional)
String *columns = columns_example; // Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional)
String *url = url_example; // URL of the source PDF file. (optional)
String *name = name_example; // File name for generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToHtmlGetWith:simple
    columns:columns
    url:url
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'simple': simple_example, // {String} Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
  'columns': columns_example, // {String} Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
  'url': url_example, // {String} URL of the source PDF file.
  'name': name_example // {String} File name for generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToHtmlGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToHtmlGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var simple = simple_example;  // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional) 
            var columns = columns_example;  // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, columns, url, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToHtmlGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
$columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
$url = url_example; // String | URL of the source PDF file.
$name = name_example; // String | File name for generated result.

try {
    $result = $api_instance->pdfConvertToHtmlGet($simple, $columns, $url, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToHtmlGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $simple = simple_example; # String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
my $columns = columns_example; # String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
my $url = url_example; # String | URL of the source PDF file.
my $name = name_example; # String | File name for generated result.

eval { 
    my $result = $api_instance->pdfConvertToHtmlGet(simple => $simple, columns => $columns, url => $url, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToHtmlGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
simple = simple_example # String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional)
columns = columns_example # String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional)
url = url_example # String | URL of the source PDF file. (optional)
name = name_example # String | File name for generated result. (optional)

try: 
    api_response = api_instance.pdfConvertToHtmlGet(simple=simple, columns=columns, url=url, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToHtmlGet: %s\n" % e)

Parameters

Query parameters
Name Description
simple
columns
url
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertToHtmlPost

PDF to HTML conversion via POST request.


/pdf/convert/to/html

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/html?simple=&columns=&url=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
        String columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
        String url = url_example; // String | URL of the source PDF file.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, columns, url, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToHtmlPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
        String columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
        String url = url_example; // String | URL of the source PDF file.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, columns, url, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToHtmlPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *simple = simple_example; // Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional)
String *columns = columns_example; // Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional)
String *url = url_example; // URL of the source PDF file. (optional)
String *name = name_example; // File name for generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToHtmlPostWith:simple
    columns:columns
    url:url
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'simple': simple_example, // {String} Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
  'columns': columns_example, // {String} Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
  'url': url_example, // {String} URL of the source PDF file.
  'name': name_example // {String} File name for generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToHtmlPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToHtmlPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var simple = simple_example;  // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional) 
            var columns = columns_example;  // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, columns, url, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToHtmlPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$simple = simple_example; // String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
$columns = columns_example; // String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
$url = url_example; // String | URL of the source PDF file.
$name = name_example; // String | File name for generated result.

try {
    $result = $api_instance->pdfConvertToHtmlPost($simple, $columns, $url, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToHtmlPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $simple = simple_example; # String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
my $columns = columns_example; # String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
my $url = url_example; # String | URL of the source PDF file.
my $name = name_example; # String | File name for generated result.

eval { 
    my $result = $api_instance->pdfConvertToHtmlPost(simple => $simple, columns => $columns, url => $url, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToHtmlPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
simple = simple_example # String | Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. (optional)
columns = columns_example # String | Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'. (optional)
url = url_example # String | URL of the source PDF file. (optional)
name = name_example # String | File name for generated result. (optional)

try: 
    api_response = api_instance.pdfConvertToHtmlPost(simple=simple, columns=columns, url=url, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToHtmlPost: %s\n" % e)

Parameters

Query parameters
Name Description
simple
columns
url
name

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertToJpgGet

PDF to JPEG image conversion via GET request.


/pdf/convert/to/jpg

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/jpg?pages=&name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        String url = url_example; // String | URL of the source PDF file.
        try {
            MultiResponseModel result = apiInstance.pdfConvertToJpgGet(pages, name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJpgGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        String url = url_example; // String | URL of the source PDF file.
        try {
            MultiResponseModel result = apiInstance.pdfConvertToJpgGet(pages, name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJpgGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *name = name_example; // File name for generated result. (optional)
String *url = url_example; // URL of the source PDF file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToJpgGetWith:pages
    name:name
    url:url
              completionHandler: ^(MultiResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'name': name_example, // {String} File name for generated result.
  'url': url_example // {String} URL of the source PDF file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToJpgGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToJpgGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 

            try
            {
                MultiResponseModel result = apiInstance.pdfConvertToJpgGet(pages, name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToJpgGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$name = name_example; // String | File name for generated result.
$url = url_example; // String | URL of the source PDF file.

try {
    $result = $api_instance->pdfConvertToJpgGet($pages, $name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToJpgGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $name = name_example; # String | File name for generated result.
my $url = url_example; # String | URL of the source PDF file.

eval { 
    my $result = $api_instance->pdfConvertToJpgGet(pages => $pages, name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToJpgGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
name = name_example # String | File name for generated result. (optional)
url = url_example # String | URL of the source PDF file. (optional)

try: 
    api_response = api_instance.pdfConvertToJpgGet(pages=pages, name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToJpgGet: %s\n" % e)

Parameters

Query parameters
Name Description
pages
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String


pdfConvertToJpgPost

PDF to JPEG image conversion via POST request.


/pdf/convert/to/jpg

Usage and SDK Samples

curl -X post -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/jpg?pages=&name=&url="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        String url = url_example; // String | URL of the source PDF file.
        try {
            MultiResponseModel result = apiInstance.pdfConvertToJpgPost(pages, name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJpgPost");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        String url = url_example; // String | URL of the source PDF file.
        try {
            MultiResponseModel result = apiInstance.pdfConvertToJpgPost(pages, name, url);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJpgPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *name = name_example; // File name for generated result. (optional)
String *url = url_example; // URL of the source PDF file. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToJpgPostWith:pages
    name:name
    url:url
              completionHandler: ^(MultiResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'name': name_example, // {String} File name for generated result.
  'url': url_example // {String} URL of the source PDF file.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToJpgPost(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToJpgPostExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 

            try
            {
                MultiResponseModel result = apiInstance.pdfConvertToJpgPost(pages, name, url);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToJpgPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$name = name_example; // String | File name for generated result.
$url = url_example; // String | URL of the source PDF file.

try {
    $result = $api_instance->pdfConvertToJpgPost($pages, $name, $url);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToJpgPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $name = name_example; # String | File name for generated result.
my $url = url_example; # String | URL of the source PDF file.

eval { 
    my $result = $api_instance->pdfConvertToJpgPost(pages => $pages, name => $name, url => $url);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToJpgPost: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
name = name_example # String | File name for generated result. (optional)
url = url_example # String | URL of the source PDF file. (optional)

try: 
    api_response = api_instance.pdfConvertToJpgPost(pages=pages, name=name, url=url)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToJpgPost: %s\n" % e)

Parameters

Query parameters
Name Description
pages
name
url

Responses

Status: 200 - 200 response

Name Type Format Description
Access-Control-Allow-Origin String

pdfConvertToJsonGet

PDF to JSON conversion via GET request.


/pdf/convert/to/json

Usage and SDK Samples

curl -X get -H "x-api-key: [[apiKey]]" "https://bytescout.io/v1/pdf/convert/to/json?inline=&url=&pages=&name="
import Bytescout\Client\API.*;
import Bytescout\Client\API.auth.*;
import Bytescout\Client\API.model.*;
import Bytescout\Client\API.api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToJsonGet(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJsonGet");
            e.printStackTrace();
        }
    }
}
import Bytescout\Client\API.api.DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String inline = inline_example; // String | 
        String url = url_example; // String | URL of the source PDF file.
        String pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
        String name = name_example; // String | File name for generated result.
        try {
            SingleResponseModel result = apiInstance.pdfConvertToJsonGet(inline, url, pages, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#pdfConvertToJsonGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];

String *inline = inline_example; //  (optional)
String *url = url_example; // URL of the source PDF file. (optional)
String *pages = pages_example; // Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
String *name = name_example; // File name for generated result. (optional)

DefaultApi *apiInstance = [[DefaultApi alloc] init];

[apiInstance pdfConvertToJsonGetWith:inline
    url:url
    pages:pages
    name:name
              completionHandler: ^(SingleResponseModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var bytescout = require('bytescout');
var defaultClient = bytescout.ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['x-api-key'] = "Token"

var api = new bytescout.DefaultApi()

var opts = { 
  'inline': inline_example, // {String} 
  'url': url_example, // {String} URL of the source PDF file.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'name': name_example // {String} File name for generated result.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pdfConvertToJsonGet(opts, callback);
using System;
using System.Diagnostics;
using Bytescout.API.Api;
using Bytescout.API.Client;
using Bytescout.API.Model;

namespace Example
{
    public class pdfConvertToJsonGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("x-api-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("x-api-key", "Bearer");

            var apiInstance = new DefaultApi();
            var inline = inline_example;  // String |  (optional) 
            var url = url_example;  // String | URL of the source PDF file. (optional) 
            var pages = pages_example;  // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional) 
            var name = name_example;  // String | File name for generated result. (optional) 

            try
            {
                SingleResponseModel result = apiInstance.pdfConvertToJsonGet(inline, url, pages, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.pdfConvertToJsonGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Bytescout\Client\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$inline = inline_example; // String | 
$url = url_example; // String | URL of the source PDF file.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$name = name_example; // String | File name for generated result.

try {
    $result = $api_instance->pdfConvertToJsonGet($inline, $url, $pages, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->pdfConvertToJsonGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use BytescoutApi::Configuration;
use BytescoutApi::DefaultApi;

# Configure API key authorization: api_key
$BytescoutApi::Configuration::api_key->{'x-api-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$BytescoutApi::Configuration::api_key_prefix->{'x-api-key'} = "Bearer";

my $api_instance = BytescoutApi::DefaultApi->new();
my $inline = inline_example; # String | 
my $url = url_example; # String | URL of the source PDF file.
my $pages = pages_example; # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
my $name = name_example; # String | File name for generated result.

eval { 
    my $result = $api_instance->pdfConvertToJsonGet(inline => $inline, url => $url, pages => $pages, name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DefaultApi->pdfConvertToJsonGet: $@\n";
}
from __future__ import print_statement
import time
import bytescout_api
from bytescout_api.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
bytescout_api.configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# bytescout_api.configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
inline = inline_example # String |  (optional)
url = url_example # String | URL of the source PDF file. (optional)
pages = pages_example # String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. (optional)
name = name_example # String | File name for generated result. (optional)

try: 
    api_response = api_instance.pdfConvertToJsonGet(inline=inline, url=url, pages=pages, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToJsonGet: %s\n" % e)

Parameters

Query parameters
Name Description
inline
url
pages
name

Responses

Status: 200 - 200 response