Scale AI Application Specs API

openapi: 3.2.0
info:
  title: EGP API V4 Application Specs 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: Application Specs
paths:
  /v4/application-specs:
    post:
      tags:
      - Application Specs
      summary: Create Application Spec
      description: '### Description

        Creates a application spec


        ### Details

        This API can be used to create a application spec. To use this API, review the request schema and pass in all fields that are required to create a application spec.'
      operationId: POST-V4-/application-specs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSpecRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/egp_api_backend__server__api__models__application_models_no_gen__ApplicationSpecResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/application-specs/create-application-spec
    get:
      tags:
      - Application Specs
      summary: List Application Specs
      description: '### Description

        Lists all application specs accessible to the user.


        ### Details

        This API can be used to list application specs. If a user has access to multiple accounts, all application specs from all accounts the user is associated with will be returned.'
      operationId: GET-V4-/application-specs
      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.
      - name: include_archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Archived
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedApplicationSpecResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/application-specs/list-application-specs
  /v4/application-specs/{application_spec_id}:
    delete:
      tags:
      - Application Specs
      summary: Delete Application Spec
      description: '### Description

        Deletes a application spec


        ### Details

        This API can be used to delete a application spec by ID. To use this API, pass in the `id` that was returned from your Create Application Spec API call as a path parameter.'
      operationId: DELETE-V4-/application-specs/{application_spec_id}
      parameters:
      - name: application_spec_id
        in: path
        required: true
        schema:
          type: string
          title: Application Spec 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/application-specs/delete-application-spec
    get:
      tags:
      - Application Specs
      summary: Get Application Spec
      description: '### Description

        Gets the details of a application spec


        ### Details

        This API can be used to get information about a single application spec by ID. To use this API, pass in the `id` that was returned from your Create Application Spec API call as a path parameter.


        Review the response schema to see the fields that will be returned.'
      operationId: GET-V4-/application-specs/{application_spec_id}
      parameters:
      - name: application_spec_id
        in: path
        required: true
        schema:
          type: string
          title: Application Spec Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/egp_api_backend__server__api__models__application_models_no_gen__ApplicationSpecResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/application-specs/get-application-spec
    patch:
      tags:
      - Application Specs
      summary: Update Application Spec
      description: '### Description

        Updates a application spec


        ### Details

        This API can be used to update the application spec that matches the ID that was passed in as a path parameter. To use this API, pass in the `id` that was returned from your Create Application Spec API call as a path parameter.


        Review the request schema to see the fields that can be updated.'
      operationId: PATCH-V4-/application-specs/{application_spec_id}
      parameters:
      - name: application_spec_id
        in: path
        required: true
        schema:
          type: string
          title: Application Spec Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestorablePartialApplicationSpecRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/egp_api_backend__server__api__models__application_models_no_gen__ApplicationSpecResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-source: https://docs.gp.scale.com/reference/v4/application-specs/update-application-spec
components:
  schemas:
    PaginatedApplicationSpecResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/egp_api_backend__server__api__models__application_models_no_gen__ApplicationSpecResponse'
          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: PaginatedApplicationSpecResponse
    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
    ApplicationSpecRequest:
      properties:
        name:
          type: string
          title: Name
          description: The name of the Application Spec
        description:
          type: string
          title: Description
          description: The description of the Application Spec
        theme_id:
          title: Theme Id
          can_patch: true
          type: string
        run_online_evaluation:
          title: Run Online Evaluation
          description: Whether the application spec should run online evaluation, default is `false`
          default: false
          type: boolean
        account_id:
          type: string
          title: Account Id
          description: The ID of the account that owns the given entity.
          can_patch: false
      type: object
      required:
      - name
      - description
      - account_id
      title: ApplicationSpecRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RestoreRequest:
      properties:
        restore:
          type: boolean
          const: true
          title: Restore
          description: Set to true to restore the entity from the database.
      additionalProperties: false
      type: object
      required:
      - restore
      title: RestoreRequest
    IdentifierTypeEnum:
      type: string
      enum:
      - user
      - service_account
      title: IdentifierTypeEnum
    DeleteResponse:
      properties:
        success:
          type: boolean
          title: Success
        count:
          type: integer
          title: Count
      type: object
      required:
      - success
      - count
      title: DeleteResponse
    RestorablePartialApplicationSpecRequest:
      oneOf:
      - $ref: '#/components/schemas/PartialApplicationSpecRequest'
      - $ref: '#/components/schemas/RestoreRequest'
      title: RestorablePartialApplicationSpecRequest
      discriminator:
        propertyName: restore
        mapping:
          'False': '#/components/schemas/PartialApplicationSpecRequest'
          'True': '#/components/schemas/RestoreRequest'
    egp_api_backend__server__api__models__application_models_no_gen__ApplicationSpecResponse:
      properties:
        name:
          type: string
          title: Name
          description: The name of the Application Spec
        description:
          type: string
          title: Description
          description: The description of the Application Spec
        theme_id:
          title: Theme Id
          can_patch: true
          type: string
        run_online_evaluation:
          title: Run Online Evaluation
          description: Whether the application spec should run online evaluation, default is `false`
          default: false
          type: boolean
        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.
        archived_at:
          title: Archived At
          description: The date and time when the entity was archived in ISO format.
          type: string
          format: date-time
      type: object
      required:
      - name
      - description
      - id
      - created_at
      - account_id
      title: ApplicationSpecResponse
    PartialApplicationSpecRequest:
      properties:
        name:
          type: string
          title: Name
          description: The name of the Application Spec
        description:
          type: string
          title: Description
          description: The description of the Application Spec
        theme_id:
          title: Theme Id
          can_patch: true
          type: string
        run_online_evaluation:
          title: Run Online Evaluation
          description: Whether the application spec should run online evaluation, default is `false`
          type: boolean
        restore:
          type: boolean
          const: false
          title: Restore
          description: Set to true to restore the entity from the database.
          default: false
      additionalProperties: false
      type: object
      title: PartialApplicationSpecRequest
  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)