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?async=&value=&name=&type="
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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String value = value_example; // String | Barcode value.
        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.
        try {
            JobSingleResponseModel result = apiInstance.barcodeGenerateGet(async, value, name, type);
            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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String value = value_example; // String | Barcode value.
        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.
        try {
            JobSingleResponseModel result = apiInstance.barcodeGenerateGet(async, value, name, type);
            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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *value = value_example; // Barcode value. (optional)
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)

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

[apiInstance barcodeGenerateGetWith:async
    value:value
    name:name
    type:type
              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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'value': value_example, // {String} Barcode value.
  '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.
};

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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var value = value_example;  // String | Barcode value. (optional) 
            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) 

            try
            {
                JobSingleResponseModel result = apiInstance.barcodeGenerateGet(async, value, name, type);
                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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$value = value_example; // String | Barcode value.
$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.

try {
    $result = $api_instance->barcodeGenerateGet($async, $value, $name, $type);
    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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $value = value_example; # String | Barcode value.
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.

eval { 
    my $result = $api_instance->barcodeGenerateGet(async => $async, value => $value, name => $name, type => $type);
    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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
value = value_example # String | Barcode value. (optional)
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)

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

Parameters

Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
value
String
Barcode value.
name
String
Filename for the generated image.
type
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.

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?async=&value=&name=&type="
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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String value = value_example; // String | Barcode value.
        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.
        try {
            JobSingleResponseModel result = apiInstance.barcodeGeneratePost(async, value, name, type);
            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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String value = value_example; // String | Barcode value.
        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.
        try {
            JobSingleResponseModel result = apiInstance.barcodeGeneratePost(async, value, name, type);
            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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *value = value_example; // Barcode value. (optional)
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)

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

[apiInstance barcodeGeneratePostWith:async
    value:value
    name:name
    type:type
              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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'value': value_example, // {String} Barcode value.
  '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.
};

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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var value = value_example;  // String | Barcode value. (optional) 
            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) 

            try
            {
                JobSingleResponseModel result = apiInstance.barcodeGeneratePost(async, value, name, type);
                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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$value = value_example; // String | Barcode value.
$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.

try {
    $result = $api_instance->barcodeGeneratePost($async, $value, $name, $type);
    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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $value = value_example; # String | Barcode value.
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.

eval { 
    my $result = $api_instance->barcodeGeneratePost(async => $async, value => $value, name => $name, type => $type);
    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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
value = value_example # String | Barcode value. (optional)
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)

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

Parameters

Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
value
String
Barcode value.
name
String
Filename for the generated image.
type
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.

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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        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; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (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} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  '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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
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 | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (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.barcode_read_from_url_get(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
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
types
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
String
URL of the image to decode barcodes from.
pages
String
Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.

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.barcode_read_from_url_post(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
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
String
Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
url
String
URL of the image to decode barcodes from.

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 | URL of the file to calculate hash.
        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 | URL of the file to calculate hash.
        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; // URL of the file to calculate hash. (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} URL of the file to calculate hash.
};

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 | URL of the file to calculate hash. (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 | URL of the file to calculate hash.

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 | URL of the file to calculate hash.

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 | URL of the file to calculate hash. (optional)

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

Parameters

Query parameters
Name Description
url
String
URL of the file to calculate hash.

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 | URL of the file to calculate hash.
        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 | URL of the file to calculate hash.
        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; // URL of the file to calculate hash. (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} URL of the file to calculate hash.
};

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 | URL of the file to calculate hash. (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 | URL of the file to calculate hash.

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 | URL of the file to calculate hash.

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 | URL of the file to calculate hash. (optional)

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

Parameters

Query parameters
Name Description
url
String
URL of the file to calculate hash.

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.file_upload_base64_post(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
String
The name the file will be stored with.

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.file_upload_get_presigned_url_get(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
String
Content-Type describing the data contained in the request body, Use 'binary/octet-stream'.
name
String
The name the file will be stored with.

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.file_upload_url_get(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
String
url
String

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.file_upload_url_post(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
String
url
String

Responses

Status: 200 - 200 response

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

jobCheckGet


/job/check

Usage and SDK Samples

curl -X GET "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) {
        
        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | Id of processing that was started asynchronously
        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 | Id of processing that was started asynchronously
        try {
            JobStatusResponseModel result = apiInstance.jobCheckGet(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckGet");
            e.printStackTrace();
        }
    }
}
String *jobid = jobid_example; // Id of processing that was started asynchronously (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 api = new bytescout.DefaultApi()

var opts = { 
  'jobid': jobid_example // {String} Id of processing that was started asynchronously
};

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()
        {
            
            var apiInstance = new DefaultApi();
            var jobid = jobid_example;  // String | Id of processing that was started asynchronously (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');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$jobid = jobid_example; // String | Id of processing that was started asynchronously

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;

my $api_instance = BytescoutApi::DefaultApi->new();
my $jobid = jobid_example; # String | Id of processing that was started asynchronously

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

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
jobid = jobid_example # String | Id of processing that was started asynchronously (optional)

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

Parameters

Query parameters
Name Description
jobid
String
Id of processing that was started asynchronously

Responses

Status: 200 - 200 response

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


jobCheckPost


/job/check

Usage and SDK Samples

curl -X POST "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) {
        
        DefaultApi apiInstance = new DefaultApi();
        String jobid = jobid_example; // String | Id of processing that was started asynchronously
        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 | Id of processing that was started asynchronously
        try {
            JobStatusResponseModel result = apiInstance.jobCheckPost(jobid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#jobCheckPost");
            e.printStackTrace();
        }
    }
}
String *jobid = jobid_example; // Id of processing that was started asynchronously (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 api = new bytescout.DefaultApi()

var opts = { 
  'jobid': jobid_example // {String} Id of processing that was started asynchronously
};

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()
        {
            
            var apiInstance = new DefaultApi();
            var jobid = jobid_example;  // String | Id of processing that was started asynchronously (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');

$api_instance = new Bytescout\Client\Api\DefaultApi();
$jobid = jobid_example; // String | Id of processing that was started asynchronously

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;

my $api_instance = BytescoutApi::DefaultApi->new();
my $jobid = jobid_example; # String | Id of processing that was started asynchronously

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

# create an instance of the API class
api_instance = bytescout_api.DefaultApi()
jobid = jobid_example # String | Id of processing that was started asynchronously (optional)

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

Parameters

Query parameters
Name Description
jobid
String
Id of processing that was started asynchronously

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromCsvGet(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromCsvGet(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
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:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            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
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromCsvGet(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$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($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
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(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
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.pdf_convert_from_csv_get(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
File name for the generated result.
url
String
URL of the source CSV file.

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromCsvPost(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | URL of the source CSV file.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromCsvPost(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
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:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            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
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromCsvPost(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$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($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
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(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
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.pdf_convert_from_csv_post(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
File name for the generated result.
url
String
URL of the source CSV file.

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromDocGet(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromDocGet(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

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

[apiInstance pdfConvertFromDocGetWith:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromDocGet(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->pdfConvertFromDocGet($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->pdfConvertFromDocGet(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.pdf_convert_from_doc_get(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
url
String

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromDocPost(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | 
        String url = url_example; // String | 
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromDocPost(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *name = name_example; //  (optional)
String *url = url_example; //  (optional)

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

[apiInstance pdfConvertFromDocPostWith:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var name = name_example;  // String |  (optional) 
            var url = url_example;  // String |  (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromDocPost(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$name = name_example; // String | 
$url = url_example; // String | 

try {
    $result = $api_instance->pdfConvertFromDocPost($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $name = name_example; # String | 
my $url = url_example; # String | 

eval { 
    my $result = $api_instance->pdfConvertFromDocPost(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
name = name_example # String |  (optional)
url = url_example # String |  (optional)

try: 
    api_response = api_instance.pdf_convert_from_doc_post(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
url
String

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?async=&templatedata=&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();
        HtmlToPdfRequestModel htmlToPdfRequestModel = ; // HtmlToPdfRequestModel | HTML data to convert to PDF.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String html = html_example; // String | HTML code
        String name = name_example; // String | File name for the generated result.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(htmlToPdfRequestModel, async, templatedata, html, 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();
        HtmlToPdfRequestModel htmlToPdfRequestModel = ; // HtmlToPdfRequestModel | HTML data to convert to PDF.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String html = html_example; // String | HTML code
        String name = name_example; // String | File name for the generated result.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(htmlToPdfRequestModel, async, templatedata, html, 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"];

HtmlToPdfRequestModel *htmlToPdfRequestModel = ; // HTML data to convert to PDF.
String *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *templatedata = templatedata_example; // JSON model which will be used for processing HTML template (optional)
String *html = html_example; // HTML code (optional)
String *name = name_example; // File name for the generated result. (optional)

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

[apiInstance pdfConvertFromHtmlPostWith:htmlToPdfRequestModel
    async:async
    templatedata:templatedata
    html:html
    name:name
              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 htmlToPdfRequestModel = ; // {HtmlToPdfRequestModel} HTML data to convert to PDF.

var opts = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'templatedata': templatedata_example, // {String} JSON model which will be used for processing HTML template
  'html': html_example, // {String} HTML code
  '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(htmlToPdfRequestModel, 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 htmlToPdfRequestModel = new HtmlToPdfRequestModel(); // HtmlToPdfRequestModel | HTML data to convert to PDF.
            var async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var templatedata = templatedata_example;  // String | JSON model which will be used for processing HTML template (optional) 
            var html = html_example;  // String | HTML code (optional) 
            var name = name_example;  // String | File name for the generated result. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromHtmlPost(htmlToPdfRequestModel, async, templatedata, html, 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();
$htmlToPdfRequestModel = ; // HtmlToPdfRequestModel | HTML data to convert to PDF.
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
$html = html_example; // String | HTML code
$name = name_example; // String | File name for the generated result.

try {
    $result = $api_instance->pdfConvertFromHtmlPost($htmlToPdfRequestModel, $async, $templatedata, $html, $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 $htmlToPdfRequestModel = BytescoutApi::Object::HtmlToPdfRequestModel->new(); # HtmlToPdfRequestModel | HTML data to convert to PDF.
my $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $templatedata = templatedata_example; # String | JSON model which will be used for processing HTML template
my $html = html_example; # String | HTML code
my $name = name_example; # String | File name for the generated result.

eval { 
    my $result = $api_instance->pdfConvertFromHtmlPost(htmlToPdfRequestModel => $htmlToPdfRequestModel, async => $async, templatedata => $templatedata, html => $html, 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()
htmlToPdfRequestModel =  # HtmlToPdfRequestModel | HTML data to convert to PDF.
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
templatedata = templatedata_example # String | JSON model which will be used for processing HTML template (optional)
html = html_example # String | HTML code (optional)
name = name_example # String | File name for the generated result. (optional)

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

Parameters

Body parameters
Name Description
htmlToPdfRequestModel *
Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
templatedata
String
JSON model which will be used for processing HTML template
html
String
HTML code
name
String
File name for the generated result.

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | Comma-separated list of URLs of input image files.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | Comma-separated list of URLs of input image files.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // Comma-separated list of URLs of input image files. (optional)

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

[apiInstance pdfConvertFromImageGetWith:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} Comma-separated list of URLs of input image files.
};

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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | Comma-separated list of URLs of input image files. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromImageGet(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | Comma-separated list of URLs of input image files.

try {
    $result = $api_instance->pdfConvertFromImageGet($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | Comma-separated list of URLs of input image files.

eval { 
    my $result = $api_instance->pdfConvertFromImageGet(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | Comma-separated list of URLs of input image files. (optional)

try: 
    api_response = api_instance.pdf_convert_from_image_get(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
File name for the generated result.
url
String
Comma-separated list of URLs of input image files.

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?async=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | Comma-separated list of URLs of input image files.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(async, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String name = name_example; // String | File name for the generated result.
        String url = url_example; // String | Comma-separated list of URLs of input image files.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(async, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *name = name_example; // File name for the generated result. (optional)
String *url = url_example; // Comma-separated list of URLs of input image files. (optional)

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

[apiInstance pdfConvertFromImagePostWith:async
    name: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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'name': name_example, // {String} File name for the generated result.
  'url': url_example // {String} Comma-separated list of URLs of input image files.
};

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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var name = name_example;  // String | File name for the generated result. (optional) 
            var url = url_example;  // String | Comma-separated list of URLs of input image files. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromImagePost(async, 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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$name = name_example; // String | File name for the generated result.
$url = url_example; // String | Comma-separated list of URLs of input image files.

try {
    $result = $api_instance->pdfConvertFromImagePost($async, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $name = name_example; # String | File name for the generated result.
my $url = url_example; # String | Comma-separated list of URLs of input image files.

eval { 
    my $result = $api_instance->pdfConvertFromImagePost(async => $async, 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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
name = name_example # String | File name for the generated result. (optional)
url = url_example # String | Comma-separated list of URLs of input image files. (optional)

try: 
    api_response = api_instance.pdf_convert_from_image_post(async=async, 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
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
name
String
File name for the generated result.
url
String
Comma-separated list of URLs of input image files.

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?async=&templatedata=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        String name = name_example; // String | File name for the generated result
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromUrlGet(async, templatedata, url, name);
            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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        String name = name_example; // String | File name for the generated result
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromUrlGet(async, templatedata, url, name);
            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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *templatedata = templatedata_example; // JSON model which will be used for processing HTML template (optional)
String *url = url_example; // URL of the web page to be saved as PDF document. (optional)
String *name = name_example; // File name for the generated result (optional)

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

[apiInstance pdfConvertFromUrlGetWith:async
    templatedata:templatedata
    url:url
    name:name
              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 = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'templatedata': templatedata_example, // {String} JSON model which will be used for processing HTML template
  'url': url_example, // {String} URL of the web page to be saved as PDF document.
  '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.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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var templatedata = templatedata_example;  // String | JSON model which will be used for processing HTML template (optional) 
            var url = url_example;  // String | URL of the web page to be saved as PDF document. (optional) 
            var name = name_example;  // String | File name for the generated result (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromUrlGet(async, templatedata, url, name);
                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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
$url = url_example; // String | URL of the web page to be saved as PDF document.
$name = name_example; // String | File name for the generated result

try {
    $result = $api_instance->pdfConvertFromUrlGet($async, $templatedata, $url, $name);
    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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $templatedata = templatedata_example; # String | JSON model which will be used for processing HTML template
my $url = url_example; # String | URL of the web page to be saved as PDF document.
my $name = name_example; # String | File name for the generated result

eval { 
    my $result = $api_instance->pdfConvertFromUrlGet(async => $async, templatedata => $templatedata, url => $url, name => $name);
    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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
templatedata = templatedata_example # String | JSON model which will be used for processing HTML template (optional)
url = url_example # String | URL of the web page to be saved as PDF document. (optional)
name = name_example # String | File name for the generated result (optional)

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

Parameters

Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
templatedata
String
JSON model which will be used for processing HTML template
url
String
URL of the web page to be saved as PDF document.
name
String
File name for the generated result

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?async=&templatedata=&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();
        UrlToPdfRequestModel urlToPdfRequestModel = ; // UrlToPdfRequestModel | 
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        String name = name_example; // String | File name for the generated result.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromUrlPost(urlToPdfRequestModel, async, templatedata, url, name);
            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();
        UrlToPdfRequestModel urlToPdfRequestModel = ; // UrlToPdfRequestModel | 
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
        String url = url_example; // String | URL of the web page to be saved as PDF document.
        String name = name_example; // String | File name for the generated result.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertFromUrlPost(urlToPdfRequestModel, async, templatedata, url, name);
            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"];

UrlToPdfRequestModel *urlToPdfRequestModel = ; // 
String *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *templatedata = templatedata_example; // JSON model which will be used for processing HTML template (optional)
String *url = url_example; // URL of the web page to be saved as PDF document. (optional)
String *name = name_example; // File name for the generated result. (optional)

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

[apiInstance pdfConvertFromUrlPostWith:urlToPdfRequestModel
    async:async
    templatedata:templatedata
    url:url
    name:name
              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 urlToPdfRequestModel = ; // {UrlToPdfRequestModel} 

var opts = { 
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'templatedata': templatedata_example, // {String} JSON model which will be used for processing HTML template
  'url': url_example, // {String} URL of the web page to be saved as PDF document.
  '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.pdfConvertFromUrlPost(urlToPdfRequestModel, 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 urlToPdfRequestModel = new UrlToPdfRequestModel(); // UrlToPdfRequestModel | 
            var async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var templatedata = templatedata_example;  // String | JSON model which will be used for processing HTML template (optional) 
            var url = url_example;  // String | URL of the web page to be saved as PDF document. (optional) 
            var name = name_example;  // String | File name for the generated result. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertFromUrlPost(urlToPdfRequestModel, async, templatedata, url, name);
                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();
$urlToPdfRequestModel = ; // UrlToPdfRequestModel | 
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$templatedata = templatedata_example; // String | JSON model which will be used for processing HTML template
$url = url_example; // String | URL of the web page to be saved as PDF document.
$name = name_example; // String | File name for the generated result.

try {
    $result = $api_instance->pdfConvertFromUrlPost($urlToPdfRequestModel, $async, $templatedata, $url, $name);
    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 $urlToPdfRequestModel = BytescoutApi::Object::UrlToPdfRequestModel->new(); # UrlToPdfRequestModel | 
my $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $templatedata = templatedata_example; # String | JSON model which will be used for processing HTML template
my $url = url_example; # String | URL of the web page to be saved as PDF document.
my $name = name_example; # String | File name for the generated result.

eval { 
    my $result = $api_instance->pdfConvertFromUrlPost(urlToPdfRequestModel => $urlToPdfRequestModel, async => $async, templatedata => $templatedata, url => $url, name => $name);
    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()
urlToPdfRequestModel =  # UrlToPdfRequestModel | 
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
templatedata = templatedata_example # String | JSON model which will be used for processing HTML template (optional)
url = url_example # String | URL of the web page to be saved as PDF document. (optional)
name = name_example # String | File name for the generated result. (optional)

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

Parameters

Body parameters
Name Description
urlToPdfRequestModel *
Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
templatedata
String
JSON model which will be used for processing HTML template
url
String
URL of the web page to be saved as PDF document.
name
String
File name for the generated result.

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=&name=&async=&password=&unwrap=&pages=&lineGrouping="
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 name = name_example; // String | File name for generated result.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        String unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
        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 lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, name, async, password, unwrap, pages, lineGrouping);
            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 name = name_example; // String | File name for generated result.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        String unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
        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 lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, name, async, password, unwrap, pages, lineGrouping);
            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 *name = name_example; // File name for generated result. (optional)
String *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *password = password_example; // Password of PDF file (optional)
String *unwrap = unwrap_example; // Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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 *lineGrouping = lineGrouping_example; // Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional)

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

[apiInstance pdfConvertToCsvGetWith:inline
    url:url
    name:name
    async:async
    password:password
    unwrap:unwrap
    pages:pages
    lineGrouping:lineGrouping
              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 = { 
  'inline': inline_example, // {String} 
  'url': url_example, // {String} URL of the source PDF file.
  'name': name_example, // {String} File name for generated result.
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'password': password_example, // {String} Password of PDF file
  'unwrap': unwrap_example, // {String} Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'lineGrouping': lineGrouping_example // {String} Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
};

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 name = name_example;  // String | File name for generated result. (optional) 
            var async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var password = password_example;  // String | Password of PDF file (optional) 
            var unwrap = unwrap_example;  // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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 lineGrouping = lineGrouping_example;  // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertToCsvGet(inline, url, name, async, password, unwrap, pages, lineGrouping);
                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.
$name = name_example; // String | File name for generated result.
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$password = password_example; // String | Password of PDF file
$unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

try {
    $result = $api_instance->pdfConvertToCsvGet($inline, $url, $name, $async, $password, $unwrap, $pages, $lineGrouping);
    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 $name = name_example; # String | File name for generated result.
my $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $password = password_example; # String | Password of PDF file
my $unwrap = unwrap_example; # String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
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 $lineGrouping = lineGrouping_example; # String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

eval { 
    my $result = $api_instance->pdfConvertToCsvGet(inline => $inline, url => $url, name => $name, async => $async, password => $password, unwrap => $unwrap, pages => $pages, lineGrouping => $lineGrouping);
    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)
name = name_example # String | File name for generated result. (optional)
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
password = password_example # String | Password of PDF file (optional)
unwrap = unwrap_example # String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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)
lineGrouping = lineGrouping_example # String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional)

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

Parameters

Query parameters
Name Description
inline
String
url
String
URL of the source PDF file.
name
String
File name for generated result.
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
password
String
Password of PDF file
unwrap
String
Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
pages
String
Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
lineGrouping
String
Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

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=&name=&async=&password=&unwrap=&pages=&lineGrouping="
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 name = name_example; // String | File name for generated result.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        String unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
        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 lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, name, async, password, unwrap, pages, lineGrouping);
            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 name = name_example; // String | File name for generated result.
        String async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        String unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
        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 lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
        try {
            JobSingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, name, async, password, unwrap, pages, lineGrouping);
            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 *name = name_example; // File name for generated result. (optional)
String *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *password = password_example; // Password of PDF file (optional)
String *unwrap = unwrap_example; // Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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 *lineGrouping = lineGrouping_example; // Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional)

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

[apiInstance pdfConvertToCsvPostWith:inline
    url:url
    name:name
    async:async
    password:password
    unwrap:unwrap
    pages:pages
    lineGrouping:lineGrouping
              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 = { 
  'inline': inline_example, // {String} 
  'url': url_example, // {String} URL of the source PDF file.
  'name': name_example, // {String} File name for generated result.
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'password': password_example, // {String} Password of PDF file
  'unwrap': unwrap_example, // {String} Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
  'pages': pages_example, // {String} Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
  'lineGrouping': lineGrouping_example // {String} Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.
};

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 name = name_example;  // String | File name for generated result. (optional) 
            var async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var password = password_example;  // String | Password of PDF file (optional) 
            var unwrap = unwrap_example;  // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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 lineGrouping = lineGrouping_example;  // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional) 

            try
            {
                JobSingleResponseModel result = apiInstance.pdfConvertToCsvPost(inline, url, name, async, password, unwrap, pages, lineGrouping);
                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.
$name = name_example; // String | File name for generated result.
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$password = password_example; // String | Password of PDF file
$unwrap = unwrap_example; // String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
$pages = pages_example; // String | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
$lineGrouping = lineGrouping_example; // String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

try {
    $result = $api_instance->pdfConvertToCsvPost($inline, $url, $name, $async, $password, $unwrap, $pages, $lineGrouping);
    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 $name = name_example; # String | File name for generated result.
my $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $password = password_example; # String | Password of PDF file
my $unwrap = unwrap_example; # String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
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 $lineGrouping = lineGrouping_example; # String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

eval { 
    my $result = $api_instance->pdfConvertToCsvPost(inline => $inline, url => $url, name => $name, async => $async, password => $password, unwrap => $unwrap, pages => $pages, lineGrouping => $lineGrouping);
    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)
name = name_example # String | File name for generated result. (optional)
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
password = password_example # String | Password of PDF file (optional)
unwrap = unwrap_example # String | Unwrap lines into a single line within table cells when `lineGrouping` is enabled. (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)
lineGrouping = lineGrouping_example # String | Line grouping within table cells. Add `lineGrouping=1` to enable the grouping. (optional)

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

Parameters

Query parameters
Name Description
inline
String
url
String
URL of the source PDF file.
name
String
File name for generated result.
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
password
String
Password of PDF file
unwrap
String
Unwrap lines into a single line within table cells when `lineGrouping` is enabled.
pages
String
Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
lineGrouping
String
Line grouping within table cells. Add `lineGrouping=1` to enable the grouping.

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=&async=&password=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobSingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, async, password, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobSingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, async, password, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *password = password_example; // Password of PDF file (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
    async:async
    password:password
    columns:columns
    url:url
    name:name
              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 = { 
  'simple': simple_example, // {String} Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'password': password_example, // {String} Password of PDF file
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var password = password_example;  // String | Password of PDF file (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
            {
                JobSingleResponseModel result = apiInstance.pdfConvertToHtmlGet(simple, async, password, 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.
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$password = password_example; // String | Password of PDF file
$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, $async, $password, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $password = password_example; # String | Password of PDF file
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, async => $async, password => $password, 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)
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
password = password_example # String | Password of PDF file (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.pdf_convert_to_html_get(simple=simple, async=async, password=password, 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
String
Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
password
String
Password of PDF file
columns
String
Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
url
String
URL of the source PDF file.
name
String
File name for generated result.

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=&async=&password=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobSingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, async, password, 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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobSingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, async, password, 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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *password = password_example; // Password of PDF file (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
    async:async
    password:password
    columns:columns
    url:url
    name:name
              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 = { 
  'simple': simple_example, // {String} Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
  'async': async_example, // {String} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'password': password_example, // {String} Password of PDF file
  '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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var password = password_example;  // String | Password of PDF file (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
            {
                JobSingleResponseModel result = apiInstance.pdfConvertToHtmlPost(simple, async, password, 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.
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$password = password_example; // String | Password of PDF file
$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, $async, $password, $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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $password = password_example; # String | Password of PDF file
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, async => $async, password => $password, 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)
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
password = password_example # String | Password of PDF file (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.pdf_convert_to_html_post(simple=simple, async=async, password=password, 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
String
Set 'true' to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design.
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
password
String
Password of PDF file
columns
String
Set 'true' if the PDF document is arranged in columns like a newspaper. Default is 'false'.
url
String
URL of the source PDF file.
name
String
File name for generated result.

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?async=&password=&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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobMultiResponseModel result = apiInstance.pdfConvertToJpgGet(async, password, url, pages, name);
            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 async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
        String password = password_example; // String | Password of PDF file
        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 {
            JobMultiResponseModel result = apiInstance.pdfConvertToJpgGet(async, password, url, pages, name);
            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 *async = async_example; // Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
String *password = password_example; // Password of PDF file (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 pdfConvertToJpgGetWith:async
    password:password
    url:url
    pages:pages
    name:name
              completionHandler: ^(JobMultiResponseModel 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} Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
  'password': password_example, // {String} Password of PDF file
  '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.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 async = async_example;  // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional) 
            var password = password_example;  // String | Password of PDF file (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
            {
                JobMultiResponseModel result = apiInstance.pdfConvertToJpgGet(async, password, url, pages, name);
                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();
$async = async_example; // String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
$password = password_example; // String | Password of PDF file
$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->pdfConvertToJpgGet($async, $password, $url, $pages, $name);
    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 $async = async_example; # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
my $password = password_example; # String | Password of PDF file
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->pdfConvertToJpgGet(async => $async, password => $password, url => $url, pages => $pages, name => $name);
    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()
async = async_example # String | Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished) (optional)
password = password_example # String | Password of PDF file (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.pdf_convert_to_jpg_get(async=async, password=password, url=url, pages=pages, name=name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DefaultApi->pdfConvertToJpgGet: %s\n" % e)

Parameters

Query parameters
Name Description
async
String
Run processing asynchronously. Returns JobId that you may use with /job/check to check state of the processing (possible states: InProgress, Failed, Aborted and Finished)
password
String
Password of PDF file
url
String
URL of the source PDF file.
pages
String
Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
name
String
File name for generated result.

Responses

Status: 200 - 200 response

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