TypeScript SDK Integration
Build custom file processing applications with our official TypeScript SDK. Integrate renamed.to's AI-powered file naming capabilities directly into your applications, workflows, and systems.
Frequently Asked Questions
- Is there a free tier for development?
- Yes. You can start on the free plan which includes a monthly allowance of processed documents suitable for development and small tests.
- Does the SDK handle retries and idempotency?
- Yes. The SDK implements automatic retries for transient errors and supports idempotency keys for safe replays.
- Can I use the SDK in serverless and edge runtimes?
- Yes. The SDK targets standard fetch APIs and works in most Node-based serverless/edge environments that allow outgoing HTTP requests.
Before You Connect
- Node.js 18+ and TypeScript 5+
- renamed.to API key
- Network egress from your runtime to api.renamed.to
How It Works
Install the official SDK and authenticate with your API key
Send file buffers/streams to the SDK and receive structured results with the final filename
Use polling or background jobs for long-running batches in serverless environments
Before → After
uploads/IMG_0001.pdf
processed/2025-10-15_invoice_acme-corp_inv-1001.pdf
Programmatic rename using the SDK with the Auto template.
contracts/Contract_final_v7.pdf
contracts/2025-10-01_msa_acme-corp_signed.pdf
Contract identified and normalized via a custom instruction.
Why Teams Choose TypeScript SDK
- Full TypeScript support with type safety
- Comprehensive API coverage
- Easy integration with existing codebases
- Built-in error handling and retries
- Extensive documentation and examples
- Active community support
Who Uses It
Common Use Cases
Custom File Processing Applications
Build specialized file processing tools for your organization
Custom app → Integrate renamed.to SDK → Process files with domain-specific logic
Enterprise Integration Development
Create enterprise-grade integrations with existing systems
ERP system → SDK integration → Automated document processing and naming
Developer Tooling
Build developer tools that leverage AI file naming
CLI tool → SDK integration → Batch file processing with custom naming rules
Setup Guide
Follow these steps to get started in minutes
Install SDK Package
Add the renamed.to SDK to your TypeScript project
npm install @renamed.to/sdk
# or
yarn add @renamed.to/sdk
# or
pnpm add @renamed.to/sdkInitialize Client
Set up authentication and client configuration
import { RenamedToClient } from '@renamed.to/sdk';
const client = new RenamedToClient({
apiKey: process.env.RENAMED_TO_API_KEY,
baseUrl: 'https://api.renamed.to'
});Implement File Processing
Use the SDK to process files with AI naming
const result = await client.files.process({
file: fileBuffer,
template: 'invoice',
options: {
confidence: 0.95,
extractMetadata: true
}
});
console.log('Renamed file:', result.renamedName);Handle Results
Process the renamed files and metadata in your application
Ready to go!
You're all set. Your files will now be automatically renamed and organized.
Related Integrations
Ready to Automate with TypeScript SDK?
Set up in minutes. Start organizing files automatically.