Platform API OpenAPI

Browse and test the HTTP API for Roboflow Platform resources.

Use the Platform API at https://api.roboflow.com to manage workspaces, projects, datasets, training, Workflows, and related resources.

Authenticate with a Roboflow API key in the Authorization: Bearer header or the api_key query parameter. See Authenticate with the REST API.

This is an initial reference for public Platform API operations documented on this site. Some request and response objects remain open because the Platform API does not yet publish complete machine-readable schemas.

For model and Workflow execution endpoints, see the Inference Server OpenAPI.

You can also download the source OpenAPI document.

Workspaces and projects

Verify credentials and get the authenticated workspace

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/

GET / HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a workspace and its projects

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}

GET /{workspace} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a project

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/projects

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"
}

Fork a Universe project

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/projects/fork

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"
}

Get a project and its versions

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}

GET /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Move a project to Trash

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/{project}

DELETE /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get dataset health metrics

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/health

GET /{workspace}/{project}/health HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List models for a project

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/models

GET /{workspace}/{project}/models HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a dataset version

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}

GET /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Move a dataset version to Trash

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/{project}/{version}

DELETE /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

API keys

List workspace API keys

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/api-keys

GET /{workspace}/api-keys HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a workspace API key

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/api-keys

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"
}

Get the workspace publishable API key

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/api-keys/publishable

GET /{workspace}/api-keys/publishable HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get an API key

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

keyIdstringRequired

API key ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/api-keys/{keyId}

GET /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Update an API key

patch

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

keyIdstringRequired

API key ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

patch/{workspace}/api-keys/{keyId}

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"
}

Revoke an API key

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

keyIdstringRequired

API key ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/api-keys/{keyId}

DELETE /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Project folders

List project folders

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/groups

GET /{workspace}/groups HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a project folder

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/groups

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"
}

Update a project folder

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

folderIdstringRequired

Project folder ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/groups/{folderId}

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"
}

Delete a project folder

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

folderIdstringRequired

Project folder ID.

Responses

204

Completed with no response body.

No content

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/groups/{folderId}

DELETE /{workspace}/groups/{folderId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Add or remove projects in a folder

patch

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

folderIdstringRequired

Project folder ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

204

Completed with no response body.

No content

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

patch/{workspace}/groups/{folderId}/projects

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"
}

No content

Remove projects from a folder

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

folderIdstringRequired

Project folder ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

204

Completed with no response body.

No content

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/groups/{folderId}/projects

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"
}

No content

Dataset versions and training

Generate a dataset version

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/generate

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"
}

Export a dataset version

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

formatstringRequired

Dataset export format.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}/{format}

GET /{workspace}/{project}/{version}/{format} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Start a training job

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/train

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"
}

Cancel a queued training job

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/train/cancel

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"
}

Stop an active training job

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/train/stop

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"
}

Get training results

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}/training/results

GET /{workspace}/{project}/{version}/training/results HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List training runs

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}/v2/trainings

GET /{workspace}/{project}/{version}/v2/trainings HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a training run

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/v2/trainings

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"
}

Get a training run

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}/v2/trainings/get

GET /{workspace}/{project}/{version}/v2/trainings/get HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get the accepted training recipe

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/{version}/v2/trainings/recipe

GET /{workspace}/{project}/{version}/v2/trainings/recipe HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Cancel a queued training run

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/v2/trainings/cancel

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"
}

Stop an active training run

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/{version}/v2/trainings/stop

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"
}

Move a training run to Trash

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

versioninteger · min: 1Required

Dataset version number.

trainingIdstringRequired

Training run ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/{project}/{version}/v2/trainings/{trainingId}

DELETE /{workspace}/{project}/{version}/v2/trainings/{trainingId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Images and batches

Upload an image

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/dataset/{project}/upload

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"
}

Upload an annotation

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

projectstringRequired

Project URL slug.

imageIdstringRequired

Image ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/dataset/{project}/annotate/{imageId}

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"
}

Get image details

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

imageIdstringRequired

Image ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/images/{imageId}

