# Generated by node scripts/gen-platform-openapi.mjs.
openapi: "3.1.0"
info:
  title: "Roboflow Platform API"
  version: "0.1.0"
  description: "Manage Roboflow workspaces, projects, datasets, training, Workflows, and related platform resources. This specification includes public operations documented at docs.roboflow.com. Request and response objects remain open where the API service does not yet publish a machine-readable schema."
servers:
  - url: "https://api.roboflow.com"
    description: "Roboflow Platform API"
tags:
  - name: "Workspaces and projects"
    description: "Find workspaces, projects, versions, and trained models."
  - name: "API keys"
    description: "Create and manage workspace API keys."
  - name: "Project folders"
    description: "Organize projects into workspace folders."
  - name: "Dataset versions and training"
    description: "Generate dataset versions, export data, and manage training runs."
  - name: "Images and batches"
    description: "Upload, inspect, update, and organize dataset images."
  - name: "Annotation"
    description: "Create annotation and Auto Label jobs."
  - name: "Workflows"
    description: "Create, update, list, and publish Workflows."
  - name: "Agent"
    description: "Build Workflows and inspect conversations with Roboflow Agent."
  - name: "Search"
    description: "Search workspace assets and public Universe projects."
  - name: "Trash and tasks"
    description: "Restore deleted resources and inspect asynchronous tasks."
  - name: "Deployment"
    description: "Manage project deployment settings and Active Learning."
  - name: "Monitoring"
    description: "Read inference usage and attach metadata."
  - name: "Vision Events"
    description: "Create, query, and organize Vision Events."
  - name: "Deployment Manager"
    description: "Register and inspect managed edge devices."
  - name: "Model evaluations"
    description: "Inspect evaluation summaries and detailed evaluation results."
  - name: "Billing"
    description: "Retrieve workspace usage grouped by billing folder."
