Auto-rotate Pages with AI

`POST /v1/pdf/edit/rotate/auto`

Attributes

Attributes are case-sensitive and should be inside JSON for POST request. for example: { "url": "https://example.com/file1.pdf" }

Attribute	Type	Required	Default	Description
`url`	string	Yes	-	URL to the source file `url` attribute
`callback`	string	No	-	The callback URL (or Webhook) used to receive the POST data. see Webhooks & Callbacks. This is only applicable when `async` is set to `true`.
`lang`	string	No	eng	Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. see Language Support. You can also use 2 languages simultaneously like this: `eng+deu` (any combination).
`httpusername`	string	No	-	HTTP auth user name if required to access source URL.
`httppassword`	string	No	-	HTTP auth password if required to access source URL.
`async`	boolean	No	`false`	Set `async` to `true` for long processes to run in the background, API will then return a `jobId` which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks
`profiles`	object	No	-	See Profiles for more information.
`outputDataFormat`	string	No	-	If you require your output as `base64` format, set this to `base64`
`DataEncryptionAlgorithm`	string	No	-	Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: `AES128`, `AES192`, `AES256`.
`DataEncryptionKey`	string	No	-	Controls the encryption key used for data encryption. See User-Controlled Encryption for more information.
`DataEncryptionIV`	string	No	-	Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information.
`DataDecryptionAlgorithm`	string	No	-	Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: `AES128`, `AES192`, `AES256`.
`DataDecryptionKey`	string	No	-	Controls the decryption key used for data decryption. See User-Controlled Encryption for more information.
`DataDecryptionIV`	string	No	-	Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information.

Query parameters

No query parameters accepted.

Responses

Parameter	Type	Description
`url`	string	Direct URL to the final PDF file stored in S3.
`fileSize`	integer	Size of the optimized PDF file in bytes
`outputLinkValidTill`	string	Timestamp indicating when the output link will expire
`pageCount`	integer	Number of pages in the PDF document.
`error`	boolean	Indicates whether an error occurred (`false` means success)
`status`	string	Status code of the request (200, 404, 500, etc.). For more information, see Response Codes.
`name`	string	Name of the output file
`credits`	integer	Number of credits consumed by the request
`remainingCredits`	integer	Number of credits remaining in the account
`duration`	integer	Time taken for the operation in milliseconds

`Example` Payload

To see the request size limits, please refer to the Request Size Limits.

{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-fix-rotation/rotated_pages.pdf",
  "name": "result.pdf"
}

`Example` Response

To see the main response codes, please refer to the Response Codes page.

{
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/HQ86WA7MFED1Q7C843NDSKVRW5AFVTMP/result.pdf?X-Amz-Expires=3600&X-Amz-Security-Token=FwoGZXIvYXdzEFwaDD6ndEhlfId4KouQ8yKCASr8amowIV2tLAi%2BhjnlVi%2FNYjf8ZJ3MqgKWsYVm5dQ8fQx7hceGdmtqhB6OH8t9xdacbMEcoMIpQr1BcSSfu2ZFfGFBDaHNpaSTfPXhkNnQaZFOi5KFozZiPBP9xPoSCV%2Fj%2BLIrDsOF%2Fb89i1Nd4OJFoXnfhjf03ZHJ%2BNCQEC%2BbePsovsjNlQYyKIV1qb1wGdwgJ%2ByibJ5x%2BQGoG4x2ebnEGTQkKBf4zobYT9Uv6FVQ%2FJg%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA4NRRSZPHB3D5EZ56/20220623/us-west-2/s3/aws4_request&X-Amz-Date=20220623T141005Z&X-Amz-SignedHeaders=host&X-Amz-Signature=351ad45980cad0d3f634f7b784d5445b9c4e1ad2244912f56ea065209d73bb30",
  "fileSize": 455115,
  "pageCount": 3,
  "error": false,
  "status": 200,
  "name": "result.pdf",
  "credits": 84,
  "duration": 6002,
  "remainingCredits": 98194629
}

Code Samples

curl --location --request POST 'https://api.pdf.co/v1/pdf/edit/rotate/auto' \
--header 'x-api-key: *******************' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-fix-rotation/rotated_pages.pdf",
"name": "result.pdf"
}'

curl --location --request POST 'https://api.pdf.co/v1/pdf/edit/rotate/auto' \
--header 'x-api-key: *******************' \
--header 'Content-Type: application/json' \
--data-raw '{
"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-fix-rotation/rotated_pages.pdf",
"name": "result.pdf"
}'

var https = require("https");
var path = require("path");
var fs = require("fs");