GET /{workspace}/{project}/images/{imageId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete images from a project

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

204

Completed with no response body.

No content

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/{project}/images

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"
}

No content

Add or remove image tags

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

imageIdstringRequired

Image ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/images/{imageId}/tags

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"
}

Update metadata and tags for one image

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

imageIdstringRequired

Image ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/images/{imageId}/metadata

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"
}

Update metadata and tags for multiple images

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/images/metadata

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"
}

List image batches

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/batches

GET /{workspace}/{project}/batches HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get an image batch

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

batchIdstringRequired

Image batch ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/batches/{batchId}

GET /{workspace}/{project}/batches/{batchId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Start a dataset ZIP upload

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/upload/zip

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"
}

Get dataset ZIP upload status

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

taskIdstringRequired

Asynchronous task ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/upload/zip/{taskId}

GET /{workspace}/upload/zip/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Annotation

List annotation jobs

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/jobs

GET /{workspace}/{project}/jobs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create an annotation job

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/jobs

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"
}

Get an annotation job

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

jobIdstringRequired

Job ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/jobs/{jobId}

GET /{workspace}/{project}/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create an Auto Label job

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/autolabel

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"
}

Get Auto Label job status

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

jobIdstringRequired

Job ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/autolabel/jobs/{jobId}

GET /{workspace}/autolabel/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Workflows

List Workflows

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/workflows

GET /{workspace}/workflows HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a Workflow

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

workflowIdstringRequired

Workflow URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/workflows/{workflowId}

GET /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Move a Workflow to Trash

delete

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

workflowIdstringRequired

Workflow URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

delete/{workspace}/workflows/{workflowId}

DELETE /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List Workflow versions

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

workflowIdstringRequired

Workflow URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/workflows/{workflowId}/versions

GET /{workspace}/workflows/{workflowId}/versions HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a Workflow

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/createWorkflow

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"
}

Update a Workflow

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/updateWorkflow

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"
}

Fork a Workflow

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/forkWorkflow

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"
}

Create a Workflow token

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/workflowToken

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"
}

Agent

Send a message to Roboflow Agent

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/agent/chat

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"
}

Publish a Workflow created by Roboflow Agent

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

workflowIdstringRequired

Workflow URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/agent/workflows/{workflowId}/publish

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"
}

List Roboflow Agent conversations

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/agent/conversations

GET /{workspace}/agent/conversations HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a Roboflow Agent conversation

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

conversationIdstringRequired

Conversation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/agent/conversations/{conversationId}

GET /{workspace}/agent/conversations/{conversationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Search

Search public Universe projects

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/universe/search

GET /universe/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Search public Universe projects by image

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/universe/search

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"
}

Search images in a project

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/search

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"
}

Search images across a workspace

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/search/v1

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"
}

Export image search results

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

202

Accepted for asynchronous processing.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/search/export

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"
}

Get image search export status

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

taskIdstringRequired

Asynchronous task ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/search/export/{taskId}

GET /{workspace}/search/export/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Trash and tasks

List deleted resources

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/trash

GET /{workspace}/trash HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Restore a deleted resource

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/trash/restore

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"
}

Get asynchronous task status

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

taskIdstringRequired

Asynchronous task ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/asynctasks/{taskId}

GET /{workspace}/asynctasks/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Deployment

Get project deployment settings

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/deploy

GET /{workspace}/{project}/deploy HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Select the deployed project model

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/deploy/model

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"
}

Get Active Learning settings

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/deploy/active-learning

GET /{workspace}/{project}/deploy/active-learning HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Enable Active Learning

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/deploy/active-learning/enable

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"
}

Disable Active Learning

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/deploy/active-learning/disable

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"
}

Update Active Learning settings

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/{project}/deploy/active-learning/configuration

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"
}

List Active Learning images

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

projectstringRequired

Project URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/{project}/deploy/active-learning/images

GET /{workspace}/{project}/deploy/active-learning/images HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Monitoring

Get inference usage statistics

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/inference-stats

