API

SigCleaner REST API ドキュメント。

\/api\/clean へのリクエストが成功するたびに、アカウントの残高から1回分の処理が消費されます。

メソッド: 背景削除

POST https://sigclean.io/api/clean
認証
Authorization: Bearer YOUR_API_KEY
リクエストパラメータ
パラメータ型必須説明
file multipart file いずれか1つ PNG、JPG、またはPDF画像。
複数ページのPDFの場合、最初のページのみが処理されます。
url string いずれか1つ 画像への直接リンク
type string いいえ json (デフォルト) — ファイルへのリンクを含むJSONを返します
webp — 透過背景のWebPバイナリファイルを返します
png — 透過背景のPNGバイナリファイルを返します
extract string いいえ 特定の要素の抽出。デフォルトは空（標準の背景削除）です。
signature — 手書きの署名のみを残し、それ以外をすべて削除します。
stamp — 印影のみを残し、それ以外をすべて削除します。
aggressive boolean いいえ 文字の強力な削除。
1 (true) に設定すると、印字されたすべての文字、数字、帳票の黒い直線を強力に削除し、指定された要素のみを残します。
mode string いいえ 処理モード。デフォルト — standard。
standard — 標準モード。画質の良い画像に適しています。元の画像に最も近い仕上がりになります。
advanced — スマートモード。より精密な処理を行います。低画質の画像や不要な要素が多い画像に適しています。
name string いいえ 「マイファイル」リストに表示されるファイル名。処理が成功すると保存されます。
レスポンス: type=json
{ "status": "ok", "uuid": "550e8400-e29b-41d4-a716-446655440000", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "remaining": 9, "limit": 10 }
レスポンス: type=webp

透過背景のWebPバイナリファイルを返します。 Content-Type: image/webp.

レスポンス: type=png

透過背景のPNGバイナリファイルを返します。 Content-Type: image/png.

cURLの例
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=json"
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ --output result.png
curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=webp" \ --output result.webp

強力な文字削除を使用した署名の抽出：

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@document.jpg" \ -F "type=png" \ -F "extract=signature" \ -F "aggressive=1" \ --output signature.png

スマート処理モード:

curl -X POST https://sigclean.io/api/clean \ -H "Authorization: Bearer YOUR_KEY" \ -F "file=@stamp.jpg" \ -F "type=png" \ -F "mode=advanced" \ --output result.png
結果をダウンロード
GET https://sigclean.io/api/file/{uuid}

メソッド: ファイル一覧

GET https://sigclean.io/api/files

現在のユーザーの正常に処理されたすべてのファイルのリストを返します。ファイルはリンクからアクセスできます。 /api/file/{uuid}.

認証
Authorization: Bearer YOUR_API_KEY
レスポンス
{ "status": "ok", "files": [ { "uuid": "550e8400-e29b-41d4-a716-446655440000", "name": "stamp.jpg", "url": "https://sigclean.io/api/file/550e8400-e29b-41d4-a716-446655440000", "created_at": "2026-07-01T10:00:00Z", "expires_at": "2027-07-01T10:00:00Z" } ] }
フィールド型説明
uuid string ファイルの一意の識別子
name string | null 表示されるファイル名 (\/api\/clean の name パラメータ、または名前変更後)
url string ファイルダウンロード用の直接リンク (WebP)
created_at string (ISO 8601) ファイルの作成日時 (UTC)
expires_at string | null 保存期限 (UTC)。
cURLの例
curl https://sigclean.io/api/files \ -H "Authorization: Bearer YOUR_KEY"

メソッド: ファイルの削除

POST https://sigclean.io/api/files/delete

サーバーからファイルを完全に削除します。ファイルは現在のユーザーに属している必要があります。

認証
Authorization: Bearer YOUR_API_KEY
リクエストボディ application\/json
パラメータ型必須説明
uuid string はい \/api\/clean または \/api\/files のレスポンスに含まれるファイルのUUID。
レスポンス
{ "status": "ok" }
エラーコード
コード説明
401認証されていません
404ファイルが見つからないか、ユーザーに属していません
422uuid が指定されていないか、無効です
cURLの例
curl -X POST https://sigclean.io/api/files/delete \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000"}'

メソッド: ファイルの名前変更

POST https://sigclean.io/api/files/rename

表示されるファイル名を変更します。ファイルは現在のユーザーに属している必要があります。

認証
Authorization: Bearer YOUR_API_KEY
リクエストボディ application\/json
パラメータ型必須説明
uuid string はい \/api\/clean または \/api\/files のレスポンスに含まれるファイルのUUID。
name string はい 新しい表示ファイル名 (最大255文字)。
レスポンス
{ "status": "ok", "name": "stamp.jpg" }
エラーコード
コード説明
401認証されていません
404ファイルが見つからないか、ユーザーに属していません
422uuid \/ name が指定されていないか、無効です
cURLの例
curl -X POST https://sigclean.io/api/files/rename \ -H "Authorization: Bearer YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"uuid":"550e8400-e29b-41d4-a716-446655440000","name":"stamp.jpg"}'

APIキーの管理

キーを管理するには、アカウントにログインする必要があります。