ClearML Events API

openapi: 3.1.0
info:
  title: ClearML REST Auth Events 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: Events
paths:
  /events.add:
    post:
      summary: Add an event
      operationId: eventsAdd
      tags:
      - Events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Added
  /events.add_batch:
    post:
      summary: Add a batch of events
      operationId: eventsAddBatch
      tags:
      - Events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Added
  /events.get_task_metrics:
    post:
      summary: Get metrics for a task
      operationId: eventsGetTaskMetrics
      tags:
      - Events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Metrics
  /events.get_scalar_metric_data:
    post:
      summary: Get scalar metric data for a task
      operationId: eventsGetScalarMetricData
      tags:
      - Events
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Metric data
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