Skip to content

README.md

Latest commit

 

History

History
98 lines (82 loc) · 2.25 KB

README.md

File metadata and controls

98 lines (82 loc) · 2.25 KB

File2Link API Documentation

Base URL: https://file2link-ol4p.onrender.com

Endpoints

Upload File

Upload a file to Internet Archive and get its access URL.

URL: /upload
Method: POST
Content-Type: multipart/form-data

Request Parameters

Parameter Type Description
file File The file to upload (supports various file types)

Success Response

Code: 200 OK
Content Example:

{
    "success": true,
    "access_url": "https://archive.org/download/shop_proj/550e8400-e29b-41d4-a716-446655440000.jpg",
    "item_id": "shop_proj",
    "original_filename": "example.jpg",
    "unique_filename": "550e8400-e29b-41d4-a716-446655440000.jpg",
    "metadata": {
        "title": "Shop Project File - example.jpg",
        "mediatype": "data",
        "collection": "opensource",
        "description": "Original filename: example.jpg",
        "creator": "Shop Project Uploader",
        "date": "2024-03-14",
        "licenseurl": "https://creativecommons.org/licenses/by/4.0/",
        "subject": ["shop", "project", "files"],
        "original_filename": "example.jpg"
    }
}

Error Response

Code: 400 Bad Request
Content Example:

{
    "error": "No file part"
}

Code: 500 Internal Server Error
Content Example:

{
    "error": "Upload failed"
}

Rate Limiting

The API implements rate limiting to prevent abuse. Please contact the administrator for rate limit information.

Authentication

Currently, no authentication is required to use the API.

Examples

cURL

curl -X POST \
  https://file2link-ol4p.onrender.com/upload \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@/path/to/file.jpg'

Python

import requests

url = "https://file2link-ol4p.onrender.com/upload"
files = {'file': open('file.jpg', 'rb')}
response = requests.post(url, files=files)
print(response.json())

JavaScript

const formData = new FormData();
formData.append('file', fileInput.files[0]);

fetch('https://file2link-ol4p.onrender.com/upload', {
    method: 'POST',
    body: formData
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));