Scale AI package deployments API

openapi: 3.2.0
info:
  title: EGP API V4 package deployments 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: package deployments
paths:
  /v4/deployment-packages/{account_id}/copy-to-control-plane-hook:
    post:
      tags:
      - package deployments
      summary: Copy a deployment package to control plane hook
      operationId: POST-V4-/deployment-packages/{account_id}/copy-to-control-plane-hook
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyDeploymentPackageToControlPlaneHookRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CopyDeploymentPackageToControlPlaneHookResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/package-deployments/copy-a-deployment-package-to-control-plane-hook
  /v4/deployment-packages/{account_id}/install_async:
    post:
      tags:
      - package deployments
      summary: Install a deployment packages
      operationId: POST-V4-/deployment-packages/{account_id}/install_async
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallDeploymentPackageRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentPackageJobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/package-deployments/install-a-deployment-packages-1
  /v4/deployment-packages/{account_id}/install:
    post:
      tags:
      - package deployments
      summary: Install a deployment packages
      operationId: POST-V4-/deployment-packages/{account_id}/install
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallDeploymentPackageRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallDeploymentPackageResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/package-deployments/install-a-deployment-packages
  /v4/deployment-packages/{account_id}/verify-install-prerequisites-met:
    post:
      tags:
      - package deployments
      summary: Verify that the prerequisites for installing a specific package version are met
      description: 'This endpoint verifies that installation prerequisites are met for a specific package version.

        The input is the same as for package installations, but the response may be a synchronous one

        if the package version has no prerequisites.'
      operationId: POST-V4-/deployment-packages/{account_id}/verify-install-prerequisites-met
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyPackageVersionPrerequisitesRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/DeploymentPackageJobResponse'
                - type: 'null'
                title: Response Post-V4-/Deployment-Packages/{Account Id}/Verify-Install-Prerequisites-Met
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/package-deployments/verify-that-the-prerequisites-for-installing-a-specific-package-version-are-met
components:
  schemas:
    DeploymentPackageType:
      type: string
      enum:
      - EGP_CONFIGURATION
      - BLOB_STORAGE_FILE
      - DOCKER_IMAGE
      - EGP_ENTITY
      - EGP_USER
      - INTERNAL_MODEL_INFO
      - EVALUATION_DATASET
      - MODEL
      - KNOWLEDGE_BASE
      - AGENTS_CONFIG
      title: DeploymentPackageType
    VerifyPackageVersionPrerequisitesRequest:
      properties:
        package_version_id:
          type: string
          title: Package Version Id
      type: object
      required:
      - package_version_id
      title: VerifyPackageVersionPrerequisitesRequest
    TimestampMinVersion:
      properties:
        version_constraint_type:
          type: string
          const: TIMESTAMP_MIN
          title: Version Constraint Type
          default: TIMESTAMP_MIN
        minimum_timestamp:
          type: string
          title: Minimum Timestamp
      type: object
      required:
      - minimum_timestamp
      title: TimestampMinVersion
    DeploymentPackageInstallationEntity:
      properties:
        organization_id:
          type: string
          title: Organization Id
          description: The identifier of the organization.
        package_version_id:
          type: string
          title: Package Version Id
          description: The package version which is installed
        status:
          $ref: '#/components/schemas/InstallationStatus'
        install_log:
          title: Install Log
          description: output of installation step
          type: string
        state:
          title: State
          description: Properties of the installation, must match schema of the package type.
          additionalProperties: true
          type: object
        account_id:
          title: Account Id
          description: The ID of the account to which the installed package belongs. Unset for non-EGP entity deployment packages.
          type: string
        deleted_at:
          title: Deleted At
          description: The date and time when the entity was deleted in ISO format.
          type: string
          format: date-time
        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.
        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.
      additionalProperties: true
      type: object
      required:
      - organization_id
      - package_version_id
      - id
      - created_at
      - created_by_user_id
      - created_by_identity_type
      title: DeploymentPackageInstallationEntity
    InstallationStatus:
      type: string
      enum:
      - INSTALLED
      - UNINSTALLED
      - IN_PROGRESS
      - FAILED
      title: InstallationStatus
    SemVerMinVersion:
      properties:
        version_constraint_type:
          type: string
          const: SEMVER_MIN
          title: Version Constraint Type
          default: SEMVER_MIN
        minimum_version:
          type: string
          title: Minimum Version
      type: object
      required:
      - minimum_version
      title: SemVerMinVersion
    ExactVersion:
      properties:
        version_constraint_type:
          type: string
          const: EXACT_VERSION
          title: Version Constraint Type
          default: EXACT_VERSION
        package_version_id:
          type: string
          title: Package Version Id
      type: object
      required:
      - package_version_id
      title: ExactVersion
    InstallDeploymentPackageRequest:
      properties:
        deployment_package_id:
          title: Deployment Package Id
          type: string
        deployment_package_name:
          title: Deployment Package Name
          type: string
        deployment_package_type:
          $ref: '#/components/schemas/DeploymentPackageType'
        version_constraint:
          $ref: '#/components/schemas/PackageVersionConstraint'
      type: object
      title: InstallDeploymentPackageRequest
    CopyDeploymentPackageToControlPlaneHookRequest:
      properties:
        deployment_package_id:
          title: Deployment Package Id
          type: string
        deployment_package_name:
          title: Deployment Package Name
          type: string
        deployment_package_type:
          $ref: '#/components/schemas/DeploymentPackageType'
        version_constraint:
          $ref: '#/components/schemas/PackageVersionConstraint'
        workspace:
          type: string
          title: Workspace
      type: object
      required:
      - workspace
      title: CopyDeploymentPackageToControlPlaneHookRequest
    InstallDeploymentPackageResponse:
      properties:
        package_installation:
          $ref: '#/components/schemas/DeploymentPackageInstallationEntity'
      type: object
      required:
      - package_installation
      title: InstallDeploymentPackageResponse
    CopyToControlPlaneHookResult:
      properties:
        status:
          $ref: '#/components/schemas/CopyToControlPlaneHookStatus'
        message:
          type: string
          title: Message
        metadata:
          title: Metadata
          additionalProperties: true
          type: object
      type: object
      required:
      - status
      title: CopyToControlPlaneHookResult
    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
    CopyToControlPlaneHookStatus:
      type: string
      enum:
      - SUCCESS
      - FAILED
      - SKIPPED
      - NO_HOOK_DEFINED
      title: CopyToControlPlaneHookStatus
    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
    DeploymentPackageJobResponse:
      properties:
        deployment_package_job_id:
          type: string
          title: Deployment Package Job Id
        account_id:
          type: string
          title: Account Id
      type: object
      required:
      - deployment_package_job_id
      title: DeploymentPackageJobResponse
    PackageVersionConstraint:
      oneOf:
      - $ref: '#/components/schemas/SemVerMinVersion'
      - $ref: '#/components/schemas/TimestampMinVersion'
      - $ref: '#/components/schemas/ExactVersion'
      title: PackageVersionConstraint
      discriminator:
        propertyName: version_constraint_type
        mapping:
          EXACT_VERSION: '#/components/schemas/ExactVersion'
          SEMVER_MIN: '#/components/schemas/SemVerMinVersion'
          TIMESTAMP_MIN: '#/components/schemas/TimestampMinVersion'
    CopyDeploymentPackageToControlPlaneHookResponse:
      properties:
        package_id:
          type: string
          title: Package Id
        package_name:
          type: string
          title: Package Name
        result:
          $ref: '#/components/schemas/CopyToControlPlaneHookResult'
        error:
          title: Error
          type: string
      type: object
      required:
      - package_id
      - package_name
      title: CopyDeploymentPackageToControlPlaneHookResponse
  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)