// The authentication key (API Key).
// Get your own by registering at https://app.pdf.co
const API_KEY = "***********************************";


// Direct URL of source PDF file.
// You can also upload your own file into PDF.co and use it as url. Check "Upload File" samples for code snippets: https://github.com/bytescout/pdf-co-api-samples/tree/master/File%20Upload/
const SourceFileUrl = "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-fix-rotation/rotated_pages.pdf";

// Destination PDF file name
const DestinationFile = "./result.pdf";


// Prepare request to `Rotate PDF` API endpoint
var queryPath = `/v1/pdf/edit/rotate/auto`;

// JSON payload for api request
var jsonPayload = JSON.stringify({
  url: SourceFileUrl, name: path.basename(DestinationFile), angle: Angle, pages: Pages 
});

var reqOptions = {
  host: "api.pdf.co",
  method: "POST",
  path: queryPath,
  headers: {
      "x-api-key": API_KEY,
      "Content-Type": "application/json",
      "Content-Length": Buffer.byteLength(jsonPayload, 'utf8')
  }
};
// Send request
var postRequest = https.request(reqOptions, (response) => {
  response.on("data", (d) => {
      // Parse JSON response
      var data = JSON.parse(d);
      if (data.error == false) {
          // Download PDF file
          var file = fs.createWriteStream(DestinationFile);
          https.get(data.url, (response2) => {
              response2.pipe(file)
                  .on("close", () => {
                      console.log(`Generated PDF file saved as "${DestinationFile}" file.`);
                  });
          });
      }
      else {
          // Service reported error
          console.log(data.message);
      }
  });
}).on("error", (e) => {
  // Request error
  console.log(e);
});

// Write request data
postRequest.write(jsonPayload);
postRequest.end();

import os
import requests # pip install requests

# The authentication key (API Key).
# Get your own by registering at https://app.pdf.co
API_KEY = "******************************************"

# Base URL for PDF.co Web API requests
BASE_URL = "https://api.pdf.co/v1"

# Direct URL of source PDF file.
# You can also upload your own file into PDF.co and use it as url. Check "Upload File" samples for code snippets: https://github.com/bytescout/pdf-co-api-samples/tree/master/File%20Upload/
SourceFileURL = "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-fix-rotation/rotated_pages.pdf"

# Destination PDF file name
DestinationFile = ".\\result.pdf"

def main(args = None):
  rotatePDF(SourceFileURL, DestinationFile)


def rotatePDF(uploadedFileUrl, destinationFile):
  """Auto Rotate PDF using PDF.co Web API"""

  # Prepare requests params as JSON
  # See documentation: https://developer.pdf.co/
  parameters = {}
  parameters["url"] = uploadedFileUrl
  parameters["name"] = os.path.basename(destinationFile)

  # Prepare URL for 'Auto Rotate PDF' API request
  url = "{}/pdf/edit/rotate/auto".format(BASE_URL)

  # Execute request and get response as JSON
  response = requests.post(url, data=parameters, headers={ "x-api-key": API_KEY })
  if (response.status_code == 200):
      json = response.json()

      if json["error"] == False:
          #  Get URL of result file
          resultFileUrl = json["url"]            
          # Download result file
          r = requests.get(resultFileUrl, stream=True)
          if (r.status_code == 200):
              with open(destinationFile, 'wb') as file:
                  for chunk in r:
                      file.write(chunk)
              print(f"Result file saved as \"{destinationFile}\" file.")
          else:
              print(f"Request error: {response.status_code} {response.reason}")
      else:
          # Show service reported error
          print(json["message"])
  else:
      print(f"Request error: {response.status_code} {response.reason}")

if __name__ == '__main__':
  main()

