ドキュメント

Renamed.to REST API v1

1回のAPI呼び出しで、乱雑なアップロードファイルを一貫性のある読みやすいファイル名に変換します。Renamed.toはファイル自体を読み取り(スキャンにはOCR、テキストにはNLP)、適切なフィールドを抽出し、ご指定のネーミングテンプレートを適用して、毎回期待通りのファイル名を返します。Bearerトークン認証によるクリーンなJSON入出力で、数分で統合できます。

既存のファイル名ではなく、コンテンツからファイル名を生成します。

  • ファイルを読み取り(スキャンにはOCR)、実際のメタデータを抽出
  • テンプレートを自由に制御:自動、既成、または自然言語によるカスタム
  • どこでも使える安全な文字による一貫した出力
  • Bearerトークン認証によるJSON優先のREST API
  • スマートなルーティングと整理のためのオプションのフォルダパス
  • 長期的なコンテンツ保存を避けるプライバシー優先のデフォルト設定

始めましょう: 50クレジット無料 for new accounts.

ベースURL

https://www.renamed.to/api/v1

クイックスタート: APIトークンを 設定 → APIトークンで生成し、以下の例を使用して最初のリクエストを行います。

はじめに

Renamed.to REST APIを数分で使い始めましょう。以下の手順に従って最初のAPI呼び出しを行い、プログラムでPDFファイルのリネームを開始します。

1

アカウントを作成

無料アカウントに登録: renamed.to/sign-up。新規アカウントには50クレジットが無料で付与されます。

2

APIトークンを生成

設定 → APIトークンに移動し、新しいAPIトークンを作成します。トークンは作成時に一度だけ表示されます—安全に保存してください。

ヒント: 複数のトークンを管理しやすくするために、わかりやすい名前を使用してください(例:「本番サーバー」、「開発」)。

3

最初のリクエストを行う

APIトークンを使用してリクエストを認証します。サービスはPDFファイルからメタデータを自動的に抽出します。以下は最小限の例です:

注意: これらは入門用の簡略化された例です。包括的なエラーハンドリング、リトライロジック、バリデーションを含む本番コードについては、 エラーハンドリング

curl -X POST https://www.renamed.to/api/v1/rename \
  -H "Authorization: Bearer rt_your_token_here" \
  -F file=@invoice.pdf
4

レスポンスを処理

成功したレスポンスには、生成されたファイル名と抽出されたメタデータを含むフォルダパスが含まれます:

よくある問題

  • Python 415エラー: Pythonを使用している場合、ファイルアップロードにfilenameとcontent-typeが含まれていることを確認してください( Pythonファイルアップロード要件)
  • 401エラー: APIトークンが正しく、必要な権限があることを確認してください
  • ファイルサイズ: PDFファイルとスキャン画像(JPG、PNG、TIFF)の最大ファイルサイズは25MBです

次のステップ

お困りですか? ドキュメント or contact support if you run into any issues.

APIバージョニング

Renamed.to APIは、プラットフォームの進化に伴い安定性と後方互換性を確保するために、URLベースのバージョニングを使用しています。

現在のバージョン

現在のAPIバージョンはv1で、以下からアクセスできます:

https://www.renamed.to/api/v1

バージョニングポリシー

後方互換性

各メジャーバージョン内で後方互換性を維持します。新機能や互換性を損なわない変更は、インテグレーションのコード変更を必要とせずに現在のバージョンに追加されます。

破壊的変更

破壊的変更(エンドポイントの削除、レスポンス形式の変更、フィールドの削除)は新しいメジャーバージョン(例:v2)になります。新しいメジャーバージョンがリリースされた場合:

  • 前のバージョンは少なくとも12ヶ月間利用可能です
  • 移行ガイドと非推奨通知を提供します
  • 破壊的変更は少なくとも90日前に発表されます

非推奨のタイムライン

バージョンが非推奨になった場合、以下のタイムラインに従います:

  • 90日前通知:移行ガイド付きの非推奨発表
  • 12ヶ月のサポート:非推奨バージョンは引き続き機能します
  • サンセット:サポート期間終了後に非推奨バージョンは廃止されます

特定バージョンのリクエスト

APIバージョンはURLパスで指定されます。リクエストには常にバージョン番号を含めてください:

https://www.renamed.to/api/v1/rename✓ 現在のバージョン
https://www.renamed.to/api/v2/rename将来のバージョン(まだ利用できません)

バージョンヘッダー

バージョニングはURLパスで処理されますが、APIレスポンスにはヘッダーでバージョン情報が含まれます:

ヘッダー説明
API-Versionリクエストに使用されたAPIバージョンv1

最新情報を入手

API変更とバージョンアップデートについて最新情報を入手するには:

  • Changelog
  • API changelog RSSフィードを購読(近日公開)
  • レスポンスのAPI-Versionヘッダーを監視
  • ステータスページでAPIの可用性とインシデントを確認

Note: 注意:API v1は安定しており、積極的にメンテナンスされています。近い将来v1を非推奨にする予定はありません。v2がリリースされた場合、両バージョンが同時にサポートされます。

認証

すべてのリクエストはBearerトークンを使用して認証する必要があります。APIトークンは、アカウントへのフルアクセスを提供する長期有効なAPIキーです。

トークン形式

APIトークンはrt_で始まり、64文字の16進数が続きます。例:rt_abc123def456...

トークンの取得

設定のAPIトークンセクションでAPIトークンを生成します。トークンは作成時に一度だけ表示されます—安全に保存してください。

トークンの使用

AuthorizationヘッダーにBearerプレフィックスを付けてトークンを含めます:

curl -X GET https://www.renamed.to/api/v1/user \
  -H "Authorization: Bearer rt_your_token_here"

トークンの権限

APIトークンは、ファイルのリネーム、ユーザープロファイル情報、クレジット残高、チーム情報を含むすべてのAPIエンドポイントへのアクセスを提供します。

エラーレスポンス

認証に失敗すると、401 Unauthorizedレスポンスが返されます:

トークンのセキュリティ

  • トークンは安全に保存してください—バージョン管理にコミットしたり、クライアントサイドのコードで公開したりしないでください
  • 環境変数または安全なシークレット管理システムを使用してください
  • 設定 → APIトークンで新しいトークンを作成し、古いトークンを削除して、定期的にローテーションしてください
  • トークンが漏洩した場合は、設定からすぐに削除してください

APIエンドポイント