security:
  - bearerAuth: []
  - apiKeyQuery: []
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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{workspace}/projects":
    post:
      tags:
        - "Workspaces and projects"
      operationId: "createProject"
      summary: "Create a project"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
    delete:
      tags:
        - "Workspaces and projects"
      operationId: "deleteProject"
      summary: "Move a project to Trash"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
    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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/list-workspaces-and-projects#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
    post:
      tags:
        - "API keys"
      operationId: "createApiKey"
      summary: "Create a workspace API key"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
    patch:
      tags:
        - "API keys"
      operationId: "updateApiKey"
      summary: "Update an API key"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
    delete:
      tags:
        - "API keys"
      operationId: "revokeApiKey"
      summary: "Revoke an API key"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/reference/authentication/manage-api-keys#http-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"
  "/{workspace}/groups":
    get:
      tags:
        - "Project folders"
      operationId: "listProjectFolders"
      summary: "List project folders"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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"
    post:
      tags:
        - "Project folders"
      operationId: "createProjectFolder"
      summary: "Create a project folder"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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:
      tags:
        - "Project folders"
      operationId: "deleteProjectFolder"
      summary: "Delete a project folder"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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"
    delete:
      tags:
        - "Project folders"
      operationId: "removeProjectsFromFolder"
      summary: "Remove projects from a folder"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/project-folders#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/versions/dataset-versions/create-a-dataset-version#rebalance-train-validation-test-splits"
      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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
    post:
      tags:
        - "Dataset versions and training"
      operationId: "createTraining"
      summary: "Create a training run"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/train/train-a-model#http-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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-images#http-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"
  "/{workspace}/{project}/jobs":
    get:
      tags:
        - "Annotation"
      operationId: "listAnnotationJobs"
      summary: "List annotation jobs"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/annotate/team-collaboration#http-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"
    post:
      tags:
        - "Annotation"
      operationId: "createAnnotationJob"
      summary: "Create an annotation job"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/annotate/team-collaboration#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/annotate/team-collaboration#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/annotate/team-collaboration#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/annotate/team-collaboration#http-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"
  "/{workspace}/workflows":
    get:
      tags:
        - "Workflows"
      operationId: "listWorkflows"
      summary: "List Workflows"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/workflows/{workflowId}":
    get:
      tags:
        - "Workflows"
      operationId: "getWorkflow"
      summary: "Get a Workflow"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
    delete:
      tags:
        - "Workflows"
      operationId: "deleteWorkflow"
      summary: "Move a Workflow to Trash"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/workflows/{workflowId}/versions":
    get:
      tags:
        - "Workflows"
      operationId: "listWorkflowVersions"
      summary: "List Workflow versions"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/createWorkflow":
    post:
      tags:
        - "Workflows"
      operationId: "createWorkflow"
      summary: "Create a Workflow"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/updateWorkflow":
    post:
      tags:
        - "Workflows"
      operationId: "updateWorkflow"
      summary: "Update a Workflow"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/forkWorkflow":
    post:
      tags:
        - "Workflows"
      operationId: "forkWorkflow"
      summary: "Fork a Workflow"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{workspace}/workflowToken":
    post:
      tags:
        - "Workflows"
      operationId: "createWorkflowToken"
      summary: "Create a Workflow token"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/workflows/manage/manage-workflows#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/agents/roboflow-agent#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/agents/roboflow-agent#http-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"
  "/{workspace}/agent/conversations":
    get:
      tags:
        - "Agent"
      operationId: "listAgentConversations"
      summary: "List Roboflow Agent conversations"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/agents/roboflow-agent#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/agents/roboflow-agent#http-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"
  "/universe/search":
    get:
      tags:
        - "Search"
      operationId: "searchUniverseProjects"
      summary: "Search public Universe projects"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
    post:
      tags:
        - "Search"
      operationId: "searchUniverseProjectsByImage"
      summary: "Search public Universe projects by image"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
  "/{workspace}/search/export":
    post:
      tags:
        - "Search"
      operationId: "exportImageSearch"
      summary: "Export image search results"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/datasets/manage/manage-datasets/dataset-search#http-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"
  "/{workspace}/trash":
    get:
      tags:
        - "Trash and tasks"
      operationId: "listTrash"
      summary: "List deleted resources"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/trash#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/trash#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/workspaces/trash#http-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"
  "/{workspace}/{project}/deploy":
    get:
      tags:
        - "Deployment"
      operationId: "getProjectDeployment"
      summary: "Get project deployment settings"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/project-deploy-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"
  "/{workspace}/inference-stats":
    get:
      tags:
        - "Monitoring"
      operationId: "getInferenceStats"
      summary: "Get inference usage statistics"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/model-monitoring#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/model-monitoring#http-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":
    post:
      tags:
        - "Vision Events"
      operationId: "createVisionEvent"
      summary: "Create a Vision Event"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/vision-events/query":
    post:
      tags:
        - "Vision Events"
      operationId: "queryVisionEvents"
      summary: "Query Vision Events"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/vision-events/delete":
    post:
      tags:
        - "Vision Events"
      operationId: "deleteVisionEvents"
      summary: "Delete Vision Events"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
    post:
      tags:
        - "Vision Events"
      operationId: "createVisionEventUseCase"
      summary: "Create a Vision Event use case"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/monitoring-and-analytics/vision-events"
      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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
    post:
      tags:
        - "Deployment Manager"
      operationId: "registerDevice"
      summary: "Register a Deployment Manager device"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/deployment/self-hosted/enterprise/deployment-manager#http-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"
  "/{workspace}/model-evals":
    get:
      tags:
        - "Model evaluations"
      operationId: "listModelEvaluations"
      summary: "List model evaluations"
      description: "This operation is part of the public Roboflow Platform API."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/models/evaluate-trained-models#http-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"
  "/{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."
      externalDocs:
        description: "Read the guide"
        url: "https://docs.roboflow.com/platform/billing-and-plans/billing-folders#http-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"
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"
