API ドキュメント

APIキーの取得

ログインしてマイアカウントを開き、 APIタブを選びます。キーが表示され、再生成ボタンもあります。 キーを再生成すると古いキーはすぐに無効になるため、ボタンを押す前に、キーを使っている箇所をすべて更新できるようにしてください。

このタブには、独立したもうひとつのアップロード専用キーもあります。 使い分けについては、下のヒントとフォーラム用プラグインをご覧ください。

認証

キーはヘッダーで送信してください。クエリ文字列はアクセスログやプロキシログ、Refererヘッダーに残りやすいため、ヘッダーでの送信を推奨します。

X-API-Key: YOUR_API_KEY

クエリパラメーター?key=も使えます。古い連携との互換性や、curlでの簡単な単発実行向けです。 両方指定した場合は、ヘッダーが優先されます。

?key=YOUR_API_KEY

エンドポイント

アップロード、一覧取得、削除は同じ認証とレート制限を共有します。 大きなファイルは、先に分割して送信できます。

POST /api - ファイルのアップロード

認証したアカウントに、ファイルを1つアップロードします。

対応形式: 画像はJPG, PNG, GIF, WEBP, AVIF, BMP, TIFF, HEIC または HEIF、動画はMP4, WEBM または AVI （対応形式は今後増える可能性があります）。HEIC/HEIFとTIFFはWebPとして保存され、MP4/WebM以外の動画はMP4に変換されます。 サイズの大きいJPEG/PNG画像は、アップロード後まもなく、目に見えてサイズが小さくなる場合にWebPへ変換されます。 最大サイズ: 200MB。サイズ超過や読み取れないファイルは422で拒否されます。

レスポンス - 200 OK:

{
  "type": "success",
  "msg": "success",
  "data": {
    "id": "aB3xY9qRz1",
    "type": "image",
    "path": "https://i.yourimageshare.com/aB3xY9qRz1.png",
    "src": "https://yourimageshare.com/ib/aB3xY9qRz1.png",
    "direct": "https://yourimageshare.com/ib/aB3xY9qRz1",
    "thumb": "https://i.yourimageshare.com/thumb-aB3xY9qRz1.webp",
    "width": 1920,
    "height": 1080,
    "size": 482113,
    "locked": false,
    "visibility": "unlisted",
    "title": null,
    "description": null,
    "expires_at": null,
    "duplicate": false,
    "delete_url": "https://yourimageshare.com/delete#iV3x...k9"
  }
}

POST /api/chunk - 大きなファイル

1回のリクエストで送れるのは最大100MBです。それより大きいファイル（200MBまで）や、 回線が遅い場合にリクエストを小さく保ちたいときは、5MB以下の断片に分けて送信し、最後に POST /apiで完了させます。

1. アップロードIDを決めます：ランダムな16進数32文字です。
2. 断片ごとに、POST /api/chunk（multipart/form-data）で upload_id、index（0始まり）、total（断片の総数）、 およびchunkにバイト列を送信します。レスポンスは {"type": "success", "chunk_size": 5242880}です。
3. uploadsの代わりにupload_idとfilenameを指定してPOST /apiを実行します。 その他のアップロード用フィールドも指定できます。レスポンスは通常のアップロードと同じです。

完了していないアップロードの断片は、2時間後に削除されます。アップロードのレート制限に数えられるのは、 完了時のPOST /apiのみです。

GET /api/{id} と PATCH /api/{id} - 個別のアップロード

GETは、下の一覧と同じフィールドで自分のアップロードを1件返します。 PATCHはvisibility、title、descriptionを変更し （フォームフィールドまたはJSON。タイトルや説明を空にするとクリアされます）、更新後のアップロードを返します。 どちらもフルAPIキーが必要です。アカウントにそのアップロードがない場合は404になります。

curl -X PATCH https://yourimageshare.com/api/aB3xY9qRz1 \
  -H "X-API-Key: YOUR_API_KEY" -d visibility=public -d title="Sunset"

POST /api/{id}/replace - ファイルの差し替え

