ClearML Tasks API

openapi: 3.1.0
info:
  title: ClearML REST Auth Tasks API
  description: 'ClearML MLOps platform REST API. The server exposes a JSON-RPC-style REST

    surface where every operation is a POST against /<service>.<action> under

    /api/v2.<version>. Authenticate by calling /auth.login with API credentials

    to obtain a Bearer token, then send it in the Authorization header for all

    subsequent calls.

    '
  version: '2.30'
  contact:
    name: ClearML Documentation
    url: https://clear.ml/docs/latest/docs/references/api/index/
servers:
- url: https://api.clear.ml
  description: ClearML SaaS API
- url: https://{host}/api/v2.30
  description: Self-hosted ClearML Server
  variables:
    host:
      default: clearml.example.com
      description: ClearML server host
security:
- BearerAuth: []
tags:
- name: Tasks
paths:
  /tasks.create:
    post:
      summary: Create a task
      operationId: tasksCreate
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - type
              properties:
                name:
                  type: string
                type:
                  type: string
                project:
                  type: string
                comment:
                  type: string
                tags:
                  type: array
                  items:
                    type: string
                script:
                  type: object
                execution:
                  type: object
                hyperparams:
                  type: object
      responses:
        '200':
          description: Task created
  /tasks.get_by_id:
    post:
      summary: Get a task by id
      operationId: tasksGetById
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - task
              properties:
                task:
                  type: string
      responses:
        '200':
          description: Task
  /tasks.get_all:
    post:
      summary: Query tasks
      operationId: tasksGetAll
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Tasks list
  /tasks.edit:
    post:
      summary: Edit a task
      operationId: tasksEdit
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Edited
  /tasks.clone:
    post:
      summary: Clone a task
      operationId: tasksClone
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Cloned
  /tasks.delete:
    post:
      summary: Delete a task
      operationId: tasksDelete
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Deleted
  /tasks.enqueue:
    post:
      summary: Enqueue a task for execution
      operationId: tasksEnqueue
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                task:
                  type: string
                queue:
                  type: string
      responses:
        '200':
          description: Enqueued
  /tasks.dequeue:
    post:
      summary: Dequeue a task
      operationId: tasksDequeue
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Dequeued
  /tasks.started:
    post:
      summary: Mark a task as started (in_progress)
      operationId: tasksStarted
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
  /tasks.stopped:
    post:
      summary: Signal a task has stopped
      operationId: tasksStopped
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
  /tasks.completed:
    post:
      summary: Mark a task as completed
      operationId: tasksCompleted
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
  /tasks.failed:
    post:
      summary: Mark a task as failed
      operationId: tasksFailed
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
  /tasks.reset:
    post:
      summary: Reset a task to its initial state
      operationId: tasksReset
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Reset
  /tasks.publish:
    post:
      summary: Publish a task
      operationId: tasksPublish
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Published
  /tasks.add_or_update_artifacts:
    post:
      summary: Add or update artifacts on a task
      operationId: tasksAddOrUpdateArtifacts
      tags:
      - Tasks
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Updated
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token obtained from /auth.login
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with access_key / secret_key for /auth.login