REST API Integration
Call renamed.to from your workflows and services. Send files or URLs, receive structured filenames, and orchestrate automated document organization with our REST endpoints.
Frequently Asked Questions
- What file formats are supported?
- PDF, PNG, JPG, TIFF, DOCX, XLSX, and other common formats. OCR runs automatically for scanned documents.
- How fast is the API?
- Most single-page documents finish in under 10 seconds.
- Do you support sandbox environments?
- Yes. You receive separate test and production API keys so you can validate workflows without touching live data.
- Can I enforce idempotency?
- Yes. Set the Idempotency-Key header when creating jobs to make retries safe.
Before You Connect
- renamed.to account with API access
- Server or workflow capable of making outbound HTTPS requests
- Secure storage for API credentials
How It Works
Authenticate with bearer token using your API key
Send files or URLs to the /v1/files endpoint with the desired template
Receive renamed filenames and metadata in the JSON response
Why Teams Choose REST API
- Simple REST endpoints for file processing
- Idempotency keys for safe retries
- Supports files, URLs, and base64 payloads
- Template management and confidence scoring via API
- Structured metadata in every response
Who Uses It
Common Use Cases
Automate ingestion pipelines
Rename uploads from customer portals or SFTP before they reach your back-office systems
Portal upload → REST API → Clean filename + metadata → ERP ingestion
Embed AI renaming in internal tools
Trigger renamed.to from internal line-of-business apps to keep documents consistent
ServiceNow form → REST call → Renamed PDF pushed to OneDrive
Serverless workflows
Trigger renamed.to from AWS Lambda, Google Cloud Functions, or Edge Workers.
AWS Lambda → POST /v1/files → Receive renamed filename and metadata in response
Setup Guide
Follow these steps to get started in minutes
Create API key
Generate a secret key from the renamed.to dashboard with the required scopes.
POST a file to /v1/files
Send multipart/form-data or JSON payloads with a file URL or base64 content.
curl -X POST https://api.renamed.to/v1/files -H "Authorization: Bearer $RENAMED_TO_API_KEY" -F "file=@invoice.pdf" -F "template=auto"Handle the response
Receive the renamed filename, confidence score, and extracted metadata in the response body.
{
"id": "file_01HZ...",
"status": "completed",
"renamedName": "2025-10-18_invoice_acme_inv-1045.pdf",
"confidence": 0.97,
"metadata": {
"vendor": "Acme Corp",
"invoiceNumber": "INV-1045",
"dueDate": "2025-11-01"
}
}Ready to go!
You're all set. Your files will now be automatically renamed and organized.
Related Integrations
Ready to Automate with REST API?
Set up in minutes. Start organizing files automatically.
Continue exploring
Discover related integrations, use cases, and documentation