自分のアップロードのファイルを差し替え、ID、ページ、すべてのリンクをそのまま維持します。許可されている形式であれば、 別の種類にも差し替えられます（画像を動画に変えることもできます）。新しいファイルはuploadsとして送信するか、 POST /api/chunkで分割送信したファイルのupload_idを指定します。keep_originalはアップロード時と同様に使えます。 新しいファイルには新規アップロードと同じチェックと変換が適用され、以前のバージョンは削除されます。フルAPIキーが必要です。 アカウントにそのアップロードがない場合は404、パスワード保護または閲覧回数制限がある場合は409になります。

curl -X POST https://yourimageshare.com/api/aB3xY9qRz1/replace \
  -H "X-API-Key: YOUR_API_KEY" -F [email protected]

GET /api - アップロード一覧の取得

認証したアカウントのアップロード（API、ウェブサイト、エディターなど、どこから行ったものも含む）を、 新しい順に1ページ50件でページ分割して返します。

レスポンス - 200 OK:

{
  "type": "success",
  "data": [
    {
      "id": "aB3xY9qRz1",
      "type": "image",
      "title": null,
      "path": "https://i.yourimageshare.com/aB3xY9qRz1.webp",
      "src": "https://yourimageshare.com/ib/aB3xY9qRz1.webp",
      "direct": "https://yourimageshare.com/ib/aB3xY9qRz1",
      "thumb": "https://i.yourimageshare.com/thumb-aB3xY9qRz1.webp",
      "width": 1920,
      "height": 1080,
      "size": 482113,
      "locked": false,
      "visibility": "unlisted",
      "description": null,
      "expires_at": null,
      "created_at": "2026-07-23T15:43:28+01:00"
    }
  ],
  "meta": { "current_page": 1, "last_page": 1, "total": 1 }
}

各フィールドの意味は、上のアップロードのレスポンスと同じです （パスワード保護されたアップロードでは、pathとthumbは有効期間の短い署名付きリンクになります）。 「1件だけ取得する」エンドポイントはまだないため、この一覧は、後からファイルのidを調べる方法でもあります。

DELETE /api/{id} - アップロードの削除

認証したアカウントのアップロードを1件、完全に削除します。APIから元に戻すことはできません。 {id}は、アップロードまたは一覧のエンドポイントがidとして返す値です。

レスポンス - 200 OK:

{ "type": "success", "msg": "Deleted." }

そのIDのアップロードがアカウントにない場合は404です （最初から自分のものではないか、すでに削除されています）。

レート制限

APIキーごとに、1分あたりと1日あたりの上限が独立して設定されています。 さらに、1つのIPが複数のキーを使い回すことへの備えとして、IPごとの1日あたりの大まかな上限もあります。 アップロード、一覧取得、削除は同じ制限を共有します。

これらの上限は変更される場合があります。すべてのレスポンスに、標準的なレート制限ヘッダーが含まれます。

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 14

上限を超えると429が返され、Retry-Afterヘッダーで待機すべき秒数が示されます。

エラー

エンドポイントや原因にかかわらず、すべてのエラーレスポンスは同じ形式です。

{ "type": "error", "errors": "A human-readable description of what went wrong." }

クライアントライブラリ

上記のエンドポイントをラップした公式SDKです。型付きの結果を返し、 APIエラーは生のHTTP処理ではなく例外として扱えます。

JavaScript / TypeScript

依存パッケージなしで、Node.jsとブラウザの両方で動作します。 JSR でも@yourimageshare/yourimageshareとして公開しています（npx jsr add @yourimageshare/yourimageshare）。 ソースは同じで、TypeScriptのまま公開されています。

npm install yourimageshare

Python

依存パッケージは1つ（requests）、Python 3.8以上。

pip install yourimageshare

PHP

Composerの依存パッケージなし（PHP標準のcurl拡張を使用）、PHP 7.4以上。 ソースはGitHubにあります。

composer require yourimageshare/yourimageshare-php

Go

依存パッケージなし（標準ライブラリのみ）、Go 1.18以上。詳しいリファレンスは pkg.go.dev をご覧ください。

go get github.com/yourimageshare/yourimageshare/go

Rust

依存パッケージは2つ（ブロッキングHTTP用のureqで、非同期ランタイムは含まれません。 もう1つはserde）、Rust 1.70以上。ソースは GitHubにあります。

cargo add yourimageshare

Ruby

gemの依存パッケージなし（標準ライブラリのNet::HTTPとjson）、Ruby 2.7以上。 ソースはGitHubにあります。

