画像を管理

REST API と Python SDK を通じて、個々の画像をアップロード、アノテーション、検査、タグ付け、削除します。

概要

Roboflow では、REST API と Python SDK を通じて、プロジェクト内の個々の画像をアップロード、アノテーション、検査、タグ付け、削除できます。バルクのデータセットアップロードフローよりも細かな制御が必要な場合は、これらの操作を使用してください。たとえば、ストリームから 1 画像ずつアップロードする、後からアノテーションを付ける、画像メタデータやタグを更新する、といった場合です。ラベル付きデータセット全体を一度にまとめてインポートするには、次を参照してくださいデータセットをアップロード.

HTTP API

REST API は、画像とアノテーションのアップロード、画像詳細の取得、画像の削除、画像タグとメタデータの管理のための画像ごとの操作を提供します。

画像をアップロード

REST API を使用して、ローカルファイルまたは URL から画像をアップロードします。

パラメータ

API が受け付けるクエリ文字列パラメータ：

api_key：https://app.roboflow.com/account/api から取得してください image：[任意] 追加する画像の URL。画像が別の場所でホストされている場合に使用します（リクエスト本文で base64 エンコード済み画像を POST しない場合は必須）。 name：[任意] 画像のファイル名（未設定の場合は推測を試みます）。 batch：[任意] この名前のバッチに画像をまとめます tag：[任意] 複数回指定できます。アップロードした画像にタグを追加します。 split：[任意] train、valid、test のいずれか（デフォルトは train）。 sequence_number：[任意] データセット内の画像の順序を保持したい場合、アップロードした画像に昇順のシーケンス番号を付けられます。 sequence_size：[任意] シーケンス内の画像総数。未設定の場合のデフォルトは 100,000 です。 inference_id：[任意] Roboflow の推論検出から返される inference ID。これにより、画像を Model Monitoring（エンタープライズ機能）内の Roboflow の検出結果と関連付けられます。

Linux または macOS

という名前のローカルファイルをアップロードする YOUR_IMAGE.jpg multipart/form-data を使用して（推奨）：

curl -F name=YOUR_IMAGE.jpg -F split=train \
-F file=@YOUR_IMAGE.jpg \
"https://api.roboflow.com/dataset/YOUR_DATASET_NAME/upload?\
api_key=$ROBOFLOW_API_KEY"

別の方法として、base64 エンコード済み画像をアップロードします：

base64 -i YOUR_IMAGE.jpg | curl -d @- \
"https://api.roboflow.com/dataset/your-dataset/upload?\
api_key=$ROBOFLOW_API_KEY&\
name=YOUR_IMAGE.jpg&\
split=train&\
batch=BATCH_NAME_FOR_UPLOAD"

Web 上にホストされた画像を URL 経由でアップロードする場合（忘れずに URL エンコードしてください):

curl -X POST "https://api.roboflow.com/dataset/your-dataset/upload?\
api_key=$ROBOFLOW_API_KEY&\
image=https%3A%2F%2Fi.imgur.com%2FPEEvqPN.png&\
name=201-956-1246.png&\
split=train"

Windows

インストールする必要があります Windows 用 curl と GNU の Windows 用 base64 ツール。これを行う最も簡単な方法は、 Git for Windows インストーラーには次も含まれます： curl と base64 インストール時に「コマンドプロンプトから Git とオプションの Unix ツールを使用する」を選択すると、コマンドラインツールも含まれます。

その後は上記と同じコマンドを使用できます。

Node.js

この例では axios と form-data この例で POST リクエストを実行するために使用するので、まず npm install axios form-data 依存関係をインストールしてください。

multipart/form-data を使用してアップロード（推奨）：

const axios = require("axios");
const fs = require("fs");
const FormData = require('form-data');

const formData = new FormData();
formData.append("name", "YOUR_IMAGE.jpg");
formData.append("file", fs.createReadStream("YOUR_IMAGE.jpg"));
formData.append("split", "train");

axios({
    method: "POST",
    url: "https://api.roboflow.com/dataset/YOUR_DATASET_NAME/upload",
    params: {
        api_key: "YOUR_API_KEY"
    },
    data: formData,
    headers: formData.getHeaders()
})
.then(function(response) {
    console.log(response.data);
})
.catch(function(error) {
    console.log(error.message);
});

base64 エンコード済み画像を使用してアップロード（非推奨）：

const axios = require("axios");
const fs = require("fs");

const image = fs.readFileSync("YOUR_IMAGE.jpg", {
    encoding: "base64"
});

axios({
    method: "POST",
    url: "https://api.roboflow.com/dataset/YOUR_DATASET_NAME/upload",
    params: {
        api_key: "YOUR_API_KEY",
        name: "YOUR_IMAGE.jpg",
        split: "train",
        batch: "YOUR_BATCH_NAME"
    },
    data: image,
    headers: {
        "Content-Type": "application/x-www-form-urlencoded"
    }
})
.then(function(response) {
    console.log(response.data);
})
.catch(function(error) {
    console.log(error.message);
});

URL 経由で別の場所にホストされた画像を追加

const axios = require("axios");

axios({
    method: "POST",
    url: "https://api.roboflow.com/dataset/YOUR_DATASET_NAME/upload",
    params: {
        api_key: "YOUR_API_KEY",
        image: "https://i.imgur.com/PEEvqPN.png",
        name: "201-956-1246.png",
        split: "train"
    }
})
.then(function(response) {
    console.log(response.data);
})
.catch(function(error) {
    console.log(error.message);
});

Web

