Skip to content
smallPict

画像最適化APIエンドポイント

画像処理の基幹エンドポイント POST /v1/optimize の技術仕様リファレンス。

画像の最適化、フォーマット変換、ダウンスケール、リサイズを行うプライマリエンドポイントは以下の通りです:

POST https://api.smallpict.app/v1/optimize
(エイリアス: POST https://api.smallpict.app/v1/convert)


リクエスト形式 (JSONペイロード)

HTTP
POST /v1/optimize HTTP/1.1Host: api.smallpict.appX-API-Key: sp_sdk_9a8b7c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0bX-Timestamp: 1716301234X-Signature: 3a9f8b2c4d6e8a0f1b3c5d7e9f2a4b6c8d0e1f3a5b7c9d1e3f5a7b9c1d3e5f7aContent-Type: application/jsonIdempotency-Key: c9b8a7f6-e5d4-4c3b-2a1f-0e9d8c7b6a5f

リクエストボディスキーマ

JSON
{  "filename": "hero-banner.jpg",  "mime_type": "image/jpeg",  "filesize": 1654200,  "options": {    "format": "avif",    "quality": 80,    "max_dimension": 1600,    "max_width": 1920,    "max_height": 1080,    "lossless": false,    "strip_metadata": true  }}
フィールド型必須説明
filenamestring必須画像アセットの元のファイル名 (例: banner.png)
mime_typestring必須MIMEタイプ (例: image/jpeg, image/png, image/webp)
filesizeinteger必須合計ファイルサイズ(バイト単位、> 0)
options.formatstring任意変換先フォーマット: avif, webp, original / keep, jpg, png (初期値: webp)
options.qualityinteger任意圧縮品質 (1 ~ 100、初期値: 80)
options.max_dimensioninteger任意長辺の最大ピクセル寸法比例縮小しきい値 (例: 1600, 1920, 2048, 2560)
options.max_widthinteger任意最大ピクセル幅制限
options.max_heightinteger任意最大ピクセル高さ制限
options.losslessboolean任意ピクセル完全一致のロスレス圧縮を有効化 (初期値: false)
options.strip_metadataboolean任意EXIFおよびカラープロファイルメタデータを削除 (初期値: true)

リアルタイム画像トランスフォーマーパラメータ

クラウド変換ルートでは、クエリパラメータを用いたオンザフライ変換・リサイズが可能です:

GET https://api.smallpict.app/v1/transform?url=...&format=webp&quality=80&max_dimension=1600

  • ?format=avif|webp|original
  • ?quality=1..100
  • ?max_dimension=1600
  • ?max_width=1920
  • ?max_height=1080

レスポンス (200 OK)

初期化が成功すると、SmallPictは安全な署名付きアップロードURLと非同期ジョブIDを返します:

Response · 200 OK
{  "upload_url": "https://upload.smallpict.app/uploads/a1b2c3d4/hero-banner.jpg?signature=...",  "job_id": "job-a1b2c3d4",  "object_key": "uploads/a1b2c3d4/hero-banner.jpg",  "status": "queued"}

画像データを HTTP PUT リクエストで upload_url にアップロードし、その後ジョブのステータスを確認してください。安全なアップロードリンクはレスポンスで返された値をそのまま使用してください。短時間で失効し、このアップロードにのみ有効です。


ジョブ進行状況の確認

以下のエンドポイントで処理状況を照会します:

GET https://api.smallpict.app/v1/optimize/status?job_id=job-a1b2c3d4

完了時のレスポンス (200 OK)

Response · 200 OK
{  "job_id": "job-a1b2c3d4",  "status": "completed",  "url": "https://cdn.smallpict.app/opt/hero-banner.avif",  "format": "avif",  "bytes_saved": 1456200,  "savings_percentage": 88.03,  "created_at": "2026-08-23T08:00:00Z",  "updated_at": "2026-08-23T08:00:01Z"}