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
gethttps://api.roboflow.com/
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/
GET / HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a workspace and its projects
gethttps://api.roboflow.com/{workspace}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}
GET /{workspace} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a project
posthttps://api.roboflow.com/{workspace}/projects
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/projects
POST /{workspace}/projects HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/projects' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/projects", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/projects"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Fork a Universe project
posthttps://api.roboflow.com/{workspace}/projects/fork
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/projects/fork' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/projects/fork", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/projects/fork"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a project and its versions
gethttps://api.roboflow.com/{workspace}/{project}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}
GET /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Move a project to Trash
deletehttps://api.roboflow.com/{workspace}/{project}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
delete/{workspace}/{project}
DELETE /{workspace}/{project} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/{project}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get dataset health metrics
gethttps://api.roboflow.com/{workspace}/{project}/health
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/health
GET /{workspace}/{project}/health HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/health' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/health", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/health"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List models for a project
gethttps://api.roboflow.com/{workspace}/{project}/models
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/models
GET /{workspace}/{project}/models HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/models' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/models", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/models"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a dataset version
gethttps://api.roboflow.com/{workspace}/{project}/{version}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/{version}
GET /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Move a dataset version to Trash
deletehttps://api.roboflow.com/{workspace}/{project}/{version}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
delete/{workspace}/{project}/{version}
DELETE /{workspace}/{project}/{version} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}API keys
List workspace API keys
gethttps://api.roboflow.com/{workspace}/api-keys
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/api-keys
GET /{workspace}/api-keys HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/api-keys' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a workspace API key
posthttps://api.roboflow.com/{workspace}/api-keys
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/api-keys' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get the workspace publishable API key
gethttps://api.roboflow.com/{workspace}/api-keys/publishable
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/api-keys/publishable
GET /{workspace}/api-keys/publishable HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/api-keys/publishable' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys/publishable", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys/publishable"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get an API key
gethttps://api.roboflow.com/{workspace}/api-keys/{keyId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
keyIdstringRequired
API key ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/api-keys/{keyId}
GET /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/api-keys/{keyId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys/{keyId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys/{keyId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update an API key
patchhttps://api.roboflow.com/{workspace}/api-keys/{keyId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
keyIdstringRequired
API key ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request PATCH \
--url 'https://api.roboflow.com/{workspace}/api-keys/{keyId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys/{keyId}", {
method: "PATCH",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys/{keyId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Revoke an API key
deletehttps://api.roboflow.com/{workspace}/api-keys/{keyId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
keyIdstringRequired
API key ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
delete/{workspace}/api-keys/{keyId}
DELETE /{workspace}/api-keys/{keyId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/api-keys/{keyId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/api-keys/{keyId}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/api-keys/{keyId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Project folders
List project folders
gethttps://api.roboflow.com/{workspace}/groups
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/groups
GET /{workspace}/groups HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/groups' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/groups", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a project folder
posthttps://api.roboflow.com/{workspace}/groups
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/groups
POST /{workspace}/groups HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/groups' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/groups", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update a project folder
posthttps://api.roboflow.com/{workspace}/groups/{folderId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
folderIdstringRequired
Project folder ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/groups/{folderId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/groups/{folderId}", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups/{folderId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Delete a project folder
deletehttps://api.roboflow.com/{workspace}/groups/{folderId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
folderIdstringRequired
Project folder ID.
Responses
204Completed with no response body.
No content
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
delete/{workspace}/groups/{folderId}
DELETE /{workspace}/groups/{folderId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*curl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/groups/{folderId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: */*'const response = await fetch("https://api.roboflow.com/{workspace}/groups/{folderId}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "*/*"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups/{folderId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "*/*"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Add or remove projects in a folder
patchhttps://api.roboflow.com/{workspace}/groups/{folderId}/projects
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
folderIdstringRequired
Project folder ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
204Completed with no response body.
No content
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request PATCH \
--url 'https://api.roboflow.com/{workspace}/groups/{folderId}/projects' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/groups/{folderId}/projects", {
method: "PATCH",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups/{folderId}/projects"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.patch(url, headers=headers, json=payload)
print(response.json())Response
{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Remove projects from a folder
deletehttps://api.roboflow.com/{workspace}/groups/{folderId}/projects
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
folderIdstringRequired
Project folder ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
204Completed with no response body.
No content
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/groups/{folderId}/projects' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/groups/{folderId}/projects", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/groups/{folderId}/projects"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.delete(url, headers=headers, json=payload)
print(response.json())Response
{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Dataset versions and training
Generate a dataset version
posthttps://api.roboflow.com/{workspace}/{project}/generate
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/generate' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/generate", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/generate"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Rebalance train, validation, and test splits
posthttps://api.roboflow.com/{workspace}/{project}/splits/rebalance
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/{project}/splits/rebalance
POST /{workspace}/{project}/splits/rebalance HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/splits/rebalance' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/splits/rebalance", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/splits/rebalance"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Export a dataset version
gethttps://api.roboflow.com/{workspace}/{project}/{version}/{format}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
formatstringRequired
Dataset export format.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/{version}/{format}
GET /{workspace}/{project}/{version}/{format} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/{format}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/{format}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/{format}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Start a training job
posthttps://api.roboflow.com/{workspace}/{project}/{version}/train
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/train' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/train", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/train"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Cancel a queued training job
posthttps://api.roboflow.com/{workspace}/{project}/{version}/train/cancel
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/train/cancel' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/train/cancel", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/train/cancel"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Stop an active training job
posthttps://api.roboflow.com/{workspace}/{project}/{version}/train/stop
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/train/stop' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/train/stop", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/train/stop"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get training results
gethttps://api.roboflow.com/{workspace}/{project}/{version}/training/results
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/training/results' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/training/results", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/training/results"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List training runs
gethttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a training run
posthttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a training run
gethttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/get
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/get' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/get", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/get"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get the accepted training recipe
gethttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/recipe
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/recipe' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/recipe", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/recipe"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Cancel a queued training run
posthttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/cancel
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/cancel' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/cancel", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/cancel"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Stop an active training run
posthttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/stop
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/stop' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/stop", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/stop"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Move a training run to Trash
deletehttps://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/{trainingId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
versionintegerRequired
Dataset version number.
trainingIdstringRequired
Training run ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/{trainingId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/{trainingId}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/{version}/v2/trainings/{trainingId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Images and batches
Upload an image
posthttps://api.roboflow.com/dataset/{project}/upload
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
projectstringRequired
Project URL slug.
Body
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
502A host Roboflow had to call failed. The response sets "retryable": true.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/dataset/{project}/upload' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/dataset/{project}/upload", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "multipart/form-data",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/dataset/{project}/upload"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "multipart/form-data",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Upload an annotation
posthttps://api.roboflow.com/dataset/{project}/annotate/{imageId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
projectstringRequired
Project URL slug.
imageIdstringRequired
Image ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/dataset/{project}/annotate/{imageId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/dataset/{project}/annotate/{imageId}", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/dataset/{project}/annotate/{imageId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get image details
gethttps://api.roboflow.com/{workspace}/{project}/images/{imageId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
imageIdstringRequired
Image ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/images/{imageId}
GET /{workspace}/{project}/images/{imageId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/images/{imageId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/images/{imageId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/images/{imageId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Delete images from a project
deletehttps://api.roboflow.com/{workspace}/{project}/images
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
204Completed with no response body.
No content
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: */*
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/{project}/images' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/images", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/images"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "*/*"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.delete(url, headers=headers, json=payload)
print(response.json())Response
{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Add or remove image tags
posthttps://api.roboflow.com/{workspace}/{project}/images/{imageId}/tags
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
imageIdstringRequired
Image ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/images/{imageId}/tags' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/images/{imageId}/tags", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/images/{imageId}/tags"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update metadata and tags for one image
posthttps://api.roboflow.com/{workspace}/images/{imageId}/metadata
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
imageIdstringRequired
Image ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/images/{imageId}/metadata' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/images/{imageId}/metadata", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/images/{imageId}/metadata"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update metadata and tags for multiple images
posthttps://api.roboflow.com/{workspace}/images/metadata
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/images/metadata' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/images/metadata", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/images/metadata"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List image batches
gethttps://api.roboflow.com/{workspace}/{project}/batches
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/batches
GET /{workspace}/{project}/batches HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/batches' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/batches", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/batches"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get an image batch
gethttps://api.roboflow.com/{workspace}/{project}/batches/{batchId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
batchIdstringRequired
Image batch ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/batches/{batchId}
GET /{workspace}/{project}/batches/{batchId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/batches/{batchId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/batches/{batchId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/batches/{batchId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Start a dataset ZIP upload
posthttps://api.roboflow.com/{workspace}/{project}/upload/zip
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/upload/zip' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/upload/zip", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/upload/zip"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get dataset ZIP upload status
gethttps://api.roboflow.com/{workspace}/upload/zip/{taskId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
taskIdstringRequired
Asynchronous task ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/upload/zip/{taskId}
GET /{workspace}/upload/zip/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/upload/zip/{taskId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/upload/zip/{taskId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/upload/zip/{taskId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Annotation
List annotation jobs
gethttps://api.roboflow.com/{workspace}/{project}/jobs
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/jobs
GET /{workspace}/{project}/jobs HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/jobs' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/jobs", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/jobs"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create an annotation job
posthttps://api.roboflow.com/{workspace}/{project}/jobs
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/jobs' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/jobs", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/jobs"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get an annotation job
gethttps://api.roboflow.com/{workspace}/{project}/jobs/{jobId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
jobIdstringRequired
Job ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/jobs/{jobId}
GET /{workspace}/{project}/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/jobs/{jobId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/jobs/{jobId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/jobs/{jobId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create an Auto Label job
posthttps://api.roboflow.com/{workspace}/{project}/autolabel
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/autolabel' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/autolabel", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/autolabel"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get Auto Label job status
gethttps://api.roboflow.com/{workspace}/autolabel/jobs/{jobId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
jobIdstringRequired
Job ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/autolabel/jobs/{jobId}
GET /{workspace}/autolabel/jobs/{jobId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/autolabel/jobs/{jobId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/autolabel/jobs/{jobId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/autolabel/jobs/{jobId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Workflows
List Workflows
gethttps://api.roboflow.com/{workspace}/workflows
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/workflows
GET /{workspace}/workflows HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/workflows' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/workflows", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/workflows"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a Workflow
gethttps://api.roboflow.com/{workspace}/workflows/{workflowId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
workflowIdstringRequired
Workflow URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/workflows/{workflowId}
GET /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/workflows/{workflowId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/workflows/{workflowId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/workflows/{workflowId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Move a Workflow to Trash
deletehttps://api.roboflow.com/{workspace}/workflows/{workflowId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
workflowIdstringRequired
Workflow URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
delete/{workspace}/workflows/{workflowId}
DELETE /{workspace}/workflows/{workflowId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request DELETE \
--url 'https://api.roboflow.com/{workspace}/workflows/{workflowId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/workflows/{workflowId}", {
method: "DELETE",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/workflows/{workflowId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.delete(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List Workflow versions
gethttps://api.roboflow.com/{workspace}/workflows/{workflowId}/versions
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
workflowIdstringRequired
Workflow URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/workflows/{workflowId}/versions
GET /{workspace}/workflows/{workflowId}/versions HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/workflows/{workflowId}/versions' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/workflows/{workflowId}/versions", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/workflows/{workflowId}/versions"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a Workflow
posthttps://api.roboflow.com/{workspace}/createWorkflow
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/createWorkflow
POST /{workspace}/createWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/createWorkflow' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/createWorkflow", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/createWorkflow"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update a Workflow
posthttps://api.roboflow.com/{workspace}/updateWorkflow
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/updateWorkflow
POST /{workspace}/updateWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/updateWorkflow' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/updateWorkflow", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/updateWorkflow"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Fork a Workflow
posthttps://api.roboflow.com/{workspace}/forkWorkflow
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/forkWorkflow
POST /{workspace}/forkWorkflow HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/forkWorkflow' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/forkWorkflow", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/forkWorkflow"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a Workflow token
posthttps://api.roboflow.com/{workspace}/workflowToken
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/{workspace}/workflowToken
POST /{workspace}/workflowToken HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/workflowToken' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/workflowToken", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/workflowToken"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Agent
Send a message to Roboflow Agent
posthttps://api.roboflow.com/{workspace}/agent/chat
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/agent/chat' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/agent/chat", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/agent/chat"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Publish a Workflow created by Roboflow Agent
posthttps://api.roboflow.com/{workspace}/agent/workflows/{workflowId}/publish
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
workflowIdstringRequired
Workflow URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/agent/workflows/{workflowId}/publish' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/agent/workflows/{workflowId}/publish", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/agent/workflows/{workflowId}/publish"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List Roboflow Agent conversations
gethttps://api.roboflow.com/{workspace}/agent/conversations
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/agent/conversations
GET /{workspace}/agent/conversations HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/agent/conversations' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/agent/conversations", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/agent/conversations"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a Roboflow Agent conversation
gethttps://api.roboflow.com/{workspace}/agent/conversations/{conversationId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
conversationIdstringRequired
Conversation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/agent/conversations/{conversationId}
GET /{workspace}/agent/conversations/{conversationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/agent/conversations/{conversationId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/agent/conversations/{conversationId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/agent/conversations/{conversationId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Search
Search public Universe projects
gethttps://api.roboflow.com/universe/search
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/universe/search
GET /universe/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/universe/search' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/universe/search", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/universe/search"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Search public Universe projects by image
posthttps://api.roboflow.com/universe/search
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/universe/search
POST /universe/search HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/universe/search' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/universe/search", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/universe/search"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Search images in a project
posthttps://api.roboflow.com/{workspace}/{project}/search
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/search' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/search", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/search"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Search images across a workspace
posthttps://api.roboflow.com/{workspace}/search/v1
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/search/v1' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/search/v1", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/search/v1"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Export image search results
posthttps://api.roboflow.com/{workspace}/search/export
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
202Accepted for asynchronous processing.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/search/export' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/search/export", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/search/export"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get image search export status
gethttps://api.roboflow.com/{workspace}/search/export/{taskId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
taskIdstringRequired
Asynchronous task ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/search/export/{taskId}
GET /{workspace}/search/export/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/search/export/{taskId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/search/export/{taskId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/search/export/{taskId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Trash and tasks
List deleted resources
gethttps://api.roboflow.com/{workspace}/trash
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/trash
GET /{workspace}/trash HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/trash' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/trash", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/trash"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Restore a deleted resource
posthttps://api.roboflow.com/{workspace}/trash/restore
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/trash/restore' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/trash/restore", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/trash/restore"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get asynchronous task status
gethttps://api.roboflow.com/{workspace}/asynctasks/{taskId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
taskIdstringRequired
Asynchronous task ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/asynctasks/{taskId}
GET /{workspace}/asynctasks/{taskId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/asynctasks/{taskId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/asynctasks/{taskId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/asynctasks/{taskId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Deployment
Get project deployment settings
gethttps://api.roboflow.com/{workspace}/{project}/deploy
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/{project}/deploy
GET /{workspace}/{project}/deploy HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Select the deployed project model
posthttps://api.roboflow.com/{workspace}/{project}/deploy/model
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/model' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/model", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/model"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get Active Learning settings
gethttps://api.roboflow.com/{workspace}/{project}/deploy/active-learning
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/active-learning' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/active-learning", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/active-learning"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Enable Active Learning
posthttps://api.roboflow.com/{workspace}/{project}/deploy/active-learning/enable
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/enable' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/enable", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/enable"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Disable Active Learning
posthttps://api.roboflow.com/{workspace}/{project}/deploy/active-learning/disable
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/disable' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/disable", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/disable"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update Active Learning settings
posthttps://api.roboflow.com/{workspace}/{project}/deploy/active-learning/configuration
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/configuration' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/configuration", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/configuration"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List Active Learning images
gethttps://api.roboflow.com/{workspace}/{project}/deploy/active-learning/images
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
projectstringRequired
Project URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/images' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/images", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/{project}/deploy/active-learning/images"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Monitoring
Get inference usage statistics
gethttps://api.roboflow.com/{workspace}/inference-stats
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/inference-stats
GET /{workspace}/inference-stats HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/inference-stats' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/inference-stats", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/inference-stats"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Attach metadata to inference records
posthttps://api.roboflow.com/{workspace}/inference-stats/metadata
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/inference-stats/metadata' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/inference-stats/metadata", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/inference-stats/metadata"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Vision Events
Create a Vision Event
posthttps://api.roboflow.com/vision-events
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
post/vision-events
POST /vision-events HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create Vision Events in a batch
posthttps://api.roboflow.com/vision-events/batch
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/batch' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/batch", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/batch"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Upload a Vision Event image
posthttps://api.roboflow.com/vision-events/upload
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodymultipart/form-data
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/upload' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: multipart/form-data' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/upload", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "multipart/form-data",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/upload"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "multipart/form-data",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Query Vision Events
posthttps://api.roboflow.com/vision-events/query
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/query' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/query", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/query"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Delete Vision Events
posthttps://api.roboflow.com/vision-events/delete
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/delete' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/delete", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/delete"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a custom metadata schema
gethttps://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
useCaseIdstringRequired
Vision Events use case ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/custom-metadata-schema/{useCaseId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List Vision Event use cases
gethttps://api.roboflow.com/vision-events/use-cases
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/vision-events/use-cases
GET /vision-events/use-cases HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/vision-events/use-cases' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/vision-events/use-cases", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/use-cases"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Create a Vision Event use case
posthttps://api.roboflow.com/vision-events/use-cases
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/use-cases' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/use-cases", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/use-cases"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Update a Vision Event use case
puthttps://api.roboflow.com/vision-events/use-cases/{useCaseId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
useCaseIdstringRequired
Vision Events use case ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request PUT \
--url 'https://api.roboflow.com/vision-events/use-cases/{useCaseId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/use-cases/{useCaseId}", {
method: "PUT",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/use-cases/{useCaseId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Archive a Vision Event use case
posthttps://api.roboflow.com/vision-events/use-cases/{useCaseId}/archive
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
useCaseIdstringRequired
Vision Events use case ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/use-cases/{useCaseId}/archive' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/use-cases/{useCaseId}/archive", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/use-cases/{useCaseId}/archive"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Unarchive a Vision Event use case
posthttps://api.roboflow.com/vision-events/use-cases/{useCaseId}/unarchive
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
useCaseIdstringRequired
Vision Events use case ID.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/vision-events/use-cases/{useCaseId}/unarchive' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/vision-events/use-cases/{useCaseId}/unarchive", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/vision-events/use-cases/{useCaseId}/unarchive"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Deployment Manager
List Deployment Manager devices
gethttps://api.roboflow.com/{workspace}/devices/v2
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/devices/v2
GET /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Register a Deployment Manager device
posthttps://api.roboflow.com/{workspace}/devices/v2
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
201Created.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/devices/v2' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get the default device configuration
gethttps://api.roboflow.com/{workspace}/devices/v2/default-config
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/default-config' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/default-config", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/default-config"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a device
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/devices/v2/{deviceId}
GET /{workspace}/devices/v2/{deviceId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get device configuration
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get device configuration history
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}List device streams
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a device stream
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
streamIdstringRequired
Device stream ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get device logs
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/logs
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/logs' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/logs", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/logs"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get device telemetry
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/telemetry
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/telemetry' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/telemetry", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/telemetry"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get device events
gethttps://api.roboflow.com/{workspace}/devices/v2/{deviceId}/events
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
deviceIdstringRequired
Deployment Manager device ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/events' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/events", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/events"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Model evaluations
List model evaluations
gethttps://api.roboflow.com/{workspace}/model-evals
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/model-evals
GET /{workspace}/model-evals HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a model evaluation
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
get/{workspace}/model-evals/{evaluationId}
GET /{workspace}/model-evals/{evaluationId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get mAP results
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/map-results
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/map-results' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/map-results", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/map-results"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a confidence sweep
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confidence-sweep
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confidence-sweep' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confidence-sweep", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confidence-sweep"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get performance by class
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/performance-by-class
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/performance-by-class' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/performance-by-class", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/performance-by-class"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get a confusion matrix
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confusion-matrix
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confusion-matrix' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confusion-matrix", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/confusion-matrix"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get vector analysis
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/vector-analysis
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/vector-analysis' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/vector-analysis", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/vector-analysis"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get image predictions
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/image-predictions
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/image-predictions' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/image-predictions", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/image-predictions"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Get evaluation recommendations
gethttps://api.roboflow.com/{workspace}/model-evals/{evaluationId}/recommendations
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
evaluationIdstringRequired
Model evaluation ID.
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/jsoncurl -L \
--request GET \
--url 'https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/recommendations' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Accept: application/json'const response = await fetch("https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/recommendations", {
method: "GET",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/model-evals/{evaluationId}/recommendations"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Accept": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}Billing
Get a billing usage report
posthttps://api.roboflow.com/{workspace}/billing-usage-report
This operation is part of the public Roboflow Platform API.
Authorizations
AuthorizationstringRequired
Roboflow API key or OAuth access token.
api_keystringRequired
Roboflow API key. Use the Authorization header when possible.
Path parameters
workspacestringRequired
Workspace URL slug.
Bodyapplication/json
Request fields vary by operation. See the linked guide for the supported fields.
Other propertiesanyOptional
Responses
200Successful response.application/json
Other propertiesanyOptional
400The request is invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
401Authentication is missing or invalid.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
403The credential does not have access to this resource.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
404The resource does not exist or is not accessible.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
429The request rate is too high.application/json
errorone ofOptional
Show propertiesHide properties
stringOptional
objectOptional
Show propertiesHide properties
messagestringOptional
typestringOptional
hintstringOptional
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: application/json
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}curl -L \
--request POST \
--url 'https://api.roboflow.com/{workspace}/billing-usage-report' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"ANY_ADDITIONAL_PROPERTY": "anything"
}'const response = await fetch("https://api.roboflow.com/{workspace}/billing-usage-report", {
method: "POST",
headers: {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
"ANY_ADDITIONAL_PROPERTY": "anything"
})
});
const data = await response.json();
console.log(data);import requests
url = "https://api.roboflow.com/{workspace}/billing-usage-report"
headers = {
"Authorization": "Bearer YOUR_SECRET_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
}
payload = {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Response
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}{
"error": "text"
}