現在ベータテスト中です roboflow.js、ブラウザベースの JavaScript ライブラリで、これには他にも、秘密の API キーを Web に公開せずに安全にクライアントサイドアップロードを行う機能などが含まれます。先行アクセスをご希望の場合は、お問い合わせください.

Swift

iOS 向けの開発で Swift を使用したアップロード用スニペットの例です。

//指定したプロジェクトに画像をアップロード
public func uploadImage(image: UIImage, project: String, completion: @escaping (UploadResult)->()) {
    let encodedImage = convertImageToBase64String(img: image)
    let uuid = UUID().uuidString
    
    var request = URLRequest(url: URL(string: "https://api.roboflow.com/dataset/\(project)/upload?api_key=\(apiKey!)&name=\(uuid)&split=train")!,timeoutInterval: Double.infinity)

    request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
    request.httpMethod = "POST"
    request.httpBody = encodedImage.toData()
    
    URLSession.shared.dataTask(with: request) { data, response, error in
        // レスポンスを文字列にパース
        guard let data = data else {
            completion(UploadResult.Error)
            return
        }

        do {
            let dict = try JSONSerialization.jsonObject(with: data, options: []) as? [String: Any]
            let duplicate = dict!["duplicate"] as? Bool
            
            if duplicate ==  true {
                completion(UploadResult.Duplicate)
            } else {
                let success = dict!["success"] as! Bool
                if success == true {
                    completion(UploadResult.Success)
                } else {
                    completion(UploadResult.Error)
                }
            }

        } catch {
            print(error.localizedDescription)
            completion(UploadResult.Error)
        }
    }.resume()
}

func convertImageToBase64String (img: UIImage) -> String {
    return img.jpegData(compressionQuality: 1)?.base64EncodedString() ?? ""
}

}

Kotlin

base64 エンコード済み画像を使用してアップロード：

import java.io.*
import java.net.HttpURLConnection
import java.net.URL
import java.nio.charset.StandardCharsets
import java.util.*

fun main() {
    // 画像のパスを取得
    val filePath = System.getProperty("user.dir") + System.getProperty("file.separator") + "YOUR_IMAGE.jpg"
    val file = File(filePath)

    // Base64 でエンコード
    val encodedFile: String
    val fileInputStreamReader = FileInputStream(file)
    val bytes = ByteArray(file.length().toInt())
    fileInputStreamReader.read(bytes)
    encodedFile = String(Base64.getEncoder().encode(bytes), StandardCharsets.US_ASCII)
    val API_KEY = "" // あなたの API キー
    val DATASET_NAME = "your-dataset" // データセット名を設定（データセット URL にあります）

    // URL を構築
    val uploadURL = "https://api.roboflow.com/dataset/" +
            DATASET_NAME + "/upload" +
            "?api_key=" + API_KEY +
            "&name=YOUR_IMAGE.jpg" +
            "&split=train"

    // HTTP リクエスト
    var connection: HttpURLConnection? = null
    try {
        // URL への接続を設定
        val url = URL(uploadURL)
        connection = url.openConnection() as HttpURLConnection
        connection.requestMethod = "POST"
        connection.setRequestProperty("Content-Type",
                "application/x-www-form-urlencoded")
        connection.setRequestProperty("Content-Length",
                Integer.toString(encodedFile.toByteArray().size))
        connection.setRequestProperty("Content-Language", "en-US")
        connection.useCaches = false
        connection.doOutput = true

        // リクエストを送信
        val wr = DataOutputStream(
                connection.outputStream)
        wr.writeBytes(encodedFile)
        wr.close()

        // レスポンスを取得
        val stream = connection.inputStream
        val reader = BufferedReader(InputStreamReader(stream))
        var line: String?
        while (reader.readLine().also { line = it } != null) {
            println(line)
        }
        reader.close()
    } catch (e: Exception) {
        e.printStackTrace()
    } finally {
        connection?.disconnect()
    }
}
main()

URL 経由で別の場所にホストされた画像を追加：

import java.io.BufferedReader
import java.io.DataOutputStream
import java.io.InputStreamReader
import java.net.HttpURLConnection
import java.net.URL
import java.net.URLEncoder
import java.nio.charset.StandardCharsets

fun main() {
    val imageURL = "https://i.imgur.com/PEEvqPN.png" // 画像 URL を置き換えてください
    val API_KEY = "" // あなたの API キー
    val DATASET_NAME = "your-dataset" // データセット名を設定（データセット URL にあります）

    // アップロード URL
    val uploadURL = ("https://api.roboflow.com/dataset/" + DATASET_NAME + "/upload" + "?api_key=" + API_KEY
            + "&name=YOUR_IMAGE.jpg" + "&split=train" + "&image="
            + URLEncoder.encode(imageURL, "utf-8"))

    // HTTP リクエスト
    var connection: HttpURLConnection? = null
    try {
        // URL への接続を設定
        val url = URL(uploadURL)
        connection = url.openConnection() as HttpURLConnection
        connection.requestMethod = "POST"
        connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded")
        connection.setRequestProperty("Content-Length", Integer.toString(uploadURL.toByteArray().size))
        connection.setRequestProperty("Content-Language", "en-US")
        connection.useCaches = false
        connection.doOutput = true

        // リクエストを送信
        val wr = DataOutputStream(connection.outputStream)
        wr.writeBytes(uploadURL)
        wr.close()

        // レスポンスを取得
        val stream = connection.inputStream
        val reader = BufferedReader(InputStreamReader(stream))
        var line: String?
        while (reader.readLine().also { line = it } != null) {
            println(line)
        }
        reader.close()
    } catch (e: Exception) {
        e.printStackTrace()
    } finally {
        connection?.disconnect()
    }
}

