Platform API OpenAPI
Roboflow Platform リソースの HTTP API を閲覧・テストします。
Platform API は次で使用します https://api.roboflow.com ワークスペース、プロジェクト、データセット、トレーニング、Workflows、および関連リソースを管理します。
Roboflow API キーで認証します Authorization: Bearer ヘッダーまたは api_key クエリパラメータ。参照 REST API で認証する.
モデルおよび Workflow 実行エンドポイントについては、以下を参照してください。 Inference Server OpenAPI.
また ソースの OpenAPI ドキュメントをダウンロードできます.
ワークスペースとプロジェクト
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET / HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/projects HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/projects/fork HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/health HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/models HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}API キー
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/api-keys HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/api-keys HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/api-keys/publishable HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
API key ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
API key ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
PATCH /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
API key ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}プロジェクトフォルダ
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/groups HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/groups HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project folder ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/groups/{folderId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project folder ID.
Completed with no response body.
コンテンツなし
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/groups/{folderId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
コンテンツなし
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project folder ID.
Operation-specific JSON object. See the linked guide for defined fields.
Completed with no response body.
コンテンツなし
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
PATCH /{workspace}/groups/{folderId}/projects HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}コンテンツなし
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project folder ID.
Operation-specific JSON object. See the linked guide for defined fields.
Completed with no response body.
コンテンツなし
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/groups/{folderId}/projects HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}コンテンツなし
データセットのバージョンとトレーニング
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/generate HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/splits/rebalance HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Dataset export format.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version}/{format} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/train HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/train/cancel HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/train/stop HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version}/training/results HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version}/v2/trainings HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/v2/trainings HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version}/v2/trainings/get HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/{version}/v2/trainings/recipe HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/v2/trainings/cancel HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/{version}/v2/trainings/stop HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Dataset version number.
Training run ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/{project}/{version}/v2/trainings/{trainingId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}画像とバッチ
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
A host Roboflow had to call failed. The response sets "retryable": true.
POST /dataset/{project}/upload HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Project URL slug.
Image ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /dataset/{project}/annotate/{imageId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Image ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/images/{imageId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Completed with no response body.
コンテンツなし
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/{project}/images HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}コンテンツなし
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Image ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/images/{imageId}/tags HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Image ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/images/{imageId}/metadata HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/images/metadata HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/batches HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Image batch ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/batches/{batchId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/upload/zip HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Asynchronous task ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/upload/zip/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}アノテーション
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/jobs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/jobs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Job ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Lists the Auto Label foundation models, with the credits each uses per image and whether the workspace plan includes it. Each model id is accepted as the modelType when you start a job or run a preview.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/autolabel/models HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Runs one image through an Auto Label foundation model and returns the predictions with a per-class summary. Previews are free and do not create a job.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/autolabel/preview HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/autolabel HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Job ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/autolabel/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Workflows
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/workflows HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Workflow URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Workflow URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
DELETE /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Workflow URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/workflows/{workflowId}/versions HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/createWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/updateWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/forkWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/workflowToken HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}エージェント
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/agent/chat HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Workflow URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/agent/workflows/{workflowId}/publish HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/agent/conversations HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Conversation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/agent/conversations/{conversationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}検索
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /universe/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /universe/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Searches the images in one project. An API key from the project's workspace can search any of its projects. An API key from another workspace can search public projects only.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid, or the project does not belong to this workspace.
The credential does not have access to this resource.
The project does not exist, or it is private and the API key is from another workspace.
The request rate is too high.
POST /{workspace}/{project}/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Searches the images across a workspace. The API key must belong to this workspace. Keys from other workspaces cannot search it, even when it has public projects.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The workspace does not exist, or the API key is from another workspace.
The request rate is too high.
POST /{workspace}/search/v1 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Accepted for asynchronous processing.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/search/export HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Asynchronous task ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/search/export/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}ゴミ箱とタスク
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/trash HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/trash/restore HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Asynchronous task ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/asynctasks/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}デプロイ
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/deploy HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/deploy/model HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/deploy/active-learning HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/deploy/active-learning/enable HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/deploy/active-learning/disable HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/{project}/deploy/active-learning/configuration HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/{project}/deploy/active-learning/images HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}モニタリング
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/inference-stats HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/inference-stats/metadata HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Vision Events
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/batch HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/upload HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/query HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/delete HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Vision Events use case ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /vision-events/custom-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /vision-events/use-cases HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/use-cases HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Vision Events use case ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
PUT /vision-events/use-cases/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Vision Events use case ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/use-cases/{useCaseId}/archive HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Vision Events use case ID.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /vision-events/use-cases/{useCaseId}/unarchive HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}デプロイメントマネージャー
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Created.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/default-config HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/config HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/config/history HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/streams HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Device stream ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/streams/{streamId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/logs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/telemetry HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/events HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/services HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Service name, as declared in the device config.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/services/{serviceName} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Deployment Manager device ID.
Service name, as declared in the device config.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/devices/v2/{deviceId}/services/{serviceName}/series HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}モデル評価
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}Compare models on one Dataset Version. The operation includes models that have no evaluation. It is read-only and does not start evaluations.
Roboflow API key or OAuth access token.
Workspace URL slug.
Project URL slug.
chess-piecesPositive Dataset Version number.
131Pattern: ^[1-9][0-9]*$Metric used to calculate the Pareto frontier. The response lists supported choices in availableMetrics.
mAP5095可能な値: Successful response.
Project URL slug.
Dataset Version number.
Metric used to calculate onFrontier. Null when the Project type has no supported default metric.
A required parameter is missing, malformed, or unsupported for this comparison.
Authentication is missing or invalid.
The Workspace does not have Model Evaluation access.
The Project or Version is missing or inaccessible. API-key scope failures can also return this status.
The request rate is too high.
GET /{workspace}/model-evals/compare?project=text&version=text HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"project": "chess",
"version": "131",
"frontierMetric": "mAP5095",
"availableMetrics": [
"mAP",
"mAP5095",
"mAP75",
"precision",
"recall",
"f1"
],
"models": [
{
"modelId": "acme/chess-fast",
"evaluationId": "eval-fast",
"metrics": {
"mAP": 0.84,
"mAP5095": 0.61,
"mAP75": 0.68,
"f1": 0.79,
"precision": 0.82,
"recall": 0.76
},
"medianLatencyMs": 3,
"onFrontier": true,
"exclusionReason": null
},
{
"modelId": "acme/chess-new",
"evaluationId": null,
"metrics": {},
"medianLatencyMs": null,
"onFrontier": false,
"exclusionReason": "evaluation_unavailable"
}
]
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/map-results HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/confidence-sweep HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/performance-by-class HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/confusion-matrix HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/vector-analysis HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/image-predictions HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Model evaluation ID.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
GET /{workspace}/model-evals/{evaluationId}/recommendations HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}請求
This operation is part of the public Roboflow Platform API.
Roboflow API key or OAuth access token.
Workspace URL slug.
Operation-specific JSON object. See the linked guide for defined fields.
Successful response.
Operation-specific JSON object. See the linked guide for defined fields.
The request is invalid.
Authentication is missing or invalid.
The credential does not have access to this resource.
The resource does not exist or is not accessible.
The request rate is too high.
POST /{workspace}/billing-usage-report HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"ANY_ADDITIONAL_PROPERTY": "anything"
}最終更新
役に立ちましたか？