Migrating from API v1 to v2

Step-by-step guide to migrate your integration from API v1 to v2 before the June 2026 deadline.

Overview

Important Deadline

API v1 will be shut down on June 1, 2026. All users must migrate to v2 before this date.

API v2 is simpler, faster, and more modern than v1. This guide will help you migrate with minimal disruption.

Key Differences

Feature API v1 API v2
Workflow Session-based (5 steps) Direct (1 request)
Authentication Basic + Token Token only
Endpoints /api/v1/sessions /api/v2/convert
Credits User only User + Organization

Migration Checklist

Code Examples

Before (API v1):

<?php
// Step 1: Create session
$session = createSession();

// Step 2: Upload file
uploadFile($session['id'], 'document.pdf');

// Step 3: Set options
setOptions($session['id'], ['pdftype' => '2B']);

// Step 4: Start process
$process = startProcess($session['id']);

// Step 5: Download result
downloadResult($process['download_url']);

After (API v2):

<?php
// Single request!
$response = convert([
    'files' => ['document.pdf'],
    'options' => ['pdf_type' => '2B'],
    'async' => true
]);

// Download when ready
downloadResult($response['download_url']);

See our complete API v2 reference for all endpoints and options.