main()

Android（Java）

base64 エンコード済み画像を使用してアップロード：

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.Base64;

public class UploadLocal {
    public static void main(String[] args) throws IOException {
        // 画像のパスを取得
        String filePath = System.getProperty("user.dir") + System.getProperty("file.separator") + "YOUR_IMAGE.jpg";
        File file = new File(filePath);

        // Base64 でエンコード
        String encodedFile;
        FileInputStream fileInputStreamReader = new FileInputStream(file);
        byte[] bytes = new byte[(int) file.length()];
        fileInputStreamReader.read(bytes);
        encodedFile = new String(Base64.getEncoder().encode(bytes), StandardCharsets.US_ASCII);

        String API_KEY = ""; // あなたの API キー
        String DATASET_NAME = "your-dataset"; // データセット名を設定（データセット URL にあります）

        // URL を構築
        String uploadURL =
                "https://api.roboflow.com/dataset/"+
                        DATASET_NAME + "/upload" +
                        "?api_key=" + API_KEY +
                        "&name=YOUR_IMAGE.jpg" +
                        "&split=train";

        // HTTP リクエスト
        HttpURLConnection connection = null;
        try {
            //URL への接続を設定
            URL url = new URL(uploadURL);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type",
                    "application/x-www-form-urlencoded");

            connection.setRequestProperty("Content-Length",
                    Integer.toString(encodedFile.getBytes().length));
            connection.setRequestProperty("Content-Language", "en-US");
            connection.setUseCaches(false);
            connection.setDoOutput(true);

            // リクエストを送信
            DataOutputStream wr = new DataOutputStream(
                    connection.getOutputStream());
            wr.writeBytes(encodedFile);
            wr.close();

            // レスポンスを取得
            InputStream stream = connection.getInputStream();
            BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
            reader.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}

URL 経由で別の場所にホストされた画像を追加：

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

public class UploadHosted {
    public static void main(String[] args) {
        String imageURL = "https://i.imgur.com/PEEvqPN.png"; // 画像 URL を置き換えてください
        String API_KEY = ""; // あなたの API キー
        String DATASET_NAME = "your-dataset"; // データセット名を設定（データセット URL にあります）

        // アップロード URL
        String uploadURL = "https://api.roboflow.com/dataset/" + DATASET_NAME + "/upload" + "?api_key=" + API_KEY
                + "&name=YOUR_IMAGE.jpg" + "&split=train" + "&image="
                + URLEncoder.encode(imageURL, StandardCharsets.UTF_8);

        // HTTP リクエスト
        HttpURLConnection connection = null;
        try {
            // URL への接続を設定
            URL url = new URL(uploadURL);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");

            connection.setRequestProperty("Content-Length", Integer.toString(uploadURL.getBytes().length));
            connection.setRequestProperty("Content-Language", "en-US");
            connection.setUseCaches(false);
            connection.setDoOutput(true);

            // リクエストを送信
            DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
            wr.writeBytes(uploadURL);
            wr.close();

            // レスポンスを取得
            InputStream stream = connection.getInputStream();
            BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
            reader.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}

Ruby

Gemfile

source "https://rubygems.org"

gem "httparty", "~> 0.18.1"
gem "base64", "~> 0.1.0"
gem "cgi", "~> 0.2.1"

Gemfile.lock

GEM
  remote: https://rubygems.org/
  specs:
    base64 (0.1.0)
    cgi (0.2.1)
    httparty (0.18.1)
      mime-types (~> 3.0)
      multi_xml (>= 0.5.2)
    mime-types (3.3.1)
      mime-types-data (~> 3.2015)
    mime-types-data (3.2021.0225)
    multi_xml (0.6.0)

PLATFORMS
  x64-mingw32
  x86_64-linux

DEPENDENCIES
  base64 (~> 0.1.0)
  cgi (~> 0.2.1)
  httparty (~> 0.18.1)

同梱バージョン
   2.2.15

base64 エンコード済み画像を使用してアップロード：

require 'base64'
require 'httparty'

encoded = Base64.encode64(File.open("YOUR_IMAGE.jpg", "rb").read)
dataset_name = "your-dataset" # データセット名を設定（データセット URL にあります）
api_key = "" # API キーをここに入力

params = "?api_key=" + api_key + 
"&name=YOUR_IMAGE.jpg" + 
"&split=train"

response = HTTParty.post(
    "https://api.roboflow.com/dataset/" + dataset_name + "/upload" + params,
    body: encoded, 
    headers: {
    'Content-Type' => 'application/x-www-form-urlencoded',
    'charset' => 'utf-8'
  })

  puts response

URL 経由で別の場所にホストされた画像を追加：

require 'httparty'
require 'cgi'

dataset_name = "your-dataset" # データセット名を設定（データセット URL にあります）
api_key = "" # API キーをここに入力
img_url = "https://i.imgur.com/PEEvqPN.png" # URLを構築

img_url = CGI::escape(img_url)

params = "?api_key=" + api_key + 
"&name=YOUR_IMAGE.jpg" + 
"&split=train" +
"&image=" + img_url

response = HTTParty.post(
    "https://api.roboflow.com/dataset/" + dataset_name + "/upload" + params,
    headers: {
    'Content-Type' => 'application/x-www-form-urlencoded',
    'charset' => 'utf-8'
  })

puts response

PHP

base64 エンコード済み画像を使用してアップロード：

<?php

// 画像をBase64エンコード
$data = base64_encode(file_get_contents("YOUR_IMAGE.jpg"));

$api_key = ""; // APIキーを設定
$dataset_name = "your-dataset"; // データセット名を設定（データセットURL内にあります）

// HTTPリクエスト用URL
$url = "https://api.roboflow.com/dataset/" 
. $dataset_name .  "/upload" 
.  "?api_key="  .  $api_key  
.  "&name=YOUR_IMAGE.jpg" 
. "&split=train";

// セットアップ + HTTPリクエスト送信
$options = array(
  'http' => array (
    'header' => "Content-type: application/x-www-form-urlencoded\r\n",
    'method'  => 'POST',
    'content' => $data
  ));

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;
?>

URL 経由で別の場所にホストされた画像を追加：

<?php

$api_key = ""; // APIキーを設定
$dataset_name = "your-dataset"; // データセット名を設定（データセットURL内にあります）
$img_url = "https://i.imgur.com/PEEvqPN.png";

// HTTPリクエスト用URL
$url = "https://api.roboflow.com/dataset/" 
. $dataset_name .  "/upload" 
.  "?api_key="  .  $api_key  
.  "&name=YOUR_IMAGE.jpg" 
. "&split=train" 
. "&image=" . urlencode($img_url);

// セットアップ + HTTPリクエスト送信
$options = array(
  'http' => array (
    'header' => "Content-type: application/x-www-form-urlencoded\r\n",
    'method'  => 'POST'
  ));

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;
?>

Go

base64 エンコード済み画像を使用してアップロード：

package main

import (
    "bufio"
    "encoding/base64"
    "fmt"
    "io/ioutil"
    "os"
	"net/http"
	"strings"
)

func main() {
	api_key := ""  // あなたのAPIキー
	dataset_name := "Your-Dataset" // データセット名を設定（データセットURL内にあります）

    // ディスク上のファイルを開く。
    f, _ := os.Open("YOUR_IMAGE.jpg")

    // JPG全体をバイトスライスに読み込む。
    reader := bufio.NewReader(f)
    content, _ := ioutil.ReadAll(reader)

    // Base64としてエンコード。
    data := base64.StdEncoding.EncodeToString(content)
	uploadURL := "https://api.roboflow.com/dataset/"+ dataset_name + "/upload"+
    "?api_key=" + api_key +
    "&name=YOUR_IMAGE.jpg" +
    "&split=train"

	res, _ := http.Post(uploadURL, "application/x-www-form-urlencoded", strings.NewReader(data))
    body, _ := ioutil.ReadAll(res.Body)
	fmt.Println(string(body))

}

URL 経由で別の場所にホストされた画像を追加：

package main

import (
    "fmt"
	"net/http"
	"net/url"
	"io/ioutil"

)

func main() {
	api_key := ""  // あなたのAPIキー
	dataset_name := "Your-Dataset" // データセット名を設定（データセットURL内にあります）
	img_url := "https://i.imgur.com/PEEvqPN.png"


	uploadURL := "https://api.roboflow.com/dataset/"+ dataset_name + "/upload"+
    "?api_key=" + api_key +
    "&name=YOUR_IMAGE.jpg" +
    "&split=train" + "&image=" + url.QueryEscape(img_url)

	res, _ := http.Post(uploadURL, "application/x-www-form-urlencoded", nil)
	body, _ := ioutil.ReadAll(res.Body)
    fmt.Println(string(body))


}

.NET

base64 エンコード済み画像を使用してアップロード：

using System;
using System.IO;
using System.Net;
using System.Text;

namespace UploadLocal
{
    class UploadLocal
    {

        static void Main(string[] args)
        {
            byte[] imageArray = System.IO.File.ReadAllBytes(@"YOUR_IMAGE.jpg");
            string encoded = Convert.ToBase64String(imageArray);
            byte[] data = Encoding.ASCII.GetBytes(encoded);
            string API_KEY = ""; // あなたのAPIキー
            string DATASET_NAME = "your-dataset"; // データセット名を設定（データセットURL内にあります）

            // URL を構築
            string uploadURL =
                    "https://api.roboflow.com/dataset/" +
                            DATASET_NAME + "/upload" +
                            "?api_key=" + API_KEY +
                            "&name=YOUR_IMAGE.jpg" +
                            "&split=train";

            // サービスリクエスト設定
            ServicePointManager.Expect100Continue = true;
            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;

            // リクエストを設定
            WebRequest request = WebRequest.Create(uploadURL);
            request.Method = "POST";
            request.ContentType = "application/x-www-form-urlencoded";
            request.ContentLength = data.Length;

            // データを書き込む
            using (Stream stream = request.GetRequestStream())
            {
                stream.Write(data, 0, data.Length);
            }

            // レスポンスを取得
            string responseContent = null;
            using (WebResponse response = request.GetResponse())
            {
                using (Stream stream = response.GetResponseStream())
                {
                    using (StreamReader sr99 = new StreamReader(stream))
                    {
                        responseContent = sr99.ReadToEnd();
                    }
                }
            }

            Console.WriteLine(responseContent);

        }
    }
}

URL 経由で別の場所にホストされた画像を追加：

using System;
using System.IO;
using System.Net;
using System.Web;

namespace UploadHosted
{
    class UploadHosted
    {
        static void Main(string[] args)
        {
            string API_KEY = ""; // あなたのAPIキー
            string DATASET_NAME = "your-dataset"; // データセット名を設定（データセットURL内にあります）
            string imageURL = "https://i.imgur.com/PEEvqPN.png";
            imageURL = HttpUtility.UrlEncode(imageURL);

            // URL を構築
            string uploadURL =
                    "https://api.roboflow.com/dataset/" +
                            DATASET_NAME + "/upload" +
                            "?api_key=" + API_KEY +
                            "&name=YOUR_IMAGE.jpg" +
                            "&split=train" +
                            "&image=" + imageURL;

            // サービスポイント設定
            ServicePointManager.Expect100Continue = true;
            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;

            // HTTPリクエストを設定
            WebRequest request = WebRequest.Create(uploadURL);
            request.Method = "POST";
            request.ContentType = "application/x-www-form-urlencoded";
            request.ContentLength = 0;

            // レスポンスを取得
            string responseContent = null;
            using (WebResponse response = request.GetResponse())
            {
                using (Stream stream = response.GetResponseStream())
                {
                    using (StreamReader sr99 = new StreamReader(stream))
                    {
                        responseContent = sr99.ReadToEnd();
                    }
                }
            }

            Console.WriteLine(responseContent);

        }
    }
}

Roboflowでアップロードされた画像を表示

API経由でアップロードされた画像は、 Annotate タブの 未割り当て 列にあり、 uploaded via API.

としてマークされています。 batch uploadパラメータを指定した場合でも、画像は引き続き Annotate タブに表示されますが、 uploaded via API バッチではなく、指定したバッチに入ります。

注釈をアップロードする

画像とともに既存の注釈がある場合、それらをRoboflowにアップロードできます。

これは、対応している注釈形式のいずれでも機能します。これらは、アップロードされた画像のファイル名を参照する注釈ファイルを使用します。

ご存じですか？ APIを使わずに、アプリのアップロードページで画像と一緒に注釈ファイルをドラッグ＆ドロップ（または選択）できます。

追加 prediction=true を追加すると、注釈を正解データではなくモデル予測として保存できます。画像がまだアップロードバッチ内にあり、まだ注釈ジョブに入っていない場合、RoboflowはそのバッチのReviewジョブに移動します。

追加 predictionRouting=unassigned を使うと、その移動をスキップできます。注釈は保存され、画像も注釈済みとしてマークされますが、バッチ内に残り、未割り当てのままです。 predictionRouting=review を使うと、デフォルトのルーティングを指定できます。両方の値には prediction=trueが必要で、 jobName.

例

次を添付する VOC XML注釈をID abc123 の your-dataset というデータセットに YOUR_ANNOTATION.xml:

cat YOUR_ANNOTATION.xml | curl -d @- \\
"https://api.roboflow.com/dataset/your-dataset/annotate/abc123?\\
api_key=YOUR_KEY&\\
name=YOUR_ANNOTATION.xml"

次を添付する Darknet TXT注釈をID abc123 の your-dataset というデータセットに YOUR_ANNOTATION.txt jsonラベルマップを使用しています。この場合、注釈ファイルの内容を、そのまま本文として送るのではなく、jsonで送信する必要があります。

#!/bin/bash
# 注釈をjson互換の文字列として保存
txt_content=$(cat YOUR_ANNOTATION.txt | sed 's/\\/\\\\/g; s/"/\\"/g; s/$/\\n/' | tr -d '\n')
# 注釈ファイルとラベルマップ [0=flower, 1=leaf] を含むjson文字列を作成
json_payload="{ \"annotationFile\": \"$txt_content\", \"labelmap\":{\"0\":\"flower\", \"1\":\"leaf\"} }"

# 注釈 + ラベルマップをアップロード
echo $json_payload | curl -H "Content-Type: application/json" -d @- \\
"https://api.roboflow.com/dataset/cultura-pepino-dark/annotate/abc123?\\
api_key=YOUR_KEY&\\
name=YOUR_ANNOTATION.txt"

この例では axios この例で POST リクエストを実行するために使用するので、まず npm install axios 依存関係をインストールしてください。

ローカル画像をアップロードする

const axios = require("axios");
const fs = require("fs");

const filename = "YOUR_ANNOTATION.xml";
const annotation = fs.readFileSync(filename, "utf-8");

axios({
    method: "POST",
    url: "https://api.roboflow.com/dataset/your-dataset/annotate/abc123",
    params: {
        api_key: "YOUR_KEY",
        name: filename
    },
    data: annotation,
    headers: {
        "Content-Type": "text/plain"
    }
})
.then(function(response) {
    console.log(response.data);
})
.catch(function(error) {
    console.log(error.message);
});

Kotlin

base64 エンコード済み画像を使用してアップロード：

import java.io.*
import java.net.HttpURLConnection
import java.net.URL
import java.nio.charset.StandardCharsets
import java.util.*

fun main() {
    // 画像のパスを取得
    val filePath = System.getProperty("user.dir") + System.getProperty("file.separator") + "YOUR_IMAGE.jpg"
    val file = File(filePath)

    // Base64 でエンコード
    val encodedFile: String
    val fileInputStreamReader = FileInputStream(file)
    val bytes = ByteArray(file.length().toInt())
    fileInputStreamReader.read(bytes)
    encodedFile = String(Base64.getEncoder().encode(bytes), StandardCharsets.US_ASCII)
    val API_KEY = "" // あなたの API キー
    val DATASET_NAME = "your-dataset" // データセット名を設定（データセット URL にあります）

    // URL を構築
    val uploadURL = "https://api.roboflow.com/dataset/" +
            DATASET_NAME + "/upload" +
            "?api_key=" + API_KEY +
            "&name=YOUR_IMAGE.jpg" +
            "&split=train"

    // HTTP リクエスト
    var connection: HttpURLConnection? = null
    try {
        // URL への接続を設定
        val url = URL(uploadURL)
        connection = url.openConnection() as HttpURLConnection
        connection.requestMethod = "POST"
        connection.setRequestProperty("Content-Type",
                "application/x-www-form-urlencoded")
        connection.setRequestProperty("Content-Length",
                Integer.toString(encodedFile.toByteArray().size))
        connection.setRequestProperty("Content-Language", "en-US")
        connection.useCaches = false
        connection.doOutput = true

        // リクエストを送信
        val wr = DataOutputStream(
                connection.outputStream)
        wr.writeBytes(encodedFile)
        wr.close()

        // レスポンスを取得
        val stream = connection.inputStream
        val reader = BufferedReader(InputStreamReader(stream))
        var line: String?
        while (reader.readLine().also { line = it } != null) {
            println(line)
        }
        reader.close()
    } catch (e: Exception) {
        e.printStackTrace()
    } finally {
        connection?.disconnect()
    }
}
main()

URL 経由で別の場所にホストされた画像を追加：

import java.io.BufferedReader
import java.io.DataOutputStream
import java.io.InputStreamReader
import java.net.HttpURLConnection
import java.net.URL
import java.net.URLEncoder
import java.nio.charset.StandardCharsets

fun main() {
    val imageURL = "https://i.imgur.com/PEEvqPN.png" // 画像 URL を置き換えてください
    val API_KEY = "" // あなたの API キー
    val DATASET_NAME = "your-dataset" // データセット名を設定（データセット URL にあります）

    // アップロード URL
    val uploadURL = ("https://api.roboflow.com/dataset/" + DATASET_NAME + "/upload" + "?api_key=" + API_KEY
            + "&name=YOUR_IMAGE.jpg" + "&split=train" + "&image="
            + URLEncoder.encode(imageURL, "utf-8"))

    // HTTP リクエスト
    var connection: HttpURLConnection? = null
    try {
        // URL への接続を設定
        val url = URL(uploadURL)
        connection = url.openConnection() as HttpURLConnection
        connection.requestMethod = "POST"
        connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded")
        connection.setRequestProperty("Content-Length", Integer.toString(uploadURL.toByteArray().size))
        connection.setRequestProperty("Content-Language", "en-US")
        connection.useCaches = false
        connection.doOutput = true

        // リクエストを送信
        val wr = DataOutputStream(connection.outputStream)
        wr.writeBytes(uploadURL)
        wr.close()

        // レスポンスを取得
        val stream = connection.inputStream
        val reader = BufferedReader(InputStreamReader(stream))
        var line: String?
        while (reader.readLine().also { line = it } != null) {
            println(line)
        }
        reader.close()
    } catch (e: Exception) {
        e.printStackTrace()
    } finally {
        connection?.disconnect()
    }
}

main()

Android（Java）

base64 エンコード済み画像を使用してアップロード：

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.Base64;

public class UploadLocal {
    public static void main(String[] args) throws IOException {
        // 画像のパスを取得
        String filePath = System.getProperty("user.dir") + System.getProperty("file.separator") + "YOUR_IMAGE.jpg";
        File file = new File(filePath);

        // Base64 でエンコード
        String encodedFile;
        FileInputStream fileInputStreamReader = new FileInputStream(file);
        byte[] bytes = new byte[(int) file.length()];
        fileInputStreamReader.read(bytes);
        encodedFile = new String(Base64.getEncoder().encode(bytes), StandardCharsets.US_ASCII);

        String API_KEY = ""; // あなたの API キー
        String DATASET_NAME = "your-dataset"; // データセット名を設定（データセット URL にあります）

        // URL を構築
        String uploadURL =
                "https://api.roboflow.com/dataset/"+
                        DATASET_NAME + "/upload" +
                        "?api_key=" + API_KEY +
                        "&name=YOUR_IMAGE.jpg" +
                        "&split=train";

        // HTTP リクエスト
        HttpURLConnection connection = null;
        try {
            //URL への接続を設定
            URL url = new URL(uploadURL);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type",
                    "application/x-www-form-urlencoded");

            connection.setRequestProperty("Content-Length",
                    Integer.toString(encodedFile.getBytes().length));
            connection.setRequestProperty("Content-Language", "en-US");
            connection.setUseCaches(false);
            connection.setDoOutput(true);

            // リクエストを送信
            DataOutputStream wr = new DataOutputStream(
                    connection.getOutputStream());
            wr.writeBytes(encodedFile);
            wr.close();

            // レスポンスを取得
            InputStream stream = connection.getInputStream();
            BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
            reader.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}

URL 経由で別の場所にホストされた画像を追加：

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

public class UploadHosted {
    public static void main(String[] args) {
        String imageURL = "https://i.imgur.com/PEEvqPN.png"; // 画像 URL を置き換えてください
        String API_KEY = ""; // あなたの API キー
        String DATASET_NAME = "your-dataset"; // データセット名を設定（データセット URL にあります）

        // アップロード URL
        String uploadURL = "https://api.roboflow.com/dataset/" + DATASET_NAME + "/upload" + "?api_key=" + API_KEY
                + "&name=YOUR_IMAGE.jpg" + "&split=train" + "&image="
                + URLEncoder.encode(imageURL, StandardCharsets.UTF_8);

        // HTTP リクエスト
        HttpURLConnection connection = null;
        try {
            // URL への接続を設定
            URL url = new URL(uploadURL);
            connection = (HttpURLConnection) url.openConnection();
            connection.setRequestMethod("POST");
            connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");

            connection.setRequestProperty("Content-Length", Integer.toString(uploadURL.getBytes().length));
            connection.setRequestProperty("Content-Language", "en-US");
            connection.setUseCaches(false);
            connection.setDoOutput(true);

            // リクエストを送信
            DataOutputStream wr = new DataOutputStream(connection.getOutputStream());
            wr.writeBytes(uploadURL);
            wr.close();

            // レスポンスを取得
            InputStream stream = connection.getInputStream();
            BufferedReader reader = new BufferedReader(new InputStreamReader(stream));
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
            reader.close();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (connection != null) {
                connection.disconnect();
            }
        }
    }
}

画像の詳細を取得する

REST APIを使用して、特定の画像の詳細を取得できます。

特定の画像の詳細を取得するには、次のAPIエンドポイントにGETリクエストを送信します。

https://api.roboflow.com/:workspace/:project/images/:image_id

以下は、画像の詳細を取得するためのAPIリクエストの例です

curl -X GET "https://api.roboflow.com/my-workspace/my-project-name/images/image-id?api_key=$ROBOFLOW_API_KEY" \\
-H 'Content-Type: application/json'

このエンドポイントは、画像に関する以下の情報を含むJSONオブジェクトを返します:

{
    "image":
        "id": string,
        "name": string,
        "annotation": {
            "key": string,
            "width": number,
            "height": number,
            "boxes": Array<{
                "label": string,
                "x": number,
                "y": number,
                "width": number,
                "height": number
            }>
        },
        "labels": string[],
        "split": string,
        "tags": string[],
        "created": number,
        "urls": {
            "original": string,
            "thumb": string,
            "annotation": string
        },
        "embedding": number[]
    }
}

データセットから画像を削除する

REST APIを使用して、データセットから画像を削除できます。

データセットから画像を削除するには、次のAPIエンドポイントにDELETEリクエストを送信し、エンドポイントに画像IDを渡します。

https://api.roboflow.com/:workspace/:project/images

以下は、画像を削除するためのAPIリクエストの例です

curl "https://api.roboflow.com/my-workspace/my-project/images?api_key=$ROBOFLOW_API_KEY" \\
  -X DELETE \\
  -H "Content-Type: application/json" \\
  -d '{"images": ["1", "2"]}'

このエンドポイントは、操作が成功すると204ステータスを返します。

画像タグの一覧取得、追加、削除

REST APIを使用して、Roboflow上の特定の画像にタグを付けることができます

Roboflowでホストされている画像にタグを追加、削除、設定するには、次のAPIエンドポイントにPOSTリクエストを送信します。画像名に関連付けられた画像IDを取得するには検索APIを使用します:

https://api.roboflow.com/:workspace/:project/images/:image_id/tags

以下はAPIリクエストの例です（タグの"add"、"remove"、"set"が可能です）:

curl -X POST "https://api.roboflow.com/my-workspace/my-project-name/images/image-id/tags?api_key=$ROBOFLOW_API_KEY" \\
-H 'Content-Type: application/json' \\
--data \\
'{
    "operation": "add",
    "tags": "image_tag_test"
}'

このエンドポイントは、POST本文で次の値を受け付けます:

{
     // // オプションは ["add", "remove", "set"]
     "operation": string,
     
     // タグの文字列配列
     "tags": string[],
     
}

APIは、Roboflow内の指定した画像にタグを追加します（POSTリクエストには画像名ではなく画像IDを渡すことを忘れないでください）。

画像メタデータとタグを更新する

REST APIを使用して、ワークスペース内の画像にカスタムメタデータとタグを書き込むことができます。エンドポイントは2つあります。1つは単一画像を同期的に更新するもの、もう1つは最大1,000枚の画像をバッチで更新するものです。

どちらのエンドポイントも、 image:tag スコープを持つAPIキーが必要です。

リクエスト本文

どちらのエンドポイントも同じフィールドを受け付けます（バッチエンドポイントはそれらを updates 配列にまとめます）:

- imageId (string) - 本文のバッチ更新では必須、単一更新ではパスから推定されます
- metadata (object) - 画像のユーザーメタデータに設定するキーと値のペア。
- removeMetadata (string[]) - 画像から削除するメタデータキー。
- addTags (string[]) - 画像に追加するタグ。
- removeTags (string[]) - 画像から削除するタグ。

これらのフィールドのうち少なくとも1つを含める必要があります。同じリクエスト内で、同じメタデータキーまたはタグを設定と削除の両方に使うことはできません。 _rf_internal_ で始まるメタデータキーはRoboflow用に予約されており、拒否されます。

単一画像

単一画像のメタデータとタグを更新します。

POST https://api.roboflow.com/:workspace/images/:image/metadata?api_key=YOUR_API_KEY

例

curl -X POST "https://api.roboflow.com/my-workspace/images/abc123/metadata?api_key=$ROBOFLOW_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "metadata": { "camera": "front", "blur_score": 0.8 },
    "addTags": ["reviewed"]
  }'

レスポンス

{
    "success": true
}

バッチ更新

複数画像のメタデータとタグを非同期で更新します。1回のリクエストで最大1,000枚まで受け付けます。

POST https://api.roboflow.com/:workspace/images/metadata?api_key=YOUR_API_KEY

例

curl -X POST "https://api.roboflow.com/my-workspace/images/metadata?api_key=$ROBOFLOW_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "updates": [
      {
        "imageId": "abc123",
        "metadata": { "camera": "front" },
        "addTags": ["reviewed"]
      },
      {
        "imageId": "def456",
        "removeTags": ["needs-review"]
      }
    ]
  }'