gem install yourimageshare

.NET

依存パッケージは1つ（Microsoft純正のSystem.Text.Json）。netstandard2.0を対象としているため、 .NET Frameworkでも最新の.NETでも動作します。ソースは GitHubにあります。 この本番APIに対してビルドと動作確認を済ませており、NuGetでは近日公開予定です。

dotnet add package YourImageShare

Dart / Flutter

依存パッケージは1つ（Dartチーム公式のhttp）、Dart 2.17以上。ソースは GitHubにあります。 この本番APIに対してビルドと動作確認を済ませており、pub.devでは近日公開予定です。

dart pub add yourimageshare

Elixir

依存パッケージは1つ（Req）、Elixir 1.14以上。 {:ok, result}| {:error, reason}のタグ付きタプルを返します。 他のすべてのSDKにおけるこのAPIのエラー処理に相当するもので、例外を発生させるbang版の関数もあります。ソースは GitHub、 ドキュメントはHexDocsにあります。

{:yourimageshare, "~> 1.1"}

MCPサーバー

AIコーディングエージェント（Claude Code、Cursor、その他の MCP対応ツール）向けです。 base64の文字列や手動のアップロード作業の代わりに、スクリーンショットを実際のURLとして バグ報告、PRの説明、サポートのやり取りに貼り付けられます。Claude Desktopやその他のMCPクライアントでも同じように使えます。 インストール不要で、npxで直接実行できます。

npx yourimageshare-mcp

ツール：upload_image（ローカルファイル、インラインのコンテンツ、またはリンク。200MBまで。公開範囲、タイトル、自動削除は任意）、list_uploads、get_upload、update_upload、delete_upload。

公式MCP Registry（io.github.yourimageshare/yourimageshareとして）に登録されているほか、SmitheryとGlamaにも掲載されています。お使いのMCPクライアントがこれらからインストールする場合にご利用ください。

MCPが初めての方は、セットアップの手順を詳しく説明したClaudeとChatGPTをMCPでこのAPIに接続する方法をご覧ください。

コード例

curl

# Upload a file
curl "https://yourimageshare.com/api" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "uploads=@/path/to/photo.jpg"

# Upload from a link (files up to 200MB; one direct upload request stops at 100MB -
# bigger files go in pieces, see Large Files above)
curl "https://yourimageshare.com/api" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "url=https://example.com/video.mp4"

# Upload a file that auto-deletes after 1 hour
curl "https://yourimageshare.com/api" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "uploads=@/path/to/photo.jpg" \
  -F "expires_in=3600"

# List uploads
curl "https://yourimageshare.com/api" -H "X-API-Key: YOUR_API_KEY"

# Upload a file without a page of its own (file only) and give it a title
curl "https://yourimageshare.com/api" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "uploads=@/path/to/photo.jpg" \
  -F "visibility=private" \
  -F "title=Sunset"

# Look up one upload, then make it public
curl "https://yourimageshare.com/api/aB3xY9qRz1" -H "X-API-Key: YOUR_API_KEY"
curl -X PATCH "https://yourimageshare.com/api/aB3xY9qRz1" \
  -H "X-API-Key: YOUR_API_KEY" -d "visibility=public"

# Delete an upload
curl -X DELETE "https://yourimageshare.com/api/aB3xY9qRz1" -H "X-API-Key: YOUR_API_KEY"

JavaScript (fetch)

const API_KEY = 'YOUR_API_KEY';
const BASE = 'https://yourimageshare.com/api';

async function uploadFile(file) {
  const form = new FormData();
  form.append('uploads', file);

  const res = await fetch(BASE, {
    method: 'POST',
    headers: { 'X-API-Key': API_KEY },
    body: form,
  });
  const json = await res.json();
  if (json.type !== 'success') throw new Error(json.errors);
  return json.data;
}

async function listUploads(page = 1) {
  const res = await fetch(`${BASE}?page=${page}`, {
    headers: { 'X-API-Key': API_KEY },
  });
  return res.json();
}

async function deleteUpload(id) {
  const res = await fetch(`${BASE}/${id}`, {
    method: 'DELETE',
    headers: { 'X-API-Key': API_KEY },
  });
  return res.json();
}

Python (requests)

import requests

