Scale AI Serving API

openapi: 3.2.0
info:
  title: EGP API V4 Serving 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: Serving
paths:
  /v4/serving/{model_server_id}:
    delete:
      summary: Delete a Model Server
      operationId: DELETE-V4-/v4/serving/{model_server_id}
      parameters:
      - name: model_server_id
        in: path
        required: true
        schema:
          type: string
          title: Model Server Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/delete-a-model-server
      tags:
      - Serving
    get:
      summary: Fixed Server interface for Model execution by named alias
      operationId: GET-V4-/v4/serving/{model_server_id}
      parameters:
      - name: model_server_id
        in: path
        required: true
        schema:
          type: string
          title: Model Server Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelServerInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fixed-server-interface-for-model-execution-by-named-alias-1
      tags:
      - Serving
  /v4/serving/a/{alias}:
    get:
      summary: Fixed Server interface for Model execution by named alias
      operationId: GET-V4-/v4/serving/a/{alias}
      parameters:
      - name: alias
        in: path
        required: true
        schema:
          title: Alias
          type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelServerInfo'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/fixed-server-interface-for-model-execution-by-named-alias-2
      tags:
      - Serving
  /v4/serving:
    get:
      summary: Fixed Server interface for Model execution by named alias
      operationId: GET-V4-/v4/serving
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListModelServerResponse'
      x-source: https://docs.gp.scale.com/reference/v4/fixed-server-interface-for-model-execution-by-named-alias
      tags:
      - Serving
components:
  schemas:
    ListModelServerResponse:
      items:
        $ref: '#/components/schemas/ModelServerInfo'
      type: array
      title: ListModelServerResponse
    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
    ModelServerInfo:
      properties:
        name:
          type: string
          title: Name
        model_server_id:
          type: string
          title: Model Server Id
        model_deployment_id:
          title: Model Deployment Id
          type: string
        account_id:
          type: string
          title: Account Id
        alias:
          title: Alias
          type: string
      type: object
      required:
      - name
      - model_server_id
      - account_id
      title: ModelServerInfo
      description: 'Model server information.

        name: The name of the model server. Only used for display purposes.

        model_server_id: The ID of the model server.

        model_deployment_id: The ID of the model deployment being used as the backend.

        account_id: The ID of the account that owns the model server.

        alias: An alias for the model server. If configured the model server can be accessed via the alias instead of the model server ID. i.e /models/server/alias/{alias}/execute'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  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)