レスポンス

返される内容 202 task ID付きで返されます。進捗を確認するにはタスクURLをポーリングしてください。

{
    "taskId": "task-id-here",
    "url": "https://api.roboflow.com/my-workspace/asynctasks/task-id-here"
}

参照 Async Tasks でタスク状態をポーリングする方法を確認してください。

エラー

- 400 - 空の本文、形式不正のフィールド型、または競合するフィールド（例: metadata と removeMetadata の両方に同じキー）。
- 404 - ワークスペース内に画像が見つからない（単一画像エンドポイントのみ）。

Python SDK

Project は、バルクの upload_dataset フローを補完する、画像ごとの操作を提供します。単一画像のアップロードをより細かく制御したいとき、後から注釈を付けたいとき、またはストリームから1枚ずつ画像を取り込みたいときに使います。

画像をアップロードする（任意の注釈付き）

Project.upload() は、最上位の「適切にやってくれる」ヘルパーです。単一画像と任意の対応する注釈ファイルを受け取り、両方を1回の呼び出しでプロジェクトに送信します。

import roboflow

rf = roboflow.Roboflow(api_key="YOUR_API_KEY")
project = rf.workspace().project("my-detector")

result = project.upload(
    image_path="./photo.jpg",
    annotation_path="./photo.xml",   # 任意; 対応するVOC / COCO / などの注釈
    split="train",                    # train | valid | test
    batch_name="ingest-2026-05",     # 任意; アップロードをWeb UIでグループ化
    tag_names=["camera-A", "indoor"], # 任意; タグを適用
    is_prediction=False,              # モデル生成の注釈をレビュー待ちとして True に設定
    num_retry_uploads=2,              # 一時的なアップロード失敗時に再試行
)
print(result)

