Lium Default Jobs API

The Default Jobs API from Lium — 5 operation(s) for default jobs.

GitHub OpenAPI

Operations 7

GET /default-jobs/page Get Default Jobs Page #
POST /default-jobs Create Default Job #
PATCH /default-jobs/{job_id} Update Default Job #
DELETE /default-jobs/{job_id} Delete Default Job #
PUT /default-jobs/assignments/{executor_id} Assign Default Job #
DELETE /default-jobs/assignments/{executor_id} Clear Default Job Assignment #
POST /default-jobs/assignments/bulk Bulk Assign Default Jobs #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/lium-io:lium-io-default-jobs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lium-io-default-jobs-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Lium Miner Portal Default Jobs API
  version: 0.1.0
servers:
- url: /api
tags:
- name: Default Jobs
paths:
  /default-jobs/page:
    get:
      tags:
      - Default Jobs
      summary: Get Default Jobs Page
      operationId: get_default_jobs_page_default_jobs_page_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultJobsPageResponse'
      security:
      - JwtAccessBearer: []
  /default-jobs:
    post:
      tags:
      - Default Jobs
      summary: Create Default Job
      operationId: create_default_job_default_jobs_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultJobCreatePayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_DefaultJobResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - JwtAccessBearer: []
  /default-jobs/{job_id}:
    patch:
      tags:
      - Default Jobs
      summary: Update Default Job
      operationId: update_default_job_default_jobs__job_id__patch
      security:
      - JwtAccessBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Job Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultJobUpdatePayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_DefaultJobResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Default Jobs
      summary: Delete Default Job
      operationId: delete_default_job_default_jobs__job_id__delete
      security:
      - JwtAccessBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_dict_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /default-jobs/assignments/{executor_id}:
    put:
      tags:
      - Default Jobs
      summary: Assign Default Job
      operationId: assign_default_job_default_jobs_assignments__executor_id__put
      security:
      - JwtAccessBearer: []
      parameters:
      - name: executor_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Executor Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultJobAssignmentPayload'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_DefaultJobAssignmentResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Default Jobs
      summary: Clear Default Job Assignment
      operationId: clear_default_job_assignment_default_jobs_assignments__executor_id__delete
      security:
      - JwtAccessBearer: []
      parameters:
      - name: executor_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Executor Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_dict_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /default-jobs/assignments/bulk:
    post:
      tags:
      - Default Jobs
      summary: Bulk Assign Default Jobs
      operationId: bulk_assign_default_jobs_default_jobs_assignments_bulk_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DefaultJobBulkAssignmentPayload'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_DefaultJobBulkAssignmentResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - JwtAccessBearer: []