GET /{workspace}/inference-stats HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Attach metadata to inference records

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/inference-stats/metadata

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

Create a Vision Event

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events

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"
}

Create Vision Events in a batch

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/batch

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"
}

Upload a Vision Event image

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/upload

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"
}

Query Vision Events

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/query

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"
}

Delete Vision Events

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/delete

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"
}

Get a custom metadata schema

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

useCaseIdstringRequired

Vision Events use case ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/vision-events/custom-metadata-schema/{useCaseId}

GET /vision-events/custom-metadata-schema/{useCaseId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List Vision Event use cases

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/vision-events/use-cases

GET /vision-events/use-cases HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create a Vision Event use case

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/use-cases

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"
}

Update a Vision Event use case

put

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

useCaseIdstringRequired

Vision Events use case ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

put/vision-events/use-cases/{useCaseId}

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"
}

Archive a Vision Event use case

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

useCaseIdstringRequired

Vision Events use case ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/use-cases/{useCaseId}/archive

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"
}

Unarchive a Vision Event use case

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

useCaseIdstringRequired

Vision Events use case ID.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/vision-events/use-cases/{useCaseId}/unarchive

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"
}

Deployment Manager

List Deployment Manager devices

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2

GET /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Register a Deployment Manager device

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

201

Created.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/devices/v2

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"
}

Get the default device configuration

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/default-config

GET /{workspace}/devices/v2/default-config HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a device

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}

GET /{workspace}/devices/v2/{deviceId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get device configuration

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/config

GET /{workspace}/devices/v2/{deviceId}/config HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get device configuration history

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/config/history

GET /{workspace}/devices/v2/{deviceId}/config/history HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

List device streams

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/streams

GET /{workspace}/devices/v2/{deviceId}/streams HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a device stream

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

streamIdstringRequired

Device stream ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/streams/{streamId}

GET /{workspace}/devices/v2/{deviceId}/streams/{streamId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get device logs

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/logs

GET /{workspace}/devices/v2/{deviceId}/logs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get device telemetry

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/telemetry

GET /{workspace}/devices/v2/{deviceId}/telemetry HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get device events

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

deviceIdstringRequired

Deployment Manager device ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/devices/v2/{deviceId}/events

GET /{workspace}/devices/v2/{deviceId}/events HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Model evaluations

List model evaluations

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals

GET /{workspace}/model-evals HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a model evaluation

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}

GET /{workspace}/model-evals/{evaluationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get mAP results

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/map-results

GET /{workspace}/model-evals/{evaluationId}/map-results HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get a confidence sweep

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/confidence-sweep

GET /{workspace}/model-evals/{evaluationId}/confidence-sweep HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get performance by class

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/performance-by-class

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"
}

Get a confusion matrix

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/confusion-matrix

GET /{workspace}/model-evals/{evaluationId}/confusion-matrix HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get vector analysis

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/vector-analysis

GET /{workspace}/model-evals/{evaluationId}/vector-analysis HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get image predictions

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/image-predictions

GET /{workspace}/model-evals/{evaluationId}/image-predictions HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Get evaluation recommendations

get

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

evaluationIdstringRequired

Model evaluation ID.

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

get/{workspace}/model-evals/{evaluationId}/recommendations

GET /{workspace}/model-evals/{evaluationId}/recommendations HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Billing

Get a billing usage report

post

This operation is part of the public Roboflow Platform API.

Authorizations

AuthorizationstringRequired

Roboflow API key or OAuth access token.

Path parameters

workspacestringRequired

Workspace URL slug.

Body

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

Responses

200

Successful response.

application/json

Operation-specific JSON object. See the linked guide for defined fields.

Other propertiesanyOptional

400

The request is invalid.

application/json

401

Authentication is missing or invalid.

application/json

403

The credential does not have access to this resource.

application/json

404

The resource does not exist or is not accessible.

application/json

429

The request rate is too high.

application/json

post/{workspace}/billing-usage-report

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"
}

PreviousAuthenticate with the REST API NextChoosing the Right Tool

Last updated 2 days ago

Was this helpful?