API_KEY = "YOUR_API_KEY"
BASE = "https://yourimageshare.com/api"

HEADERS = {"X-API-Key": API_KEY}

# Upload a file
with open("/path/to/photo.jpg", "rb") as f:
    res = requests.post(BASE, headers=HEADERS, files={"uploads": f})
res.raise_for_status()
upload = res.json()["data"]

# List uploads
res = requests.get(BASE, headers=HEADERS, params={"page": 1})
uploads = res.json()

# Delete an upload
res = requests.delete(f"{BASE}/{upload['id']}", headers=HEADERS)

PHP (curl)

<?php

$apiKey = 'YOUR_API_KEY';
$base = 'https://yourimageshare.com/api';

// Upload a file
$curl = curl_init($base);
curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => ["X-API-Key: $apiKey"],
    CURLOPT_POSTFIELDS => ['uploads' => new CURLFile('/path/to/photo.jpg')],
    CURLOPT_RETURNTRANSFER => true,
]);
$upload = json_decode(curl_exec($curl), true)['data'];
curl_close($curl);

// List uploads
$curl = curl_init("$base?page=1");
curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-API-Key: $apiKey"]);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$uploads = json_decode(curl_exec($curl), true);
curl_close($curl);

Go (net/http)

上記の公式Goライブラリがこの処理をラップしています。 こちらは、依存パッケージを追加したくない方向けの、生のコードです。

package main

import (
    "bytes"
    "encoding/json"
    "io"
    "mime/multipart"
    "net/http"
    "os"
)

const apiKey = "YOUR_API_KEY"
const base = "https://yourimageshare.com/api"

func uploadFile(path string) (map[string]any, error) {
    file, err := os.Open(path)
    if err != nil {
        return nil, err
    }
    defer file.Close()

    body := &bytes.Buffer{}
    writer := multipart.NewWriter(body)
    part, _ := writer.CreateFormFile("uploads", path)
    io.Copy(part, file)
    writer.Close()

    req, _ := http.NewRequest("POST", base, body)
    req.Header.Set("Content-Type", writer.FormDataContentType())
    req.Header.Set("X-API-Key", apiKey)

    res, err := http.DefaultClient.Do(req)
    if err != nil {
        return nil, err
    }
    defer res.Body.Close()

    var result map[string]any
    json.NewDecoder(res.Body).Decode(&result)
    return result, nil
}

スクリーンショットツール

ブラウザ拡張機能と、スクリーンショットを手動アップロードなしでYourImageShareに直接送るための 設定ファイルやスクリプトです。どれも、上で説明した同じ/apiエンドポイントを通じてアップロードします。

ブラウザ拡張機能（Chrome・Firefox）

ChromeとFirefox向けの拡張機能YourImageShare Captureなら、スクリプトも設定ファイルも不要です。 表示中の領域、ドラッグで選択した範囲、スクロールするページ全体をキャプチャでき、 矢印、テキスト、ぼかし・塗りつぶしなどの注釈を付けられる内蔵エディターが開きます。 結果はダウンロード、クリップボードへのコピー、ワンクリックでのYourImageShareへの公開から選べます。 公開には上で説明した同じ/apiエンドポイントを使います。拡張機能の設定でAPIキーを一度追加すれば、 以降は公開するたびに、共有用のリンクがすぐに返されます。デスクトップ版Chrome（およびその他のChromiumブラウザ）、 デスクトップ版Firefox、Android版Firefoxで動作します。

Firefox版YourImageShare Captureを入手 Chrome版YourImageShare Captureを入手

ShareX

下のカスタムアップローダーをダウンロードし、ShareXで Destinations > Custom uploader settings > Import > from file を開いて、ダウンロードした.sxcuを選択します。そしてHeaders欄の YOUR_API_KEYを実際のキーに置き換えてください。画像・ファイルの保存先としてこれを設定すれば、キャプチャが自動でアップロードされます。

YourImageShare.sxcuをダウンロード

Flameshot（Linux）

flameshot guiを実行してキャプチャをアップロードし、リンクをクリップボードにコピーする小さなシェルスクリプトです。 お使いのデスクトップ環境で、Flameshotのデフォルトのショートカットの代わりにキーボードショートカットへ割り当ててください。

yis-flameshot-upload.shをダウンロード

