Developer API

No installation needed — call the REST endpoint directly with any HTTP client.

<dependency>
  <groupId>com.webpninja</groupId>
  <artifactId>webpninja-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

// or Gradle (works the same in an Android app module):
implementation 'com.webpninja:webpninja-sdk:1.0.0'

pip install webpninja

npm install @webpninja/sdk

🚧 Publishing soon — not yet live on npm.

gem install webpninja

🚧 Publishing soon — not yet live on RubyGems.

composer require webpninja/webpninja

🚧 Publishing soon — not yet live on Packagist.

dotnet add package WebPNinja

🚧 Publishing soon — not yet live on NuGet.

curl -X POST https://api.webpninja.com/api/v1/compress \
  -H "Authorization: Bearer webpninja_live_your_key" \
  -F "file=@photo.png" \
  -F "format=webp" \
  -F "quality=75" \
  --output photo.webp

import com.webpninja.sdk.WebPNinja;

WebPNinja client = new WebPNinja("webpninja_live_your_key");

client.compressToFile(new File("photo.png"), new File("photo.webp"), "webp", 75);

from webpninja import WebPNinja

client = WebPNinja("webpninja_live_your_key")

client.compress_to_file("photo.png", "photo.webp", format="webp", quality=75)

This is the real Node.js SDK code — it'll work as soon as the package is published (see Installation above).

import { WebPNinja } from "@webpninja/sdk";

const client = new WebPNinja("webpninja_live_your_key");

await client.compressToFile("photo.png", "photo.webp", {
  format: "webp",
  quality: 75,
});

Official Ruby SDK — coming soon. Here's how to call the API directly today:

require "net/http"
require "uri"

uri = URI("https://api.webpninja.com/api/v1/compress")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer webpninja_live_your_key"
request.set_form(
  [
    ["file", File.open("photo.png"), { filename: "photo.png" }],
    ["format", "webp"],
    ["quality", "75"],
  ],
  "multipart/form-data"
)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

raise response.body unless response.is_a?(Net::HTTPSuccess)

File.binwrite("photo.webp", response.body)

Official PHP SDK — coming soon. Here's how to call the API directly today:

<?php
$ch = curl_init("https://api.webpninja.com/api/v1/compress");

curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer webpninja_live_your_key"],
    CURLOPT_POSTFIELDS => [
        "file" => new CURLFile("photo.png"),
        "format" => "webp",
        "quality" => "75",
    ],
]);

$result = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status !== 200) {
    throw new Exception($result);
}

file_put_contents("photo.webp", $result);

Official .NET SDK — coming soon. Here's how to call the API directly today:

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", "webpninja_live_your_key");

using var content = new MultipartFormDataContent();
content.Add(new ByteArrayContent(await File.ReadAllBytesAsync("photo.png")), "file", "photo.png");
content.Add(new StringContent("webp"), "format");
content.Add(new StringContent("75"), "quality");

var response = await client.PostAsync("https://api.webpninja.com/api/v1/compress", content);
response.EnsureSuccessStatusCode();

await File.WriteAllBytesAsync("photo.webp", await response.Content.ReadAsByteArrayAsync());