API Reference

Batch Processing エンドポイントの REST API リファレンスです。

クイックリンク:

データを取り込む（動画、単一画像、画像）
バッチステータスを確認（アイテム数、シャードの詳細）
ジョブを開始
ジョブの進行状況を監視（ジョブステータス、ステージ、タスク）
結果をエクスポート（出力パーツ、ダウンロードURL）
Webhook通知

データを取り込む

動画をアップロード

Upload a video

post

Request a signed URL to upload a video file. After receiving the response, PUT the video to the uploadURL with the provided extensionHeaders.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

fileNamestring必須

Name of the video file (e.g. my_video.mp4).

レスポンス

200

Signed URL details for uploading the video.

application/json

statusstringオプションExample: ok

post/data-staging/v1/external/{workspace}/batches/{batch_id}/upload/video

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/upload/video?api_key=text&fileName=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Signed URL details for uploading the video.

{
  "status": "ok",
  "signedURLDetails": {
    "uploadURL": "text",
    "method": "PUT",
    "extensionHeaders": {
      "Content-Type": "application/octet-stream",
      "x-goog-content-length-range": "1,1073741824"
    },
    "maxFileSize": 1073741824
  }
}

画像をアップロード

Upload a single image

post

Upload a single image via multipart form data. Best for batches up to 5,000 images.

Note: Single-image and bulk uploads cannot be combined for the same batch.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

fileNamestring必須

Name of the image file.

本文

filestring · binaryオプション

The image file to upload.

レスポンス

200

Image uploaded successfully.

application/json

statusstringオプションExample: ok

post/data-staging/v1/external/{workspace}/batches/{batch_id}/upload/image

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/upload/image?api_key=text&fileName=text HTTP/1.1
Host: api.roboflow.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

200

Image uploaded successfully.

{
  "status": "ok"
}

画像を一括アップロード

Bulk upload images

post

Request a signed URL for uploading a .tar archive of images. Recommended for batches exceeding 5,000 images. Bundle up to 500 images per archive.

The response contains a signed URL and extension headers. Pack images into a .tar archive and PUT it to the signed URL.

Note: Bulk and single-image uploads cannot be combined for the same batch.

When performing bulk ingestion, data is indexed in the background. There may be a short delay before all data is available.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

レスポンス

200

Signed URL details for uploading a tar archive.

application/json

statusstringオプションExample: ok

post/data-staging/v1/external/{workspace}/batches/{batch_id}/bulk-upload/image-files

POST /data-staging/v1/external/{workspace}/batches/{batch_id}/bulk-upload/image-files?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Signed URL details for uploading a tar archive.

{
  "status": "ok",
  "signedURLDetails": {
    "shardId": "123e4567-e89b-12d3-a456-426614174000",
    "uploadURL": "text",
    "method": "PUT",
    "extensionHeaders": {
      "Content-Type": "application/x-tar",
      "x-goog-content-length-range": "1,536870912"
    },
    "maxNumberOfImages": 500,
    "maxShardSize": 536870912
  }
}

バッチステータスを確認

Get batch item count

get

Returns the count of ingested items in a batch. Use this to verify all data has been ingested before starting a job.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

レスポンス

200

Batch item count.

application/json

statusstringオプションExample: ok

countintegerオプション

Number of items in the batch.

Example: 42

get/data-staging/v1/external/{workspace}/batches/{batch_id}/count

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/count?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Batch item count.

{
  "status": "ok",
  "count": 42
}

シャードのアップロード詳細を確認

List batch shards

get

Returns shard details for a bulk-upload batch. Paginated — use nextPageToken from the response to fetch subsequent pages.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

nextPageTokenstringオプション

Pagination token from a previous response.

レスポンス

200

Paginated list of batch shards.

application/json

statusstringオプションExample: ok

shardsobject[]オプション

List of shard objects.

nextPageTokenstring · ヌル許容オプション

Token for fetching the next page of results. null if no more pages.

get/data-staging/v1/external/{workspace}/batches/{batch_id}/shards

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/shards?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Paginated list of batch shards.

{
  "status": "ok",
  "shards": [
    {}
  ],
  "nextPageToken": "text"
}

ジョブを開始

Start a batch processing job

post

Start a batch processing job that runs a Workflow against staged data.

Job ID constraints: Lowercase letters, digits, hyphens, and underscores only. Maximum 20 characters.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

job_idstring · 最大: 20必須

Job identifier. Lowercase, max 20 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

本文

typestring · enum必須

Job type.

可能な値:

processingTimeoutSecondsintegerオプション

Maximum cumulative machine runtime in seconds across all parallel workers.

Default: 3600

notificationsURLstring · uriオプション

Webhook URL for job completion notifications. Custom webhook headers are not yet supported. The only header sent is Authorization: Bearer rf_{workspace_id}.

レスポンス

200

Job started successfully.

application/json

statusstringオプションExample: ok

post/batch-processing/v1/external/{workspace}/jobs/{job_id}