single_upload() は、同じ引数を受け取り、画像と（指定した場合は）注釈の両方について生のAPIレスポンスを返す、低レベル版です。

画像のみをアップロードする

project.upload_image(
    image_path="./photo.jpg",
    split="train",
    batch_name="ingest-2026-05",
    tag_names=["camera-A"],
)

注釈がまだ存在しない場合や、画像をそのままラベラーに渡す場合に便利です。

アップロード前に画像を検証する

check_valid_image() は、APIにアクセスせずにRoboflowのローカルなサイズ/形式チェックを実行します:

if project.check_valid_image("./photo.jpg"):
    project.upload_image("./photo.jpg")

既存の画像に注釈を添付する

save_annotation() プロジェクト内にすでにある画像に対してアノテーションを投稿します。別の場所で作成したラベルを追加したり、モデルの予測を正解データに昇格させたりするのに便利です。

project.save_annotation(
    image_id="<image-id>",
    annotation_path="./photo.xml",
    is_prediction=False,
    annotation_overwrite=True,    # 既存のアノテーションを置き換える
)

指定してください annotation_labelmap="./labelmap.yaml" アノテーション形式で必要な場合は、クラスインデックスをクラス名にマッピングするために使用します。

〜で保存すると is_prediction=True 画像をレビュージョブへ移動できます。参照: 予測が配置される場所.