components:
  schemas:
    DefaultJobsPageResponse:
      properties:
        templates:
          items:
            $ref: '#/components/schemas/DefaultJobTemplateResponse'
          type: array
          title: Templates
        jobs:
          items:
            $ref: '#/components/schemas/DefaultJobResponse'
          type: array
          title: Jobs
        assignments:
          items:
            $ref: '#/components/schemas/DefaultJobAssignmentResponse'
          type: array
          title: Assignments
        activity:
          items:
            $ref: '#/components/schemas/DefaultJobActivityResponse'
          type: array
          title: Activity
        summary:
          $ref: '#/components/schemas/DefaultJobSummaryResponse'
      type: object
      required:
      - templates
      - jobs
      - assignments
      - summary
      title: DefaultJobsPageResponse
    DefaultJobActivityResponse:
      properties:
        id:
          type: string
          title: Id
        executor_id:
          type: string
          format: uuid
          title: Executor Id
        event_type:
          type: string
          title: Event Type
        title:
          type: string
          title: Title
        started_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Started At
        ended_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Ended At
        duration_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Seconds
        outcome:
          type: string
          title: Outcome
        detail:
          anyOf:
          - type: string
          - type: 'null'
          title: Detail
        amount:
          anyOf:
          - type: number
          - type: 'null'
          title: Amount
        paid_as_idle_pay:
          type: boolean
          title: Paid As Idle Pay
          default: false
        billing_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Billing Count
        default_job_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Default Job Gpu Count
        node_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Node Gpu Count
      type: object
      required:
      - id
      - executor_id
      - event_type
      - title
      - outcome
      title: DefaultJobActivityResponse
    DefaultJobResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        job_type:
          $ref: '#/components/schemas/DefaultJobType'
        source_template_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Template Version
        docker_image:
          type: string
          title: Docker Image
        docker_image_tag:
          type: string
          title: Docker Image Tag
        startup_commands:
          anyOf:
          - type: string
          - type: 'null'
          title: Startup Commands
        environment:
          additionalProperties:
            type: string
          type: object
          title: Environment
        environment_keys:
          items:
            type: string
          type: array
          title: Environment Keys
        volumes:
          items:
            type: string
          type: array
          title: Volumes
        internal_ports:
          items:
            type: integer
          type: array
          title: Internal Ports
        min_disk_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Disk Gb
        min_vram_mb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Vram Mb
        min_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Gpu Count
        storage_limit_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Storage Limit Gb
        enabled:
          type: boolean
          title: Enabled
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
      type: object
      required:
      - id
      - name
      - job_type
      - docker_image
      - docker_image_tag
      - enabled
      - created_at
      title: DefaultJobResponse
    DefaultJobType:
      type: string
      enum:
      - PEARL_MINING
      - CUSTOM_DOCKER
      title: DefaultJobType
    DefaultJobTemplateResponse:
      properties:
        job_type:
          $ref: '#/components/schemas/DefaultJobType'
        label:
          type: string
          title: Label
        available:
          type: boolean
          title: Available
        source_template_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Template Version
        docker_image:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image
        docker_image_tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image Tag
        startup_commands:
          anyOf:
          - type: string
          - type: 'null'
          title: Startup Commands
        volumes:
          items:
            type: string
          type: array
          title: Volumes
        internal_ports:
          items:
            type: integer
          type: array
          title: Internal Ports
        min_vram_mb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Vram Mb
        min_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Gpu Count
        storage_limit_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Storage Limit Gb
        required_environment:
          items:
            type: string
          type: array
          title: Required Environment
        editable_fields:
          items:
            type: string
          type: array
          title: Editable Fields
      type: object
      required:
      - job_type
      - label
      - available
      title: DefaultJobTemplateResponse
    DefaultJobBulkAssignmentPayload:
      properties:
        executor_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Executor Ids
        default_job_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Default Job Id
        enabled:
          type: boolean
          title: Enabled
          default: true
      type: object
      required:
      - executor_ids
      title: DefaultJobBulkAssignmentPayload
    DefaultJobSummaryResponse:
      properties:
        job_profile_count:
          type: integer
          title: Job Profile Count
        assigned_node_count:
          type: integer
          title: Assigned Node Count
        running_now_count:
          type: integer
          title: Running Now Count
          default: 0
        needs_attention_count:
          type: integer
          title: Needs Attention Count
          default: 0
      type: object
      required:
      - job_profile_count
      - assigned_node_count
      title: DefaultJobSummaryResponse
    DefaultJobBulkAssignmentResponse:
      properties:
        updated_executor_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Updated Executor Ids
        skipped:
          items:
            $ref: '#/components/schemas/DefaultJobSkippedAssignmentResponse'
          type: array
          title: Skipped
      type: object
      required:
      - updated_executor_ids
      - skipped
      title: DefaultJobBulkAssignmentResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
          description: Error code identifier
        message:
          type: string
          title: Message
          description: Human readable error message
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
          description: Additional error details
      type: object
      required:
      - code
      - message
      title: ErrorDetail
      description: Standard error detail structure
    ApiResponse_DefaultJobAssignmentResponse_:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether the request was successful
        data:
          anyOf:
          - $ref: '#/components/schemas/DefaultJobAssignmentResponse'
          - type: 'null'
          description: Response data
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
          description: Error details if unsuccessful
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Response timestamp
      type: object
      required:
      - success
      title: ApiResponse[DefaultJobAssignmentResponse]
    DefaultJobUpdatePayload:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        environment:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Environment
        enabled:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Enabled
        docker_image:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image
        docker_image_tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image Tag
        startup_commands:
          anyOf:
          - type: string
          - type: 'null'
          title: Startup Commands
        volumes:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Volumes
        internal_ports:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Internal Ports
        min_vram_mb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Vram Mb
        min_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Gpu Count
        storage_limit_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Storage Limit Gb
      type: object
      title: DefaultJobUpdatePayload
    DefaultJobCreatePayload:
      properties:
        name:
          type: string
          title: Name
        job_type:
          $ref: '#/components/schemas/DefaultJobType'
        source_template_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Template Version
        environment:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Environment
        enabled:
          type: boolean
          title: Enabled
          default: true
        docker_image:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image
        docker_image_tag:
          anyOf:
          - type: string
          - type: 'null'
          title: Docker Image Tag
        startup_commands:
          anyOf:
          - type: string
          - type: 'null'
          title: Startup Commands
        volumes:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Volumes
        internal_ports:
          anyOf:
          - items:
              type: integer
            type: array
          - type: 'null'
          title: Internal Ports
        min_vram_mb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Vram Mb
        min_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Min Gpu Count
        storage_limit_gb:
          anyOf:
          - type: integer
          - type: 'null'
          title: Storage Limit Gb
      type: object
      required:
      - name
      - job_type
      title: DefaultJobCreatePayload
    DefaultJobAssignmentPayload:
      properties:
        default_job_id:
          type: string
          format: uuid
          title: Default Job Id
        enabled:
          type: boolean
          title: Enabled
          default: true
      type: object
      required:
      - default_job_id
      title: DefaultJobAssignmentPayload
    DefaultJobSkippedAssignmentResponse:
      properties:
        executor_id:
          type: string
          format: uuid
          title: Executor Id
        reason:
          type: string
          title: Reason
      type: object
      required:
      - executor_id
      - reason
      title: DefaultJobSkippedAssignmentResponse
    DefaultJobAssignmentResponse:
      properties:
        executor_id:
          type: string
          format: uuid
          title: Executor Id
        assignment_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Assignment Id
        default_job_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Default Job Id
        default_job_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Job Name
        enabled:
          type: boolean
          title: Enabled
          default: false
        active:
          type: boolean
          title: Active
          default: true
        gpu_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Gpu Type
        gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Gpu Count
        default_job_gpu_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Default Job Gpu Count
        machine_state:
          type: string
          title: Machine State
          default: unknown
        runtime_status:
          type: string
          title: Runtime Status
          default: no_default_job
        active_filler_run_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Active Filler Run Id
        last_runtime_status:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Runtime Status
        last_runtime_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Runtime At
        last_failure_reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Last Failure Reason
        runtime_seconds_today:
          type: integer
          title: Runtime Seconds Today
          default: 0
      type: object
      required:
      - executor_id
      title: DefaultJobAssignmentResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ApiResponse_DefaultJobBulkAssignmentResponse_:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether the request was successful
        data:
          anyOf:
          - $ref: '#/components/schemas/DefaultJobBulkAssignmentResponse'
          - type: 'null'
          description: Response data
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
          description: Error details if unsuccessful
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Response timestamp
      type: object
      required:
      - success
      title: ApiResponse[DefaultJobBulkAssignmentResponse]
    ApiResponse_dict_:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether the request was successful
        data:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Data
          description: Response data
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
          description: Error details if unsuccessful
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Response timestamp
      type: object
      required:
      - success
      title: ApiResponse[dict]
    ApiResponse_DefaultJobResponse_:
      properties:
        success:
          type: boolean
          title: Success
          description: Whether the request was successful
        data:
          anyOf:
          - $ref: '#/components/schemas/DefaultJobResponse'
          - type: 'null'
          description: Response data
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
          description: Error details if unsuccessful
        timestamp:
          type: string
          format: date-time
          title: Timestamp
          description: Response timestamp
      type: object
      required:
      - success
      title: ApiResponse[DefaultJobResponse]
  securitySchemes:
    JwtAccessBearer:
      type: http
      scheme: bearer
    HTTPBearer:
      type: http
      scheme: bearer