> For the complete documentation index, see [llms.txt](https://docs.roboflow.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.roboflow.com/reference/platform/rest-api/platform-api-openapi.md). # Platform API OpenAPI 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](/reference/platform/rest-api/authenticate-with-the-rest-api.md). {% hint style="info" %} 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. {% endhint %} For model and Workflow execution endpoints, see the [Inference Server OpenAPI](/reference/inference/inference-server-openapi.md). You can also [download the source OpenAPI document](https://openapi.gitbook.com/o/-MABnPmH89-NX2aB8mq4/spec/platform-api.yaml). ## Workspaces and projects ## Verify credentials and get the authenticated workspace > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/":{"get":{"tags":["Workspaces and projects"],"operationId":"getAuthenticatedWorkspace","summary":"Verify credentials and get the authenticated workspace","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a workspace and its projects > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}":{"get":{"tags":["Workspaces and projects"],"operationId":"getWorkspace","summary":"Get a workspace and its projects","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a project > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/projects":{"post":{"tags":["Workspaces and projects"],"operationId":"createProject","summary":"Create a project","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Fork a Universe project > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/projects/fork":{"post":{"tags":["Workspaces and projects"],"operationId":"forkUniverseProject","summary":"Fork a Universe project","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a project and its versions > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}":{"get":{"tags":["Workspaces and projects"],"operationId":"getProject","summary":"Get a project and its versions","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Move a project to Trash > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}":{"delete":{"tags":["Workspaces and projects"],"operationId":"deleteProject","summary":"Move a project to Trash","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get dataset health metrics > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/health":{"get":{"tags":["Workspaces and projects"],"operationId":"getDatasetHealth","summary":"Get dataset health metrics","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List models for a project > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/models":{"get":{"tags":["Workspaces and projects"],"operationId":"listProjectModels","summary":"List models for a project","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a dataset version > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}":{"get":{"tags":["Workspaces and projects"],"operationId":"getDatasetVersion","summary":"Get a dataset version","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Move a dataset version to Trash > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workspaces and projects","description":"Find workspaces, projects, versions, and trained models."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}":{"delete":{"tags":["Workspaces and projects"],"operationId":"deleteDatasetVersion","summary":"Move a dataset version to Trash","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## API keys ## List workspace API keys > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys":{"get":{"tags":["API keys"],"operationId":"listApiKeys","summary":"List workspace API keys","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a workspace API key > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys":{"post":{"tags":["API keys"],"operationId":"createApiKey","summary":"Create a workspace API key","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get the workspace publishable API key > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys/publishable":{"get":{"tags":["API keys"],"operationId":"getPublishableApiKey","summary":"Get the workspace publishable API key","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get an API key > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys/{keyId}":{"get":{"tags":["API keys"],"operationId":"getApiKey","summary":"Get an API key","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"API key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update an API key > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys/{keyId}":{"patch":{"tags":["API keys"],"operationId":"updateApiKey","summary":"Update an API key","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"API key ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Revoke an API key > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"API keys","description":"Create and manage workspace API keys."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/api-keys/{keyId}":{"delete":{"tags":["API keys"],"operationId":"revokeApiKey","summary":"Revoke an API key","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"keyId","in":"path","required":true,"description":"API key ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Project folders ## List project folders > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/groups":{"get":{"tags":["Project folders"],"operationId":"listProjectFolders","summary":"List project folders","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a project folder > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/groups":{"post":{"tags":["Project folders"],"operationId":"createProjectFolder","summary":"Create a project folder","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update a project folder > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/groups/{folderId}":{"post":{"tags":["Project folders"],"operationId":"updateProjectFolder","summary":"Update a project folder","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"folderId","in":"path","required":true,"description":"Project folder ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Delete a project folder > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"schemas":{"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}}},"paths":{"/{workspace}/groups/{folderId}":{"delete":{"tags":["Project folders"],"operationId":"deleteProjectFolder","summary":"Delete a project folder","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"folderId","in":"path","required":true,"description":"Project folder ID.","schema":{"type":"string"}}],"responses":{"204":{"description":"Completed with no response body."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Add or remove projects in a folder > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/groups/{folderId}/projects":{"patch":{"tags":["Project folders"],"operationId":"updateProjectsInFolder","summary":"Add or remove projects in a folder","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"folderId","in":"path","required":true,"description":"Project folder ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"204":{"description":"Completed with no response body."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Remove projects from a folder > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Project folders","description":"Organize projects into workspace folders."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/groups/{folderId}/projects":{"delete":{"tags":["Project folders"],"operationId":"removeProjectsFromFolder","summary":"Remove projects from a folder","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"folderId","in":"path","required":true,"description":"Project folder ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"204":{"description":"Completed with no response body."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Dataset versions and training ## Generate a dataset version > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/generate":{"post":{"tags":["Dataset versions and training"],"operationId":"generateDatasetVersion","summary":"Generate a dataset version","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Rebalance train, validation, and test splits > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/splits/rebalance":{"post":{"tags":["Dataset versions and training"],"operationId":"rebalanceDatasetSplits","summary":"Rebalance train, validation, and test splits","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Export a dataset version > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/{format}":{"get":{"tags":["Dataset versions and training"],"operationId":"exportDatasetVersion","summary":"Export a dataset version","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}},{"name":"format","in":"path","required":true,"description":"Dataset export format.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Start a training job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/train":{"post":{"tags":["Dataset versions and training"],"operationId":"startTraining","summary":"Start a training job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Cancel a queued training job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/train/cancel":{"post":{"tags":["Dataset versions and training"],"operationId":"cancelTraining","summary":"Cancel a queued training job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Stop an active training job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/train/stop":{"post":{"tags":["Dataset versions and training"],"operationId":"stopTraining","summary":"Stop an active training job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get training results > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/training/results":{"get":{"tags":["Dataset versions and training"],"operationId":"getTrainingResults","summary":"Get training results","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List training runs > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings":{"get":{"tags":["Dataset versions and training"],"operationId":"listTrainings","summary":"List training runs","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a training run > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings":{"post":{"tags":["Dataset versions and training"],"operationId":"createTraining","summary":"Create a training run","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a training run > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings/get":{"get":{"tags":["Dataset versions and training"],"operationId":"getTraining","summary":"Get a training run","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get the accepted training recipe > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings/recipe":{"get":{"tags":["Dataset versions and training"],"operationId":"getTrainingRecipe","summary":"Get the accepted training recipe","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Cancel a queued training run > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings/cancel":{"post":{"tags":["Dataset versions and training"],"operationId":"cancelTrainingV2","summary":"Cancel a queued training run","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Stop an active training run > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings/stop":{"post":{"tags":["Dataset versions and training"],"operationId":"stopTrainingV2","summary":"Stop an active training run","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Move a training run to Trash > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Dataset versions and training","description":"Generate dataset versions, export data, and manage training runs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/{version}/v2/trainings/{trainingId}":{"delete":{"tags":["Dataset versions and training"],"operationId":"deleteTraining","summary":"Move a training run to Trash","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"version","in":"path","required":true,"description":"Dataset version number.","schema":{"type":"integer","minimum":1}},{"name":"trainingId","in":"path","required":true,"description":"Training run ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Images and batches ## Upload an image > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"BadGateway":{"description":"A host Roboflow had to call failed. The response sets \"retryable\": true.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/dataset/{project}/upload":{"post":{"tags":["Images and batches"],"operationId":"uploadImage","summary":"Upload an image","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/OpenObject"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"},"502":{"$ref":"#/components/responses/BadGateway"}}}}}} ``` ## Upload an annotation > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/dataset/{project}/annotate/{imageId}":{"post":{"tags":["Images and batches"],"operationId":"uploadAnnotation","summary":"Upload an annotation","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"imageId","in":"path","required":true,"description":"Image ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get image details > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/images/{imageId}":{"get":{"tags":["Images and batches"],"operationId":"getImage","summary":"Get image details","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"imageId","in":"path","required":true,"description":"Image ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Delete images from a project > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/images":{"delete":{"tags":["Images and batches"],"operationId":"deleteImages","summary":"Delete images from a project","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"204":{"description":"Completed with no response body."},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Add or remove image tags > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/images/{imageId}/tags":{"post":{"tags":["Images and batches"],"operationId":"updateImageTags","summary":"Add or remove image tags","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"imageId","in":"path","required":true,"description":"Image ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update metadata and tags for one image > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/images/{imageId}/metadata":{"post":{"tags":["Images and batches"],"operationId":"updateImageMetadata","summary":"Update metadata and tags for one image","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"imageId","in":"path","required":true,"description":"Image ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update metadata and tags for multiple images > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/images/metadata":{"post":{"tags":["Images and batches"],"operationId":"bulkUpdateImageMetadata","summary":"Update metadata and tags for multiple images","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List image batches > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/batches":{"get":{"tags":["Images and batches"],"operationId":"listImageBatches","summary":"List image batches","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get an image batch > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/batches/{batchId}":{"get":{"tags":["Images and batches"],"operationId":"getImageBatch","summary":"Get an image batch","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"batchId","in":"path","required":true,"description":"Image batch ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Start a dataset ZIP upload > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/upload/zip":{"post":{"tags":["Images and batches"],"operationId":"startDatasetZipUpload","summary":"Start a dataset ZIP upload","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get dataset ZIP upload status > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Images and batches","description":"Upload, inspect, update, and organize dataset images."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/upload/zip/{taskId}":{"get":{"tags":["Images and batches"],"operationId":"getDatasetZipUpload","summary":"Get dataset ZIP upload status","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"description":"Asynchronous task ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Annotation ## List annotation jobs > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Annotation","description":"Create annotation and Auto Label jobs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/jobs":{"get":{"tags":["Annotation"],"operationId":"listAnnotationJobs","summary":"List annotation jobs","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create an annotation job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Annotation","description":"Create annotation and Auto Label jobs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/jobs":{"post":{"tags":["Annotation"],"operationId":"createAnnotationJob","summary":"Create an annotation job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get an annotation job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Annotation","description":"Create annotation and Auto Label jobs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/jobs/{jobId}":{"get":{"tags":["Annotation"],"operationId":"getAnnotationJob","summary":"Get an annotation job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}},{"name":"jobId","in":"path","required":true,"description":"Job ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create an Auto Label job > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Annotation","description":"Create annotation and Auto Label jobs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/autolabel":{"post":{"tags":["Annotation"],"operationId":"createAutoLabelJob","summary":"Create an Auto Label job","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get Auto Label job status > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Annotation","description":"Create annotation and Auto Label jobs."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/autolabel/jobs/{jobId}":{"get":{"tags":["Annotation"],"operationId":"getAutoLabelJob","summary":"Get Auto Label job status","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"jobId","in":"path","required":true,"description":"Job ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Workflows ## List Workflows > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/workflows":{"get":{"tags":["Workflows"],"operationId":"listWorkflows","summary":"List Workflows","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a Workflow > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/workflows/{workflowId}":{"get":{"tags":["Workflows"],"operationId":"getWorkflow","summary":"Get a Workflow","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"workflowId","in":"path","required":true,"description":"Workflow URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Move a Workflow to Trash > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/workflows/{workflowId}":{"delete":{"tags":["Workflows"],"operationId":"deleteWorkflow","summary":"Move a Workflow to Trash","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"workflowId","in":"path","required":true,"description":"Workflow URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List Workflow versions > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/workflows/{workflowId}/versions":{"get":{"tags":["Workflows"],"operationId":"listWorkflowVersions","summary":"List Workflow versions","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"workflowId","in":"path","required":true,"description":"Workflow URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a Workflow > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/createWorkflow":{"post":{"tags":["Workflows"],"operationId":"createWorkflow","summary":"Create a Workflow","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update a Workflow > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/updateWorkflow":{"post":{"tags":["Workflows"],"operationId":"updateWorkflow","summary":"Update a Workflow","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Fork a Workflow > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/forkWorkflow":{"post":{"tags":["Workflows"],"operationId":"forkWorkflow","summary":"Fork a Workflow","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a Workflow token > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Workflows","description":"Create, update, list, and publish Workflows."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/workflowToken":{"post":{"tags":["Workflows"],"operationId":"createWorkflowToken","summary":"Create a Workflow token","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Agent ## Send a message to Roboflow Agent > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Agent","description":"Build Workflows and inspect conversations with Roboflow Agent."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/agent/chat":{"post":{"tags":["Agent"],"operationId":"chatWithAgent","summary":"Send a message to Roboflow Agent","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Publish a Workflow created by Roboflow Agent > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Agent","description":"Build Workflows and inspect conversations with Roboflow Agent."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/agent/workflows/{workflowId}/publish":{"post":{"tags":["Agent"],"operationId":"publishAgentWorkflow","summary":"Publish a Workflow created by Roboflow Agent","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"workflowId","in":"path","required":true,"description":"Workflow URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List Roboflow Agent conversations > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Agent","description":"Build Workflows and inspect conversations with Roboflow Agent."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/agent/conversations":{"get":{"tags":["Agent"],"operationId":"listAgentConversations","summary":"List Roboflow Agent conversations","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a Roboflow Agent conversation > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Agent","description":"Build Workflows and inspect conversations with Roboflow Agent."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/agent/conversations/{conversationId}":{"get":{"tags":["Agent"],"operationId":"getAgentConversation","summary":"Get a Roboflow Agent conversation","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"conversationId","in":"path","required":true,"description":"Conversation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Search ## Search public Universe projects > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/universe/search":{"get":{"tags":["Search"],"operationId":"searchUniverseProjects","summary":"Search public Universe projects","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Search public Universe projects by image > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/universe/search":{"post":{"tags":["Search"],"operationId":"searchUniverseProjectsByImage","summary":"Search public Universe projects by image","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Search images in a project > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/search":{"post":{"tags":["Search"],"operationId":"searchProjectImages","summary":"Search images in a project","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Search images across a workspace > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/search/v1":{"post":{"tags":["Search"],"operationId":"searchWorkspaceImages","summary":"Search images across a workspace","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Export image search results > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/search/export":{"post":{"tags":["Search"],"operationId":"exportImageSearch","summary":"Export image search results","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"202":{"description":"Accepted for asynchronous processing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get image search export status > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Search","description":"Search workspace assets and public Universe projects."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/search/export/{taskId}":{"get":{"tags":["Search"],"operationId":"getImageSearchExport","summary":"Get image search export status","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"description":"Asynchronous task ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Trash and tasks ## List deleted resources > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Trash and tasks","description":"Restore deleted resources and inspect asynchronous tasks."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/trash":{"get":{"tags":["Trash and tasks"],"operationId":"listTrash","summary":"List deleted resources","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Restore a deleted resource > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Trash and tasks","description":"Restore deleted resources and inspect asynchronous tasks."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/trash/restore":{"post":{"tags":["Trash and tasks"],"operationId":"restoreFromTrash","summary":"Restore a deleted resource","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get asynchronous task status > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Trash and tasks","description":"Restore deleted resources and inspect asynchronous tasks."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/asynctasks/{taskId}":{"get":{"tags":["Trash and tasks"],"operationId":"getAsyncTask","summary":"Get asynchronous task status","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"taskId","in":"path","required":true,"description":"Asynchronous task ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Deployment ## Get project deployment settings > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy":{"get":{"tags":["Deployment"],"operationId":"getProjectDeployment","summary":"Get project deployment settings","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Select the deployed project model > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/model":{"post":{"tags":["Deployment"],"operationId":"selectProjectModel","summary":"Select the deployed project model","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get Active Learning settings > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/active-learning":{"get":{"tags":["Deployment"],"operationId":"getActiveLearning","summary":"Get Active Learning settings","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Enable Active Learning > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/active-learning/enable":{"post":{"tags":["Deployment"],"operationId":"enableActiveLearning","summary":"Enable Active Learning","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Disable Active Learning > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/active-learning/disable":{"post":{"tags":["Deployment"],"operationId":"disableActiveLearning","summary":"Disable Active Learning","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update Active Learning settings > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/active-learning/configuration":{"post":{"tags":["Deployment"],"operationId":"updateActiveLearning","summary":"Update Active Learning settings","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List Active Learning images > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment","description":"Manage project deployment settings and Active Learning."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/{project}/deploy/active-learning/images":{"get":{"tags":["Deployment"],"operationId":"listActiveLearningImages","summary":"List Active Learning images","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"project","in":"path","required":true,"description":"Project URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Monitoring ## Get inference usage statistics > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Monitoring","description":"Read inference usage and attach metadata."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/inference-stats":{"get":{"tags":["Monitoring"],"operationId":"getInferenceStats","summary":"Get inference usage statistics","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Attach metadata to inference records > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Monitoring","description":"Read inference usage and attach metadata."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/inference-stats/metadata":{"post":{"tags":["Monitoring"],"operationId":"attachInferenceMetadata","summary":"Attach metadata to inference records","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Vision Events ## Create a Vision Event > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events":{"post":{"tags":["Vision Events"],"operationId":"createVisionEvent","summary":"Create a Vision Event","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create Vision Events in a batch > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/batch":{"post":{"tags":["Vision Events"],"operationId":"createVisionEvents","summary":"Create Vision Events in a batch","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Upload a Vision Event image > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/upload":{"post":{"tags":["Vision Events"],"operationId":"uploadVisionEventImage","summary":"Upload a Vision Event image","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Query Vision Events > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/query":{"post":{"tags":["Vision Events"],"operationId":"queryVisionEvents","summary":"Query Vision Events","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Delete Vision Events > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/delete":{"post":{"tags":["Vision Events"],"operationId":"deleteVisionEvents","summary":"Delete Vision Events","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a custom metadata schema > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/custom-metadata-schema/{useCaseId}":{"get":{"tags":["Vision Events"],"operationId":"getVisionEventMetadataSchema","summary":"Get a custom metadata schema","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"useCaseId","in":"path","required":true,"description":"Vision Events use case ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List Vision Event use cases > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/use-cases":{"get":{"tags":["Vision Events"],"operationId":"listVisionEventUseCases","summary":"List Vision Event use cases","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Create a Vision Event use case > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/use-cases":{"post":{"tags":["Vision Events"],"operationId":"createVisionEventUseCase","summary":"Create a Vision Event use case","description":"This operation is part of the public Roboflow Platform API.","parameters":[],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Update a Vision Event use case > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/use-cases/{useCaseId}":{"put":{"tags":["Vision Events"],"operationId":"updateVisionEventUseCase","summary":"Update a Vision Event use case","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"useCaseId","in":"path","required":true,"description":"Vision Events use case ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Archive a Vision Event use case > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/use-cases/{useCaseId}/archive":{"post":{"tags":["Vision Events"],"operationId":"archiveVisionEventUseCase","summary":"Archive a Vision Event use case","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"useCaseId","in":"path","required":true,"description":"Vision Events use case ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Unarchive a Vision Event use case > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Vision Events","description":"Create, query, and organize Vision Events."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/vision-events/use-cases/{useCaseId}/unarchive":{"post":{"tags":["Vision Events"],"operationId":"unarchiveVisionEventUseCase","summary":"Unarchive a Vision Event use case","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"useCaseId","in":"path","required":true,"description":"Vision Events use case ID.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Deployment Manager ## List Deployment Manager devices > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2":{"get":{"tags":["Deployment Manager"],"operationId":"listDevices","summary":"List Deployment Manager devices","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Register a Deployment Manager device > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2":{"post":{"tags":["Deployment Manager"],"operationId":"registerDevice","summary":"Register a Deployment Manager device","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"201":{"description":"Created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get the default device configuration > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/default-config":{"get":{"tags":["Deployment Manager"],"operationId":"getDefaultDeviceConfig","summary":"Get the default device configuration","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a device > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}":{"get":{"tags":["Deployment Manager"],"operationId":"getDevice","summary":"Get a device","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get device configuration > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/config":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceConfig","summary":"Get device configuration","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get device configuration history > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/config/history":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceConfigHistory","summary":"Get device configuration history","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List device streams > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/streams":{"get":{"tags":["Deployment Manager"],"operationId":"listDeviceStreams","summary":"List device streams","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a device stream > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/streams/{streamId}":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceStream","summary":"Get a device stream","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}},{"name":"streamId","in":"path","required":true,"description":"Device stream ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get device logs > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/logs":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceLogs","summary":"Get device logs","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get device telemetry > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/telemetry":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceTelemetry","summary":"Get device telemetry","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get device events > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/events":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceEvents","summary":"Get device events","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## List device services > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/services":{"get":{"tags":["Deployment Manager"],"operationId":"listDeviceServices","summary":"List device services","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a device service > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/services/{serviceName}":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceService","summary":"Get a device service","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}},{"name":"serviceName","in":"path","required":true,"description":"Service name, as declared in the device config.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a device service metric series > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Deployment Manager","description":"Register and inspect managed edge devices."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/devices/v2/{deviceId}/services/{serviceName}/series":{"get":{"tags":["Deployment Manager"],"operationId":"getDeviceServiceSeries","summary":"Get a device service metric series","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"deviceId","in":"path","required":true,"description":"Deployment Manager device ID.","schema":{"type":"string"}},{"name":"serviceName","in":"path","required":true,"description":"Service name, as declared in the device config.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Model evaluations ## List model evaluations > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals":{"get":{"tags":["Model evaluations"],"operationId":"listModelEvaluations","summary":"List model evaluations","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a model evaluation > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}":{"get":{"tags":["Model evaluations"],"operationId":"getModelEvaluation","summary":"Get a model evaluation","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get mAP results > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/map-results":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationMapResults","summary":"Get mAP results","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a confidence sweep > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/confidence-sweep":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationConfidenceSweep","summary":"Get a confidence sweep","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get performance by class > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/performance-by-class":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationPerformanceByClass","summary":"Get performance by class","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get a confusion matrix > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/confusion-matrix":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationConfusionMatrix","summary":"Get a confusion matrix","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get vector analysis > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/vector-analysis":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationVectorAnalysis","summary":"Get vector analysis","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get image predictions > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/image-predictions":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationImagePredictions","summary":"Get image predictions","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Get evaluation recommendations > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Model evaluations","description":"Inspect evaluation summaries and detailed evaluation results."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/model-evals/{evaluationId}/recommendations":{"get":{"tags":["Model evaluations"],"operationId":"getEvaluationRecommendations","summary":"Get evaluation recommendations","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}},{"name":"evaluationId","in":"path","required":true,"description":"Model evaluation ID.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ``` ## Billing ## Get a billing usage report > This operation is part of the public Roboflow Platform API. ```json {"openapi":"3.1.0","info":{"title":"Roboflow Platform API","version":"0.1.0"},"tags":[{"name":"Billing","description":"Retrieve workspace usage grouped by billing folder."}],"servers":[{"url":"https://api.roboflow.com","description":"Roboflow Platform API"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Roboflow API key or OAuth access token."},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key","description":"Roboflow API key. Use the Authorization header when possible."}},"schemas":{"OpenObject":{"type":"object","description":"Operation-specific JSON object. See the linked guide for defined fields.","additionalProperties":true},"ErrorResponse":{"type":"object","properties":{"error":{"oneOf":[{"type":"string"},{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"},"hint":{"type":"string"}},"additionalProperties":true}]}},"additionalProperties":true}},"responses":{"BadRequest":{"description":"The request is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthorized":{"description":"Authentication is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The credential does not have access to this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"The resource does not exist or is not accessible.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"RateLimited":{"description":"The request rate is too high.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/{workspace}/billing-usage-report":{"post":{"tags":["Billing"],"operationId":"getBillingUsageReport","summary":"Get a billing usage report","description":"This operation is part of the public Roboflow Platform API.","parameters":[{"name":"workspace","in":"path","required":true,"description":"Workspace URL slug.","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Request fields vary by operation. See the linked guide for the supported fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenObject"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"429":{"$ref":"#/components/responses/RateLimited"}}}}}} ```