using System;
using System.Collections.Generic;
using System.IO;
using System.Net;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace PDFcoApiExample
{
class Program
{
  // The authentication key (API Key).
  // Get your own by registering at https://app.pdf.co
  const String API_KEY = "*********************************";
  
  // Direct URL of source PDF file.
      // You can also upload your own file into PDF.co and use it as url. Check "Upload File" samples for code snippets: https://github.com/bytescout/pdf-co-api-samples/tree/master/File%20Upload/
  const string SourceFileUrl = "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-fix-rotation/rotated_pages.pdf";

  // Destination PDF file name
  const string DestinationFile = @".\result.pdf";

  static void Main(string[] args)
  {
    // Create standard .NET web client instance
    WebClient webClient = new WebClient();

    // Set API Key
    webClient.Headers.Add("x-api-key", API_KEY);

    // URL for `Auto Rotate PDF` API call
    string url = "https://api.pdf.co/v1/pdf/edit/rotate/auto";

    // Prepare requests params as JSON
    Dictionary<string, object> parameters = new Dictionary<string, object>();
    parameters.Add("url", SourceFileUrl);
    parameters.Add("name", Path.GetFileName(DestinationFile));

    // Convert dictionary of params to JSON
    string jsonPayload = JsonConvert.SerializeObject(parameters);

    try
    {
      // Execute POST request with JSON payload
      string response = webClient.UploadString(url, jsonPayload);

      // Parse JSON response
      JObject json = JObject.Parse(response);

      if (json["error"].ToObject<bool>() == false)
      {
        // Get URL of generated PDF file
        string resultFileUrl = json["url"].ToString();

        // Download PDF file
        webClient.DownloadFile(resultFileUrl, DestinationFile);

        Console.WriteLine("Generated PDF file saved as \"{0}\" file.", DestinationFile);
      }
      else
      {
        Console.WriteLine(json["message"].ToString());
      }
    }
    catch (WebException e)
    {
      Console.WriteLine(e.ToString());
    }

    webClient.Dispose();

    Console.WriteLine();
    Console.WriteLine("Press any key...");
    Console.ReadKey();
  }
}
}

package com.company;

import com.google.gson.JsonObject;
import com.google.gson.JsonParser;
import okhttp3.*;

import java.io.*;
import java.net.*;
import java.nio.file.Path;
import java.nio.file.Paths;

public class Main
{
  // The authentication key (API Key).
  // Get your own by registering at https://app.pdf.co
  final static String API_KEY = "***********************************";

  // Direct URL of source PDF file.
  // You can also upload your own file into PDF.co and use it as url. Check "Upload File" samples for code snippets: https://github.com/bytescout/pdf-co-api-samples/tree/master/File%20Upload/    
  final static String SourceFileUrl = "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-fix-rotation/rotated_pages.pdf";

  // Destination PDF file name
  final static Path DestinationFile = Paths.get(".\\result.pdf");


  public static void main(String[] args) throws IOException
  {
      // Create HTTP client instance
      OkHttpClient webClient = new OkHttpClient();

      // Prepare URL for `Rotate PDF` API call
      String query = "https://api.pdf.co/v1/pdf/edit/rotate/auto";

      // Make correctly escaped (encoded) URL
      URL url = null;
      try
      {
          url = new URI(null, query, null).toURL();
      }
      catch (URISyntaxException e)
      {
          e.printStackTrace();
      }

      // Create JSON payload
  String jsonPayload = String.format("{\"url\": \"%s\", \"name\": \"%s\"}",
              SourceFileUrl,
              DestinationFile.getFileName());

      // Prepare request body
      RequestBody body = RequestBody.create(MediaType.parse("application/json"), jsonPayload);
      
      // Prepare request
      Request request = new Request.Builder()
          .url(url)
          .addHeader("x-api-key", API_KEY) // (!) Set API Key
          .addHeader("Content-Type", "application/json")
          .post(body)
          .build();
      
      // Execute request
      Response response = webClient.newCall(request).execute();
      

      if (response.code() == 200)
      {
          // Parse JSON response
          JsonObject json = new JsonParser().parse(response.body().string()).getAsJsonObject();

          boolean error = json.get("error").getAsBoolean();
          if (!error)
          {
              // Get URL of generated PDF file
              String resultFileUrl = json.get("url").getAsString();

              // Download PDF file
              downloadFile(webClient, resultFileUrl, DestinationFile.toFile());

              System.out.printf("Generated PDF file saved as \"%s\" file.", DestinationFile.toString());
          }
          else
          {
              // Display service reported error
              System.out.println(json.get("message").getAsString());
          }
      }
      else
      {
          // Display request error
          System.out.println(response.code() + " " + response.message());
      }
  }

  public static void downloadFile(OkHttpClient webClient, String url, File destinationFile) throws IOException
  {
      // Prepare request
      Request request = new Request.Builder()
              .url(url)
              .build();
      // Execute request
      Response response = webClient.newCall(request).execute();

      byte[] fileBytes = response.body().bytes();

      // Save downloaded bytes to file
      OutputStream output = new FileOutputStream(destinationFile);
      output.write(fileBytes);
      output.flush();
      output.close();

      response.close();
  }
}

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Cloud API asynchronous "Optimize PDF" job example (allows to avoid timeout errors).</title>
</head>
<body>

<?php

// Cloud API asynchronous "Optimize PDF" job example.
// Allows to avoid timeout errors when processing huge or scanned PDF documents.


// The authentication key (API Key).
// Get your own by registering at https://app.pdf.co
$apiKey = "***********************************";

