ToolsGit Backend API Documentation

Overview

The ToolsGit Backend API provides professional PDF compression and document processing services. This is a RESTful API using standard HTTP methods and status codes, designed for seamless integration into your applications.

Server

https://api.toolsgit.com

Authentication Required

API Token authentication

Bearer Token: YOUR_API_TOKEN

Authentication

The API uses tokens for authentication. All requests require a valid bearer token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

API tokens can be created and managed from your account dashboard. Each token can have specific permissions and expiration times for enhanced security.

Rate Limiting

The API implements rate limiting to ensure fair usage. When limits are exceeded, the API returns a 429 Too Many Requests response. Repeated violations may result in temporary IP blocking.

Parameters

All requests must have application/json content type. POST, PUT, and PATCH methods may include a JSON object in the request body. File uploads use multipart/form-data content type.

Health Check

Check API health and status. Returns basic health information about the API.

curl -X GET https://api.toolsgit.com/v1/health \
  -H "Content-Type: application/json"
                    

const fetch = require('node-fetch');

const response = await fetch('https://api.toolsgit.com/v1/health', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
                    

import requests

response = requests.get('https://api.toolsgit.com/v1/health', 
  headers={'Content-Type': 'application/json'})

data = response.json()
print(data)
                    

Test API Endpoint

200 500

Compress PDF

Compress a PDF file with advanced optimization. Accepts file upload or URL.

📊 Compression Levels

🖼️ image-preserve

Maximum image quality preservation, no image downsampling

📄 low

Minimal compression, preserves all images and quality

⚖️ medium

Balanced compression with good image preservation

🔥 high

Maximum compression while preserving images

curl -X POST https://api.toolsgit.com/v1/pdf/compress \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@document.pdf" \
  -F "compressionLevel=medium" \
  -F "quality=0.8"
                    

const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');

const form = new FormData();
form.append('file', fs.createReadStream('document.pdf'));
form.append('compressionLevel', 'medium'); // Options: low, medium, high, image-preserve
form.append('quality', '0.8');

const response = await fetch('https://api.toolsgit.com/v1/pdf/compress', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...form.getHeaders()
  },
  body: form
});

const data = await response.json();
console.log(data);
                    

import requests

files = {'file': open('document.pdf', 'rb')}
data = {
    'compressionLevel': 'medium',  # Options: low, medium, high, image-preserve
    'quality': '0.8'
}

response = requests.post(
    'https://api.toolsgit.com/v1/pdf/compress',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'},
    files=files,
    data=data
)

data = response.json()
print(data)
                    

const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');

const form = new FormData();
form.append('file', fs.createReadStream('document.pdf'));
form.append('compressionLevel', 'medium'); // Options: low, medium, high, image-preserve
form.append('quality', '0.8');

const response = await fetch('https://api.toolsgit.com/v1/pdf/compress', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...form.getHeaders()
  },
  body: form
});

const data = await response.json();
console.log(data);
                    

import requests

files = {'file': open('document.pdf', 'rb')}
data = {
    'compressionLevel': 'medium',  # Options: low, medium, high, image-preserve
    'quality': '0.8'
}

response = requests.post(
    'https://api.toolsgit.com/v1/pdf/compress',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'},
    files=files,
    data=data
)

data = response.json()
print(data)
                    

Test API Endpoint

200 400 401 500

Convert Word to PDF

Convert Word documents (DOC, DOCX) to PDF format with high quality output.

curl -X POST https://api.toolsgit.com/v1/document/convert \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@document.docx"
                    

const fetch = require('node-fetch');
const FormData = require('form-data');
const fs = require('fs');

const form = new FormData();
form.append('file', fs.createReadStream('document.docx'));

const response = await fetch('https://api.toolsgit.com/v1/document/convert', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    ...form.getHeaders()
  },
  body: form
});

const data = await response.json();
console.log(data);
                    

import requests

files = {'file': open('document.docx', 'rb')}

response = requests.post(
    'https://api.toolsgit.com/v1/document/convert',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'},
    files=files
)

data = response.json()
print(data)
                    

Test API Endpoint

200 400 401 500

Convert Word to PDF from URL

Convert Word documents to PDF from a URL. Supports DOC and DOCX files.

curl -X POST https://api.toolsgit.com/v1/document/convert-url \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"fileUrl": "https://example.com/document.docx"}'
                    

const fetch = require('node-fetch');

const response = await fetch('https://api.toolsgit.com/v1/document/convert-url', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    fileUrl: 'https://example.com/document.docx'
  })
});

const data = await response.json();
console.log(data);
                    

import requests

response = requests.post(
    'https://api.toolsgit.com/v1/document/convert-url',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'},
    json={'fileUrl': 'https://example.com/document.docx'}
)

data = response.json()
print(data)
                    

Test API Endpoint

200 400 401 500

Download Converted Document

Download a converted PDF document using the download URL from the conversion response.

curl -X GET https://api.toolsgit.com/v1/document/download/filename.pdf \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -o downloaded-file.pdf
                    

const fetch = require('node-fetch');
const fs = require('fs');

const response = await fetch('https://api.toolsgit.com/v1/document/download/filename.pdf', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN'
  }
});

const buffer = await response.buffer();
fs.writeFileSync('downloaded-file.pdf', buffer);
                    

import requests

response = requests.get(
    'https://api.toolsgit.com/v1/document/download/filename.pdf',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'}
)

with open('downloaded-file.pdf', 'wb') as f:
    f.write(response.content)
                    

Test API Endpoint

200 401 404 500

Document Conversion Statistics

Get statistics about document conversions and supported formats.

curl -X GET https://api.toolsgit.com/v1/document/stats \
  -H "Authorization: Bearer YOUR_API_TOKEN"
                    

const fetch = require('node-fetch');

const response = await fetch('https://api.toolsgit.com/v1/document/stats', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_TOKEN'
  }
});

const data = await response.json();
console.log(data);
                    

import requests

response = requests.get(
    'https://api.toolsgit.com/v1/document/stats',
    headers={'Authorization': 'Bearer YOUR_API_TOKEN'}
)

data = response.json()
print(data)
                    

Test API Endpoint

200 401 500

Support

Need help integrating our API? Contact our support team for assistance.

📧 Email Support

support@toolsgit.com

🌐 Website

toolsgit.com

📞 Contact

+1 (234) 567-890