README

renamed.to SDK

Official SDKs for AI-powered file renaming, PDF splitting, and data extraction

Quick Start • Installation • Features • API • Docs

🚀 Quick Start

Get your API key at renamed.to/settings.

TypeScript

Python

import { RenamedClient } from '@renamed/sdk';

const client = new RenamedClient({
  apiKey: 'rt_...'
});

const result = await client.rename('invoice.pdf');
console.log(result.suggestedFilename);
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

from renamed import RenamedClient

client = RenamedClient(api_key='rt_...')

result = client.rename('invoice.pdf')
print(result.suggested_filename)
# → "2025-01-15_AcmeCorp_INV-12345.pdf"

More languages

Go

import "github.com/renamed-to/renamed-sdk/sdks/go/renamed"

client := renamed.NewClient("rt_...")

result, _ := client.Rename(ctx, "invoice.pdf", nil)
fmt.Println(result.SuggestedFilename)
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

Java

import to.renamed.sdk.*;

RenamedClient client = new RenamedClient("rt_...");

RenameResult result = client.rename(Path.of("invoice.pdf"), null);
System.out.println(result.getSuggestedFilename());
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

C#

using Renamed.Sdk;

using var client = new RenamedClient("rt_...");

var result = await client.RenameAsync("invoice.pdf");
Console.WriteLine(result.SuggestedFilename);
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

Ruby

require 'renamed'

client = Renamed::Client.new(api_key: 'rt_...')

result = client.rename('invoice.pdf')
puts result.suggested_filename
# → "2025-01-15_AcmeCorp_INV-12345.pdf"

Rust

use renamed::RenamedClient;

let client = RenamedClient::new("rt_...");

let result = client.rename("invoice.pdf", None).await?;
println!("{}", result.suggested_filename);
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

Swift

import Renamed

let client = try RenamedClient(apiKey: "rt_...")

let file = try FileInput(url: URL(fileURLWithPath: "invoice.pdf"))
let result = try await client.rename(file: file)
print(result.suggestedFilename)
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

PHP

use Renamed\Client;

$client = new Client('rt_...');

$result = $client->rename('invoice.pdf');
echo $result->suggestedFilename;
// → "2025-01-15_AcmeCorp_INV-12345.pdf"

📦 Installation

Language	Package Manager
TypeScript	npm install @renamed/sdk
Python	pip install renamed
Go	go get github.com/renamed-to/renamed-sdk/sdks/go
Java	<dependency> <groupId>to.renamed</groupId> <artifactId>renamed-sdk</artifactId> <version>0.1.0</version> </dependency>
C# / .NET	dotnet add package Renamed.Sdk
Ruby	gem install renamed
Rust	[dependencies] renamed = "0.1"
Swift	.package(url: "https://github.com/renamed-to/renamed-sdk", from: "0.1.0")
PHP	composer require renamed/sdk

✨ Features

🤖 Rename Files

AI-powered file renaming with intelligent naming suggestions:

const result = await client.rename('scan001.pdf');
// {
//   suggestedFilename: "2025-01-15_AcmeCorp_INV-12345.pdf",
//   folderPath: "2025/AcmeCorp/Invoices",
//   confidence: 0.95
// }

✂️ Split PDFs

Split multi-page PDFs into individual documents:

const job = await client.pdfSplit('multi-page.pdf', { mode: 'auto' });
const result = await job.wait();

for (const doc of result.documents) {
  const buffer = await client.downloadFile(doc.downloadUrl);
  // Save doc.filename with buffer
}

📊 Extract Data

Extract structured data from documents:

const result = await client.extract('invoice.pdf', {
  prompt: 'Extract invoice number, date, and total amount'
});
console.log(result.data);
// { invoiceNumber: "INV-12345", date: "2025-01-15", total: 1234.56 }

📖 API Reference

Method	Description
`rename(file)`	Rename a file using AI
`pdfSplit(file, options)`	Split PDF into documents
`extract(file, options)`	Extract structured data
`getUser()`	Get user profile & credits
`downloadFile(url)`	Download a split document