API Documentation

Welcome to the ConvertIntoMP4 API! Our REST API allows you to convert files between formats programmatically. The API uses a task-based architecture where each operation (import, convert, export) is a task that can be combined into jobs for complex workflows.

Base URL

https://api.convertintomp4.com/v1

Request Format

• All requests must include Content-Type: application/json header
• All requests must include authentication via Bearer token
• Request bodies should be valid JSON

Response Format

{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

All API requests require authentication using an API key. Include your API key in the Authorization header of every request.

Bearer Token

Include your API key as a Bearer token in the Authorization header:

curl https://api.convertintomp4.com/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Scopes

Step 1: Get Your API Key

Sign up at convertintomp4.com/signup and create an API key in your dashboard.

Step 2: Make Your First Conversion

Create a job that imports a file from URL, converts it, and exports a download link:

curl -X POST https://api.convertintomp4.com/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tasks": {
      "import-file": {
        "operation": "import/url",
        "url": "https://example.com/video.mov"
      },
      "convert-file": {
        "operation": "convert",
        "input": "import-file",
        "output_format": "mp4",
        "options": {
          "quality": "high"
        }
      },
      "export-file": {
        "operation": "export/url",
        "input": "convert-file"
      }
    }
  }'

Step 3: Check Job Status

curl https://api.convertintomp4.com/v1/jobs/job_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

Step 4: Download the Result

Once complete, the export task contains a download URL:

{
  "tasks": {
    "export-file": {
      "status": "completed",
      "result": {
        "url": "https://files.convertintomp4.com/abc123/output.mp4",
        "expires_at": "2024-01-16T10:30:00Z"
      }
    }
  }
}

Test your integration risk-free using our sandbox environment. Sandbox mode uses a separate base URL and test API key with limited quotas.

Sandbox Base URL

https://sandbox.api.convertintomp4.com/v1

Sandbox Limits

Identifying Sandbox Responses

Sandbox responses include additional headers:

X-Sandbox: true
X-Credits-Remaining: 97

Dedicated endpoints for advanced PDF processing. All PDF operations are also available as task types within jobs.

Available Operations

Example: OCR a PDF

curl -X POST https://api.convertintomp4.com/v1/pdf/ocr \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "https://example.com/scanned-doc.pdf",
    "language": "eng",
    "output_format": "pdf-searchable"
  }'

Example: Merge PDFs

{
  "files": [
    "https://example.com/part1.pdf",
    "https://example.com/part2.pdf",
    "https://example.com/part3.pdf"
  ],
  "output_filename": "merged.pdf"
}

Example: Encrypt PDF

{
  "file": "https://example.com/document.pdf",
  "password": "secure-password-123",
  "permissions": {
    "printing": true,
    "copying": false,
    "modifying": false
  }
}

Import and export files directly from your cloud storage providers. We support Amazon S3, Azure Blob Storage, Google Cloud Storage, and SFTP.

Supported Providers

Azure Blob Storage

{
  "operation": "import/azure",
  "storage_account": "myaccount",
  "container": "my-container",
  "blob": "path/to/file.mp4",
  "sas_token": "sv=2023-01-03&st=...&sig=..."
}

Google Cloud Storage

{
  "operation": "import/gcs",
  "bucket": "my-bucket",
  "project_id": "my-project-id",
  "key": "path/to/file.mp4",
  "credentials": {
    "type": "service_account",
    "project_id": "my-project-id",
    "private_key": "..."
  }
}

SFTP

{
  "operation": "import/sftp",
  "host": "sftp.example.com",
  "port": 22,
  "username": "user",
  "private_key": "-----BEGIN RSA PRIVATE KEY-----...",
  "path": "/uploads/video.mp4"
}

Crop video frames or trim audio/video to specific time ranges. Available as task operations within jobs.

Video Crop

Crop the video frame to a specific region:

{
  "operation": "crop",
  "input": "import-task",
  "options": {
    "x": 100,
    "y": 50,
    "width": 1280,
    "height": 720
  }
}

Crop Options

Audio/Video Trim

Trim media to a specific time range:

{
  "operation": "trim",
  "input": "import-task",
  "options": {
    "start_time": "00:01:30",
    "end_time": "00:05:00"
  }
}

Trim Options

Query which formats are supported for each operation. Useful for building dynamic UIs that show available conversions.

Query by Operation

GET /v1/formats/query/convert
GET /v1/formats/query/compress
GET /v1/formats/query/crop
GET /v1/formats/query/trim
GET /v1/formats/query/merge

Response

{
  "success": true,
  "data": [
    {
      "name": "mp4",
      "category": "video",
      "targets": ["mov", "avi", "mkv", "webm", "gif"]
    },
    {
      "name": "jpg",
      "category": "image",
      "targets": ["png", "webp", "gif", "bmp", "tiff"]
    }
  ]
}

Import our complete API collection into Postman for interactive testing. The collection includes all endpoints with pre-configured example requests and environment variables.

Collection Variables

We provide official SDKs for 8 programming languages plus cURL support:

npm install @convertintomp4/sdk

pip install convertintomp4

composer require convertintomp4/sdk

<!-- Maven -->
<dependency>
  <groupId>com.convertintomp4</groupId>
  <artifactId>sdk</artifactId>
  <version>1.0.0</version>
</dependency>

dotnet add package ConvertIntoMP4.SDK

gem install convertintomp4

go get github.com/convertintomp4/go-sdk

// Gradle
implementation("com.convertintomp4:sdk:1.0.0")

.package(url: "https://github.com/convertintomp4/sdk-swift.git", from: "1.0.0")

Best Practices

• Always handle errors - Wrap API calls in try/catch blocks
• Use webhooks - Avoid polling when possible
• Implement retry logic - Handle rate limits with exponential backoff
• Store API keys securely - Never commit API keys to version control