# One-time setup
chmod +x yis-flameshot-upload.sh
export YIS_API_KEY="YOUR_API_KEY"   # or add to ~/.config/yourimageshare/api_key

# Then bind this to a hotkey instead of calling flameshot directly:
/path/to/yis-flameshot-upload.sh

Greenshot（Windows）

Greenshot内蔵のExternal commandの保存先用のPowerShellスクリプトです。 Windowsに標準で付属するWindows PowerShell 5.1に対応しており、追加のインストールは不要です。

yis-greenshot-upload.ps1をダウンロード

# One-time setup
setx YIS_API_KEY "YOUR_API_KEY"

# In Greenshot: Preferences > Destinations > External command > Settings
#   Command:   powershell.exe
#   Arguments: -ExecutionPolicy Bypass -File "C:\path\to\yis-greenshot-upload.ps1" "%1"

フォーラム用プラグイン

フォーラムの投稿エディターの横に、本物の「画像をアップロード」ボタンを追加できます。 どれも、上で説明した同じ/apiエンドポイントを通じてアップロードし、カーソル位置にBBCodeを挿入します。 別タブも、手動のコピー＆ペーストも不要です。

フォーラムからのアップロードは、デフォルトで非公開です。投稿内では画像が表示されますが、 YourImageShareにはその画像専用のページは作られません（コメント、リアクション、広告なし）。 リンクを知っている人向けにページも用意したい場合は、各プラグインの設定でunlistedに切り替えられます。

phpBB

本物のphpBB 3.2/3.3用の拡張機能です。ext/に解凍し、 Customise > Manage extensionsで有効にしたら、拡張機能のテンプレートイベントファイル内の YOUR_UPLOAD_ONLY_KEYを、実際のアップロード専用キーに置き換えてください。

phpBB用をダウンロード

SMF（Simple Machines Forum）

本物のSMF用パッケージです。Admin > Package Managerからインストールし、 Sources/yis_forumupload.php内のYOUR_UPLOAD_ONLY_KEYを、 実際のアップロード専用キーに置き換えてください。

SMF用をダウンロード

MyBB

本物のMyBB 1.8用プラグインです。inc/plugins/にコピーし、 Configuration > Pluginsで有効にしたら、プラグインファイル内の YOUR_UPLOAD_ONLY_KEYを、実際のアップロード専用キーに置き換えてください。

MyBB用をダウンロード

FluxBB、PunBB、ZetaBoards

これらには正式なプラグインの仕組みがないため、小さなスニペットを、テンプレート（FluxBB/PunBB）または 管理パネル（ZetaBoards）に直接貼り付けて使います。それぞれのコピー＆ペースト手順は次のとおりです。

FluxBBの手順 PunBBの手順 ZetaBoardsの手順

WordPressプラグイン

メディアライブラリをローカルディスクではなくYourImageShareにオフロードします。 新しい画像・動画のアップロードは、上で説明した同じ/apiエンドポイントを通じて自動的に送信され、 アップロードの完了を確認するとローカルのファイル（生成されたすべてのサムネイルサイズを含む）は削除されます。 ブロックエディター、アイキャッチ画像、ギャラリー、REST APIなど、WordPressのあらゆる添付ファイルのURLが、 YourImageShareにあるファイルを指すようになります。ショートコードも、作業手順の変更も不要です。

• 新規アップロードだけでなく、既存のメディアライブラリもバックグラウンドで（またはwp yis offload --allで）一括オフロードできます
• 投稿に挿入済みの画像や動画は、ローカルのファイルが削除された後も引き続き表示されます
• サムネイルとsrcsetには当社の280pxのサムネイルを使うため、小さな画像枠でフルサイズのファイルを読み込みません
• 200MBまでのファイルを分割して送信するため、大きな動画でも共有ホスティングに負荷がかかりません
• オフロードしたファイルは、いつでもローカルストレージに戻せます
• メディアライブラリの列で、オフロード済みのものとまだローカルにあるものを確認できます
• オフロードしたファイルは非公開として保存されます。サイトで使っている場所では表示されますが、YourImageShare上にその専用ページは作られません

WordPress.orgで入手 ZIPをダウンロード

WordPressで：プラグイン > 新規追加を開き、YourImageShare Media Offloadを検索して、インストールし有効化します。

ブログから