画像フォーマットを変換する API
このエンドポイントの機能： の PDF4me 画像フォーマットを変換する REST API 画像を変換する JPG、 PNGWebP、BMP、GIF、 TIFF 単一のフォーマット POST 呼び出し。ソース画像をとして送信します Base64-エンコードされた文字列、現在のフォーマットとターゲットフォーマットを指定し、変換された画像を受け取ります。 Base64処理パイプライン全体で画像フォーマットを標準化したり、従来の BMP や TIFF ウェブ配信用のファイルを作成するか、または画像を圧縮イメージエンドポイントで処理する前に画像を準備します。
認証 API リクエスト
毎 PDF4me REST API 電話にはあなたの API キー Authorization ヘッダー。開発者ダッシュボードからキーを取得し、クライアント側のコードには含めないようにしてください。
見逃してはならない重要な事実
docName, docContent, CurrentImageFormat, and NewImageFormat must all be present. A missing format parameter causes the API to return a 400 error. Always provide both format fields explicitly: do not assume the API will infer the source format from the file extension in docName.
The API uses CurrentImageFormat to select the correct decoding codec. If you send a PNG file but set CurrentImageFormat to JPG, decoding fails with a format error. Read the real format from your source file MIME type or binary header: never derive it solely from the filename extension, which can be wrong.
JPG does not support an alpha channel. Transparent areas in a PNG or GIF source are filled with white (or a default background) during JPG conversion. If your image has a transparent background: logos, cut-out product photos, icons, convert to PNG, GIF, or BMP instead of JPG to preserve the transparency.
REST API 終点
| 方法 | 終点 |
|---|---|
| POST | /api/v2/ConvertImageFormat |
ベースURL: https://api.pdf4me.com
パラメータ
⚠️ 4つのパラメータすべてが必要です。 の API いずれかのフィールドが欠落している場合はエラーを返します。
| パラメータ | 必須 | タイプ | その機能 | 例 |
|---|---|---|---|---|
| docName | Required | String | Filename of the source image including the file extension. Used for output file naming. Should reflect the actual format of the source file. | company-logo.png |
| docContent | Required | Base64 | The complete source image file encoded as a Base64 string. Maximum file size: 50 MB. Do not include a data URL prefix: pass the raw Base64 string only. | iVBORw0KGgoAAAANSUhEUg... |
| CurrentImageFormat | Required | Enum | The actual format of the source image in docContent. Must match exactly. Accepted values: BMP · GIF · JPG · PNG · TIFF | PNG |
| NewImageFormat | Required | Enum | The target format for the converted output image. Accepted values: BMP · GIF · JPG · PNG · TIFF | JPG |
出力フィールド
| パラメータ | 必須 | その機能 | 例 |
|---|---|---|---|
| jobIdExt | Optional | Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string. | |
| integrations | Optional | Integration identifiers, forwarded unchanged with the job's notification settings. Type: array. | |
| isAsync | Optional | Set to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean. | |
| docName | Optional | Source file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string. | Filename of the converted output image. |
| docContent | Required | The source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string. | The converted image encoded as Base64. Decode to binary and save with the correct new file extension. |
| docContentBytes | Optional | Alternative raw byte payload for the source file. Type: string. | |
| callBackUrl | Optional | Optional URL notified when an asynchronous job completes. Type: string. | |
| currentImageFormat | Optional | Matched case-insensitively; an unrecognised value falls back to the first entry. Type: string. | |
| newImageFormat | Optional | Matched case-insensitively; an unrecognised value falls back to the first entry. Type: string. | |
リクエスト例
ヘッダー
Content-Type: application/json
Authorization: YOUR_API_KEY
JSONペイロード
{
"docName": "company-logo.png",
"docContent": "iVBORw0KGgoAAAANSUhEUg...",
"CurrentImageFormat": "PNG",
"NewImageFormat": "JPG"
}
応答
{
"File Content": "BASE64_CONVERTED_IMAGE_DATA",
"File Name": "company-logo.jpg"
}
コードサンプル
一般的な使用例
Marketing teams often accumulate mixed BMP, TIFF, and GIF files from various sources. Convert them all to PNG in a batch processing loop: PNG gives lossless quality and wide browser support, making it the safest default web format for logos and graphics.
Studio photographs are typically delivered as TIFF (50-200 MB each). Convert to JPG before uploading to your e-commerce platform or CDN to reduce storage costs by 80-90%. Pair with the Compress Image endpoint for a complete optimisation pipeline.
WebP images are 25-35% smaller than equivalent JPGs and supported by all modern browsers. Convert JPG or PNG assets to WebP to improve Core Web Vitals scores. Serve WebP with a JPG fallback using HTML picture elements.
よくある質問
▶ What image formats does the Convert Image Format API support?
The API supports BMP, GIF, JPG, PNG, and TIFF as both input (CurrentImageFormat) and output (NewImageFormat). These five formats cover the most common image types used in enterprise and web workflows.
▶ Does CurrentImageFormat need to match the actual binary format of docContent?
Yes: always. The API uses CurrentImageFormat to select the correct decoding codec. A mismatch between the actual binary format and CurrentImageFormat causes a decoding failure. Read the real format from your file's MIME type or binary signature, not just the filename extension.
▶ How does PNG-to-JPG conversion handle transparency?
JPG does not support an alpha channel. Transparent areas in a PNG source are replaced with a solid background colour (typically white) during conversion. If preserving transparency matters: logos, product cut-outs, icons, convert to PNG, GIF, or BMP instead of JPG.
▶ Can I convert and compress an image in the same API call?
No: Convert Image Format only changes the format. To also compress, call Convert Image Format first to get the target format, then pass the result's File Content to the Compress Image endpoint with your chosen compression level. Chain both calls in your application.
▶ What is the maximum file size accepted by this endpoint?
Up to 50 MB. For best performance keep images under 10 MB. Note that format conversion can change file size: converting a PNG to JPG typically reduces size, while converting JPG to TIFF may increase it significantly.