Probabl Projects API

openapi: 3.2.0
info:
  title: Skore Hub Projects API
  description: "\nThis REST API is divided in small services.\nEach service has its own OpenAPI specification.\n- [identity](/identity/docs)\n- [projects](/projects/docs)\n    "
  version: 0.1.0
tags:
- name: projects
paths:
  /projects/{workspace_public_id}/{project_name}:
    post:
      tags:
      - projects
      summary: Create Project
      description: Create a project; idempotent (201 created, 208 already exists).
      operationId: create_project_projects__workspace_public_id___project_name__post
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 150
          description: The project name.
          title: Project Name
        description: The project name.
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  anyOf:
                  - type: integer
                  - type: string
                title: Response Create Project Projects  Workspace Public Id   Project Name  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - projects
      summary: Get Project
      description: Endpoint to read a project from its ID.
      operationId: get_project_projects__workspace_public_id___project_name__get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 150
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - projects
      summary: Delete Project
      description: Endpoint to delete a project.
      operationId: delete_project_projects__workspace_public_id___project_name__delete
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 150
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}:
    get:
      tags:
      - projects
      summary: List Workspace Projects
      description: Endpoint to list projects.
      operationId: list_workspace_projects_projects__workspace_public_id__get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 64
          title: Workspace Public Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
                title: Response List Workspace Projects Projects  Workspace Public Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/admin:
    get:
      tags:
      - projects
      summary: List All Projects
      description: Endpoint to list all projects.
      operationId: list_all_projects_projects_admin_get
      parameters:
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Project'
                title: Response List All Projects Projects Admin Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/reports:
    get:
      tags:
      - projects
      summary: List Reports
      description: "List estimator and cross-validation report summaries for a project.\n\nSupports equality filters, metric range filters, sorting by one column, and\ncursor pagination. Report kind is encoded in each item's ``urn``.\n\n**Metric filters and ``sort_by``**\n\nAlways use the *base* metric name — never a ``_mean`` suffix — even when the\nproject only contains cross-validation reports.\n\n- Example: ``accuracy__gte=0.8`` and ``sort_by=accuracy`` match estimator\n  metrics named ``accuracy`` and CV aggregates named ``accuracy_mean``.\n- Do **not** use ``accuracy_mean__gte`` / ``sort_by=accuracy_mean``.\n- Std aggregates keep their suffix: ``accuracy_std__gte`` /\n  ``sort_by=accuracy_std``.\n\nOptional variant constraints disambiguate multiclass / multioutput metrics:\n\n- ``precision__label=1``\n- ``r2__output=0``\n- ``recall__average=macro``\n\nMetric values in the response follow the same rule: CV ``*_mean`` metrics are\nexposed under the base name (e.g. ``accuracy_mean`` → ``accuracy``)."
      operationId: list_reports_projects__workspace_public_id___project_name__reports_get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: canonical_report_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              anyOf:
              - type: string
                format: uuid4
              - type: string
                format: uuid7
          - type: 'null'
          title: Canonical Report Ids
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 10
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          title: Cursor
      - name: sort
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/SortOrder'
          default: DESC
      - name: sort_by
        in: query
        required: false
        schema:
          type: string
          default: created_at
          title: Sort By
      - name: key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Key
      - name: creator_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Creator Id
      - name: dataset_fingerprint
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataset Fingerprint
      - name: report_type
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - estimator
            - cross-validation
            type: string
          - type: 'null'
          title: Report Type
      - name: data_source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Source
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - type: array
                items:
                  anyOf:
                  - type: string
                    format: uuid4
                  - type: string
                    format: uuid7
              - type: 'null'
              title: Canonical Report Ids
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReportsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/estimator-reports:
    get:
      tags:
      - projects
      summary: Filter
      description: Endpoint to list every project's estimator reports.
      operationId: filter_projects__workspace_public_id___project_name__estimator_reports_get
      deprecated: true
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: dataset_fingerprint
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataset Fingerprint
      - name: ml_task
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ml Task
      - name: estimator_class_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Estimator Class Name
      - name: data_source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Source
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          default: 100
          title: Limit
      - name: cursor_created_at
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Cursor Created At
      - name: cursor_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 1
          - type: 'null'
          title: Cursor Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EstimatorReportSummary'
                title: Response Filter Projects  Workspace Public Id   Project Name  Estimator Reports Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - projects
      summary: Create
      description: 'Create a new estimator report.


        **Parameters**

        - `workspace_public_id`: The workspace owner of the project

        - `project_name`: The project to query


        **Responses**

        - `201`: The ID of the created estimator report.

        - `400`: Invalid input data.

        - `404`: The project was not found.'
      operationId: create_projects__workspace_public_id___project_name__estimator_reports_post
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEstimatorReportParameters'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/estimator-reports/groups:
    get:
      tags:
      - projects
      summary: List Groups
      description: 'List all estimator reports stored in a project.


        Reports are grouped by dataset fingerprint and sorted by ascending

        report creation date.


        This route is a lightweight overview of the available estimator reports.

        To get more details about estimator report, use the `get_estimator_report` route.


        **Parameters**

        - `workspace_public_id`: The workspace owner of the project

        - `project_name`: The project to query


        **Responses**

        - `200`: A list of estimator reports, grouped by dataset fingerprint.'
      operationId: list_groups_projects__workspace_public_id___project_name__estimator_reports_groups_get
      deprecated: true
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportGroup'
                title: Response List Groups Projects  Workspace Public Id   Project Name  Estimator Reports Groups Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/estimator-reports/{report_id}:
    get:
      tags:
      - projects
      summary: Get
      description: 'Get a specific estimator report by its ID.


        **Parameters**

        - `workspace_public_id`: The workspace owner of the project

        - `project_name`: The project to query

        - `report_id`: The ID of the estimator report


        **Responses**

        - `200`: The requested estimator report.

        - `404`: The estimator report was not found.'
      operationId: get_projects__workspace_public_id___project_name__estimator_reports__report_id__get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimatorReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/cross-validation-reports:
    post:
      tags:
      - projects
      summary: Create
      description: Create a new cross validation report.
      operationId: create_projects__workspace_public_id___project_name__cross_validation_reports_post
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCrossValidationReportParameters'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - projects
      summary: Filter
      description: List all cross-validation reports for a given dataset.
      operationId: filter_projects__workspace_public_id___project_name__cross_validation_reports_get
      deprecated: true
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: dataset_fingerprint
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Dataset Fingerprint
      - name: ml_task
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ml Task
      - name: estimator_class_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Estimator Class Name
      - name: data_source
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Data Source
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CrossValidationReportSummary'
                title: Response Filter Projects  Workspace Public Id   Project Name  Cross Validation Reports Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/cross-validation-reports/groups:
    get:
      tags:
      - projects
      summary: List Groups
      description: 'List all cross validation reports stored in a project.


        CV reports are grouped by dataset fingerprint and sorted by ascending

        report creation date.


        This route is a lightweight overview of the available cross validation reports.

        To get more details about cross validation report,

        use the `get_cross_validation_report` route.


        **Parameters**

        - `workspace_public_id`: The workspace owner of the project

        - `project_name`: The project to query


        **Responses**

        - `200`: A list of cross validation reports, grouped by dataset fingerprint.'
      operationId: list_groups_projects__workspace_public_id___project_name__cross_validation_reports_groups_get
      deprecated: true
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportGroup'
                title: Response List Groups Projects  Workspace Public Id   Project Name  Cross Validation Reports Groups Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/cross-validation-reports/{report_id}:
    get:
      tags:
      - projects
      summary: Get Cross Validation Report
      description: 'Return details about a given cross validation report.


        Including:

        * metrics

        * related items

        * splits

        * split strategy

        * estimator ids'
      operationId: get_cross_validation_report_projects__workspace_public_id___project_name__cross_validation_reports__report_id__get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CrossValidationReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/comparison-reports:
    get:
      tags:
      - projects
      summary: Filter
      description: List all comparisons of a given project.
      operationId: filter_projects__workspace_public_id___project_name__comparison_reports_get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComparisonReport'
                title: Response Filter Projects  Workspace Public Id   Project Name  Comparison Reports Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - projects
      summary: Create
      description: Create a comparison report.
      operationId: create_projects__workspace_public_id___project_name__comparison_reports_post
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComparisonReportParameters'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/comparison-reports/{report_id}:
    get:
      tags:
      - projects
      summary: Get
      description: Get a comparison of a given project.
      operationId: get_projects__workspace_public_id___project_name__comparison_reports__report_id__get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComparisonReport'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - projects
      summary: Delete
      description: Get a comparison of a given project.
      operationId: delete_projects__workspace_public_id___project_name__comparison_reports__report_id__delete
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: report_id
        in: path
        required: true
        schema:
          type: integer
          title: Report Id
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /projects/{workspace_public_id}/{project_name}/artifacts:
    post:
      tags:
      - projects
      summary: Generate Upload Url
      description: 'Generate a list of upload urls to add artifacts into a given project.


        If an artifact with the given checksum already exists and is fully uploaded,

        no new upload URL will be generated to maintain artifact integrity and immutability.'
      operationId: generate_upload_url_projects__workspace_public_id___project_name__artifacts_post
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: config_file
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Config File
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/GenerateUploadUrlRequest'
              title: Upload Request
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GenerateUploadUrlResponse'
                title: Response Generate Upload Url Projects  Workspace Public Id   Project Name  Artifacts Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - projects
      summary: Filter
      description: Return a list of stored artifacts for a given set of project, item/report.
      operationId: filter_projects__workspace_public_id___project_name__artifacts_get
      parameters:
      - name: workspace_public_id
        in: path
        required: true
        schema:
          type: string
          title: Workspace Public Id
      - name: project_name
        in: path
        required: true
        schema:
          type: string
          title: Project Name
      - name: artifact_checksum
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: st

# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/probabl/refs/heads/main/openapi/probabl-projects-api-openapi.yml