Scale AI Fine Tuning Jobs V3 (Beta) API

openapi: 3.2.0
info:
  title: EGP API V4 Fine Tuning Jobs V3 (Beta) API
  description: This is the parent API for all EGP APIs. If you are looking for the EGP API, please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
- url: https://api.egp.scale.com
security: []
tags:
- name: Fine Tuning Jobs V3 (Beta)
paths:
  /v4/fine-tuning-jobs:
    post:
      tags:
      - Fine Tuning Jobs V3 (Beta)
      summary: Create Fine Tuning Job
      description: '### Description

        Model fine tuning jobs.


        ### Details


        TODO'
      operationId: POST-V4-/fine-tuning-jobs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FineTuningJobRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fine-tuning-jobs-v3-beta/create-fine-tuning-job
    get:
      tags:
      - Fine Tuning Jobs V3 (Beta)
      summary: List Fine Tuning Jobs
      description: '### Description

        Lists all fine tuning jobs accessible to the user.


        ### Details

        This API can be used to list fine tuning jobs. If a user has access to multiple accounts, all fine tuning jobs from all accounts the user is associated with will be returned.'
      operationId: GET-V4-/fine-tuning-jobs
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number for pagination to be returned by the given endpoint. Starts at page 1
          default: 1
          title: Page
        description: Page number for pagination to be returned by the given endpoint. Starts at page 1
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          description: Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
          default: 100
          title: Limit
        description: Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFineTuningJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fine-tuning-jobs-v3-beta/list-fine-tuning-jobs
  /v4/fine-tuning-jobs/{fine_tuning_job_id}:
    delete:
      tags:
      - Fine Tuning Jobs V3 (Beta)
      summary: Delete Fine Tuning Job
      description: '### Description

        Deletes a fine tuning job


        ### Details

        This API can be used to delete a fine tuning job by ID. To use this API, pass in the `id` that was returned from your Create Fine Tuning Job API call as a path parameter.'
      operationId: DELETE-V4-/fine-tuning-jobs/{fine_tuning_job_id}
      parameters:
      - name: fine_tuning_job_id
        in: path
        required: true
        schema:
          type: string
          title: Fine Tuning Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fine-tuning-jobs-v3-beta/delete-fine-tuning-job
    get:
      tags:
      - Fine Tuning Jobs V3 (Beta)
      summary: Get Fine Tuning Job
      description: '### Description

        Gets the details of a fine tuning job


        ### Details

        This API can be used to get information about a single fine tuning job by ID. To use this API, pass in the `id` that was returned from your Create Fine Tuning Job API call as a path parameter.


        Review the response schema to see the fields that will be returned.'
      operationId: GET-V4-/fine-tuning-jobs/{fine_tuning_job_id}
      parameters:
      - name: fine_tuning_job_id
        in: path
        required: true
        schema:
          type: string
          title: Fine Tuning Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FineTuningJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fine-tuning-jobs-v3-beta/get-fine-tuning-job
  /v4/fine-tuning-jobs/{fine_tuning_job_id}/events:
    get:
      tags:
      - Fine Tuning Jobs V3 (Beta)
      summary: Get fine tuning job events
      operationId: GET-V4-/fine-tuning-jobs/{fine_tuning_job_id}/events
      parameters:
      - name: fine_tuning_job_id
        in: path
        required: true
        schema:
          type: string
          title: Fine Tuning Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FineTuningJobEvent'
                title: Response Get-V4-/Fine-Tuning-Jobs/{Fine Tuning Job Id}/Events
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fine-tuning-jobs-v3-beta/get-fine-tuning-job-events
components:
  schemas:
    FineTuningJobResponse:
      properties:
        base_model_id:
          title: Base Model Id
          type: string
        vendor_configuration:
          $ref: '#/components/schemas/FineTuningJobVendorConfiguration'
        fine_tuned_model_id:
          title: Fine Tuned Model Id
          type: string
        training_dataset_id:
          type: string
          title: Training Dataset Id
        validation_dataset_id:
          title: Validation Dataset Id
          type: string
        status:
          $ref: '#/components/schemas/FineTuningJobStatus'
        id:
          type: string
          title: Id
          description: The unique identifier of the entity.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date and time when the entity was created in ISO format.
        account_id:
          type: string
          title: Account Id
          description: The ID of the account that owns the given entity.
          can_patch: false
        created_by_user_id:
          type: string
          title: Created By User Id
          description: The user who originally created the entity.
        created_by_identity_type:
          $ref: '#/components/schemas/IdentifierTypeEnum'
          description: The type of identity that created the entity.
      type: object
      required:
      - training_dataset_id
      - status
      - id
      - created_at
      - account_id
      - created_by_user_id
      - created_by_identity_type
      title: FineTuningJobResponse
    LaunchFineTuningJobConfiguration:
      properties:
        vendor:
          type: string
          const: LAUNCH
          title: Vendor
          default: LAUNCH
        hyperparameters:
          title: Hyperparameters
          additionalProperties: true
          type: object
        wandb_config:
          title: Wandb Config
          additionalProperties: true
          type: object
        suffix:
          title: Suffix
          type: string
        output:
          title: Output
          type: string
      type: object
      title: LaunchFineTuningJobConfiguration
    FineTuningJobEvent:
      properties:
        timestamp:
          title: Timestamp
          type: number
        message:
          type: string
          title: Message
        level:
          type: string
          title: Level
      type: object
      required:
      - message
      - level
      title: FineTuningJobEvent
    FineTuningJobVendorConfiguration:
      oneOf:
      - $ref: '#/components/schemas/LaunchFineTuningJobConfiguration'
      - $ref: '#/components/schemas/LLMEngineFineTuningJobConfiguration'
      - $ref: '#/components/schemas/OpenAIFineTuningJobConfiguration'
      title: FineTuningJobVendorConfiguration
      discriminator:
        propertyName: vendor
        mapping:
          LAUNCH: '#/components/schemas/LaunchFineTuningJobConfiguration'
          LLMENGINE: '#/components/schemas/LLMEngineFineTuningJobConfiguration'
          OPENAI: '#/components/schemas/OpenAIFineTuningJobConfiguration'
    FineTuningJobStatus:
      type: string
      enum:
      - PENDING
      - COMPLETED
      - FAILED
      - RUNNING
      - CANCELED
      title: FineTuningJobStatus
    LLMEngineFineTuningJobConfiguration:
      properties:
        vendor:
          type: string
          const: LLMENGINE
          title: Vendor
          default: LLMENGINE
        hyperparameters:
          title: Hyperparameters
          additionalProperties: true
          type: object
        wandb_config:
          title: Wandb Config
          additionalProperties: true
          type: object
        suffix:
          title: Suffix
          type: string
        output:
          title: Output
          type: string
      type: object
      title: LLMEngineFineTuningJobConfiguration
    OpenAIFineTuningJobConfiguration:
      properties:
        vendor:
          type: string
          const: OPENAI
          title: Vendor
          default: OPENAI
        hyperparameters:
          title: Hyperparameters
          additionalProperties: true
          type: object
        suffix:
          title: Suffix
          type: string
      type: object
      title: OpenAIFineTuningJobConfiguration
    PaginatedFineTuningJobResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/FineTuningJobResponse'
          type: array
          title: Items
          description: The data returned for the current page.
        total_item_count:
          type: integer
          title: Total Item Count
          description: The total number of items of the query
        current_page:
          type: integer
          title: Current Page
          description: The current page number.
        items_per_page:
          type: integer
          title: Items Per Page
          description: The number of items per page.
      type: object
      required:
      - items
      - total_item_count
      - current_page
      - items_per_page
      title: PaginatedFineTuningJobResponse
    IdentifierTypeEnum:
      type: string
      enum:
      - user
      - service_account
      title: IdentifierTypeEnum
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    DeleteResponse:
      properties:
        success:
          type: boolean
          title: Success
        count:
          type: integer
          title: Count
      type: object
      required:
      - success
      - count
      title: DeleteResponse
    FineTuningJobRequest:
      properties:
        base_model_id:
          title: Base Model Id
          type: string
        vendor_configuration:
          $ref: '#/components/schemas/FineTuningJobVendorConfiguration'
        fine_tuned_model_id:
          title: Fine Tuned Model Id
          type: string
        training_dataset_id:
          type: string
          title: Training Dataset Id
        validation_dataset_id:
          title: Validation Dataset Id
          type: string
        account_id:
          type: string
          title: Account Id
          description: The ID of the account that owns the given entity.
          can_patch: false
      type: object
      required:
      - training_dataset_id
      - account_id
      title: FineTuningJobRequest
    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
          additionalProperties: true
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
x-assembled-from: Per-operation OpenAPI fragments embedded verbatim in docs.gp.scale.com reference pages; source spec https://api.sgp.scale.com/openapi-versions/v4/openapi.json (404 when assembled)