POST /batch-processing/v1/external/{workspace}/jobs/{job_id}?api_key=text HTTP/1.1
Host: api.roboflow.com
Content-Type: application/json
Accept: */*
Content-Length: 415

{
  "type": "simple-image-processing-v1",
  "jobInput": {
    "type": "staging-batch-input-v1",
    "batchId": "text"
  },
  "computeConfiguration": {
    "type": "compute-configuration-v2",
    "machineType": "cpu",
    "workersPerMachine": 4
  },
  "processingTimeoutSeconds": 3600,
  "processingSpecification": {
    "type": "workflows-processing-specification-v1",
    "workspace": "text",
    "workflowId": "text",
    "aggregationFormat": "jsonl"
  },
  "notificationsURL": "https://example.com"
}

200

Job started successfully.

{
  "status": "ok"
}

ジョブの進行状況を監視

ジョブステータスを取得

Get job status

get

Returns the current status of a batch processing job.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

job_idstring · 最大: 20必須

Job identifier. Lowercase, max 20 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

レスポンス

200

Job status details.

application/json

statusstringオプションExample: ok

jobStatusstringオプション

Current job status (e.g. pending, processing, completed, failed).

progressnumberオプション

Processing progress as a fraction between 0 and 1.

get/batch-processing/v1/external/{workspace}/jobs/{job_id}

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Job status details.

{
  "status": "ok",
  "jobStatus": "text",
  "progress": 1
}

ジョブのステージを一覧表示

List job stages

get

Returns the list of stages for a job. Each job typically has processing and export stages, each producing an output batch.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

job_idstring · 最大: 20必須

Job identifier. Lowercase, max 20 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

レスポンス

200

List of job stages.

application/json

statusstringオプションExample: ok

stagesobject[]オプション

List of stage objects. Each stage has an ID and an output batch ID.

get/batch-processing/v1/external/{workspace}/jobs/{job_id}/stages

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}/stages?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

List of job stages.

{
  "status": "ok",
  "stages": [
    {}
  ]
}

ステージのタスクを一覧表示

List tasks for a stage

get

Returns the list of tasks for a specific job stage. Paginated — use nextPageToken from the response to fetch subsequent pages.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

job_idstring · 最大: 20必須

Job identifier. Lowercase, max 20 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

stage_idstring必須

The stage identifier.

クエリパラメータ

api_keystring必須

Your Roboflow API key.

nextPageTokenstringオプション

Pagination token from a previous response.

レスポンス

200

Paginated list of tasks.

application/json

statusstringオプションExample: ok

tasksobject[]オプション

List of task objects.

nextPageTokenstring · ヌル許容オプション

Token for fetching the next page of results. null if no more pages.

get/batch-processing/v1/external/{workspace}/jobs/{job_id}/stages/{stage_id}/tasks

GET /batch-processing/v1/external/{workspace}/jobs/{job_id}/stages/{stage_id}/tasks?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Paginated list of tasks.

{
  "status": "ok",
  "tasks": [
    {}
  ],
  "nextPageToken": "text"
}

結果をエクスポート

出力パーツを一覧表示

List output batch parts

get

Lists the parts of an output batch. Use the export stage output batch for compressed results.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

レスポンス

200

List of batch parts.

application/json

statusstringオプションExample: ok

get/data-staging/v1/external/{workspace}/batches/{batch_id}/parts

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/parts?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

List of batch parts.

{
  "status": "ok",
  "parts": [
    {
      "partName": "text"
    }
  ]
}

ダウンロードURLを一覧表示

List download URLs

get

Returns paginated download URLs for files in a batch part.

パスパラメータ

workspacestring必須

Your Roboflow workspace identifier.

batch_idstring · 最大: 64必須

Batch identifier. Lowercase, max 64 chars: letters, digits, hyphens, underscores.

Pattern: ^[a-z0-9_-]+$

クエリパラメータ

api_keystring必須

Your Roboflow API key.

nextPageTokenstringオプション

Pagination token from a previous response.

partNamestringオプション

Filter by part name (from the list parts response).

レスポンス

200

Paginated list of download URLs.

application/json

statusstringオプションExample: ok

nextPageTokenstring · ヌル許容オプション

Token for fetching the next page of results. null if no more pages.

get/data-staging/v1/external/{workspace}/batches/{batch_id}/list

GET /data-staging/v1/external/{workspace}/batches/{batch_id}/list?api_key=text HTTP/1.1
Host: api.roboflow.com
Accept: */*

200

Paginated list of download URLs.

{
  "status": "ok",
  "filesMetadata": [
    {
      "downloadURL": "text",
      "fileName": "text",
      "partName": "text",
      "shardId": "text",
      "contentType": "text",
      "nestedContentType": "text"
    }
  ],
  "nextPageToken": "text"
}

Webhook通知

ステータスをポーリングする代わりに、Webhookを使用して、取り込みまたは処理が完了したときに通知を受け取ることができます。 CLI Usage Webhookの設定とペイロード形式については

前へアプリから Workflows を実行する次へCLI の使い方

最終更新 3 か月前

役に立ちましたか？