// Direct URL of source PDF file. Check another example if you need to upload a local file to the cloud.
// You can also upload your own file into PDF.co and use it as url. Check "Upload File" samples for code snippets: https://github.com/bytescout/pdf-co-api-samples/tree/master/File%20Upload/
$sourceFileUrl = "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-fix-rotation/rotated_pages.pdf";

// Prepare URL for `Rotate PDF` API call
$url = "https://api.pdf.co/v1/pdf/edit/rotate/auto";

// Prepare requests params
$parameters = array();
$parameters["url"] = $sourceFileUrl;
$parameters["async"] = true; // (!) Make asynchronous job

// Create Json payload
$data = json_encode($parameters);

// Create request
$curl = curl_init();
curl_setopt($curl, CURLOPT_HTTPHEADER, array("x-api-key: " . $apiKey, "Content-type: application/json"));
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

// Execute request
$result = curl_exec($curl);

if (curl_errno($curl) == 0)
{
  $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
  
  if ($status_code == 200)
  {
      $json = json_decode($result, true);
      
      if (!isset($json["error"]) || $json["error"] == false)
      {
          // URL of generated PDF file that will available after the job completion
          $resultFileUrl = $json["url"];
          // Asynchronous job ID
          $jobId = $json["jobId"];
          
          // Check the job status in a loop
          do
          {
              $status = CheckJobStatus($jobId, $apiKey); // Possible statuses: "working", "failed", "aborted", "success".
              
              // Display timestamp and status (for demo purposes)
              echo "<p>" . date(DATE_RFC2822) . ": " . $status . "</p>";
              
              if ($status == "success")
              {
                  // Display link to the file with conversion results
                  echo "<div><h2>Conversion Result:</h2><a href='" . $resultFileUrl . "' target='_blank'>" . $resultFileUrl . "</a></div>";
                  break;
              }
              else if ($status == "working")
              {
                  // Pause for a few seconds
                  sleep(3);
              }
              else 
              {
                  echo $status . "<br/>";
                  break;
              }
          }
          while (true);
      }
      else
      {
          // Display service reported error
          echo "<p>Error: " . $json["message"] . "</p>"; 
      }
  }
  else
  {
      // Display request error
      echo "<p>Status code: " . $status_code . "</p>"; 
      echo "<p>" . $result . "</p>"; 
  }
}
else
{
  // Display CURL error
  echo "Error: " . curl_error($curl);
}

// Cleanup
curl_close($curl);


function CheckJobStatus($jobId, $apiKey)
{
  $status = null;
  
// Create URL
  $url = "https://api.pdf.co/v1/job/check";
  
  // Prepare requests params
  $parameters = array();
  $parameters["jobid"] = $jobId;

  // Create Json payload
  $data = json_encode($parameters);

  // Create request
  $curl = curl_init();
  curl_setopt($curl, CURLOPT_HTTPHEADER, array("x-api-key: " . $apiKey, "Content-type: application/json"));
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_POST, true);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
  curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
  
  // Execute request
  $result = curl_exec($curl);
  
  if (curl_errno($curl) == 0)
  {
      $status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
      
      if ($status_code == 200)
      {
          $json = json_decode($result, true);
      
          if (!isset($json["error"]) || $json["error"] == false)
          {
              $status = $json["status"];
          }
          else
          {
              // Display service reported error
              echo "<p>Error: " . $json["message"] . "</p>"; 
          }
      }
      else
      {
          // Display request error
          echo "<p>Status code: " . $status_code . "</p>"; 
          echo "<p>" . $result . "</p>"; 
      }
  }
  else
  {
      // Display CURL error
      echo "Error: " . curl_error($curl);
  }
  
  // Cleanup
  curl_close($curl);
  
  return $status;
}

?>

</body>
</html>

Welcome

Extraction

Editing

PDF Conversion

Excel Conversion

PDF Merging & Splitting

Forms

Find & Search

Document, File & System

Pages

Barcodes

Glossary

`POST /v1/pdf/edit/rotate/auto`

Attributes

Query parameters

Responses

`Example` Payload

`Example` Response

Code Samples

Welcome

Extraction

Editing

PDF Conversion

Excel Conversion

PDF Merging & Splitting

Forms

Find & Search

Document, File & System

Pages

Barcodes

Glossary

​POST /v1/pdf/edit/rotate/auto

​Attributes

​Query parameters

​Responses

​Example Payload

​Example Response

​Code Samples

`POST /v1/pdf/edit/rotate/auto`

Attributes

Query parameters

Responses

`Example` Payload

`Example` Response

Code Samples