FileVerbs API Documentation - Job Request Overview

Job Request API Overview

Overview

FileVerbs offers two integration methods: asynchronous file conversion through jobs and instant API conversion. This guide covers the asynchronous process, ideal for large-scale or delayed conversions.

Asynchronous File Conversion

Asynchronous file conversion lets you submit jobs that are processed in the background. This process is scalable and works best for handling multiple or large files, which don't need immediate results.

  1. File Upload: Upload files using the File Upload API and receive a fileId.
  2. Job Request: Create a job request, specifying the conversion type (e.g., PDF to DOCX) and referencing the fileId.

Job Conversion Process

1. File Upload API

Upload your input files using the File Upload API. Once uploaded, you'll receive a fileId for each file, which is later used in the job request.

2. Create a Job Request (JobRequest API)

Submit a job request using the JobRequest API, specifying the fileId from the upload step. Define the action, such as converting PDF to DOCX or adding a watermark.

3. Track Job Status

Track the job's progress using the job status endpoint. You'll receive updates like In Progress, Completed, or Failed.

4. Download the Converted Files

Once the job is completed, download the output file. FileVerbs dynamically determines the file's content type based on its extension, ensuring the appropriate MIME type is applied.

Key Features

  • Scalable: Handles multiple job requests simultaneously using a cloud-based queue system.
  • Customizable: Tailor job settings such as output format, watermarks, and more.
  • Secure: Files are processed securely, with support for encryption and data integrity.
  • Trackable: Monitor the status of your job in real-time using the Job Status API.