画像のメタデータを取得する

info = project.image("<image-id>")
print(info["name"], info["split"], info["annotations"])

画像のメタデータ、現在の分割、アノテーションの状態を返します。

画像を削除する

プロジェクト単位（このプロジェクトに属する画像のみを削除します）:

project.delete_images(["<image-id-1>", "<image-id-2>"])

ワークスペース単位（どのプロジェクトから参照されていても画像を削除します。注意して使用してください）:

workspace.delete_images(["<image-id-1>", "<image-id-2>"])

v1.3.6以降のアップロードに関する注意

roboflow roboflow 1.3.6では、SDKはPillowで再エンコードするのではなく、元の画像バイト列をアップロードします。これによりWebアップローダーとの整合性が戻り、RoboflowサーバーはSHA-256によってアップロードを重複排除できるようになります。同じ画像を2回アップロードする自動化処理がある場合（たとえば複数のバッチに追加するため）、2回目のアップロードは追加のストレージクレジットを消費せずに成功します。

CLI

CLIを使用して、1枚の画像と、任意のアノテーション、タグ、またはメタデータをアップロードします。

roboflow image upload photo.jpg -p PROJECT_ID

オプション

フラグ

説明

-p, --project

プロジェクトID（必須）

-a, --annotation

アノテーションファイルへのパス

-m, --labelmap

ラベルマップファイルへのパス

-s, --split

データセットの分割: train, valid、または test。デフォルトは train.

-t, --tag

カンマ区切りのタグ名

-M, --metadata

JSON文字列としてのメタデータ

--is-prediction

アップロードを予測としてマークします

-b, --batch

バッチ名

例

アノテーション付きで画像をアップロードする:

roboflow image upload photo.jpg -p my-project -a annotation.xml -s valid

タグとメタデータ付きで画像をアップロードする:

roboflow image upload photo.jpg -p my-project -t "outdoor,daytime" -M '{"camera_id":"cam001"}'

ディレクトリまたは .zip アーカイブについては、参照してくださいデータセットをアップロード.

前へデータセットのクラスを設定次へプロジェクトフォルダ

最終更新 3 日前

役に立ちましたか？