Scale AI Evaluation Charts API

openapi: 3.2.0
info:
  title: EGP API V5 Evaluation Charts 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: Evaluation Charts
paths:
  /v5/evaluation-charts:
    post:
      tags:
      - Evaluation Charts
      summary: Create Evaluation Chart
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. Create a new evaluation chart for an evaluation or evaluation group.'
      operationId: POST-V5-/v5/evaluation-charts
      parameters:
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluationChartCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/create-evaluation-chart
    get:
      tags:
      - Evaluation Charts
      summary: List Evaluation Charts
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. List charts filtered by evaluation_id or evaluation_group_id.'
      operationId: GET-V5-/v5/evaluation-charts
      parameters:
      - name: evaluation_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Evaluation Id
      - name: evaluation_group_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Evaluation Group Id
      - name: starting_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Starting After
      - name: ending_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ending Before
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 10000
          minimum: 1
          default: 100
          title: Limit
      - name: sort_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Sort By
      - name: sort_order
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/SortOrder'
          - type: 'null'
          default: asc
          title: Sort Order
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedList_EvaluationChart_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/list-evaluation-charts
  /v5/evaluation-charts/{chart_id}:
    delete:
      tags:
      - Evaluation Charts
      summary: Delete Evaluation Chart
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. Delete an evaluation chart and its columns.'
      operationId: DELETE-V5-/v5/evaluation-charts/chart_id
      parameters:
      - name: chart_id
        in: path
        required: true
        schema:
          type: string
          title: Chart Id
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/delete-evaluation-chart
    get:
      tags:
      - Evaluation Charts
      summary: Get Evaluation Chart
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. Get a single evaluation chart by ID.'
      operationId: GET-V5-/v5/evaluation-charts/chart_id
      parameters:
      - name: chart_id
        in: path
        required: true
        schema:
          type: string
          title: Chart Id
      - name: views
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EvaluationChartViews'
          description: 'Optional relationships to include: ''columns'''
          default: []
          title: Views
        description: 'Optional relationships to include: ''columns'''
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/get-evaluation-chart
    patch:
      tags:
      - Evaluation Charts
      summary: Patch Evaluation Chart
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. Partially update chart metadata (title, type). Columns cannot be modified via PATCH.'
      operationId: PATCH-V5-/v5/evaluation-charts/chart_id
      parameters:
      - name: chart_id
        in: path
        required: true
        schema:
          type: string
          title: Chart Id
      - name: views
        in: query
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/EvaluationChartViews'
          description: 'Optional relationships to include: ''columns'''
          default: []
          title: Views
        description: 'Optional relationships to include: ''columns'''
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluationChartPatchRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/patch-evaluation-chart
    put:
      tags:
      - Evaluation Charts
      summary: Replace Evaluation Chart
      description: 'Deprecated: evaluation group dashboards are the preferred way to construct charts. Replace chart metadata and/or columns. Columns are replaced if provided.'
      operationId: PUT-V5-/v5/evaluation-charts/chart_id
      parameters:
      - name: chart_id
        in: path
        required: true
        schema:
          type: string
          title: Chart Id
      - name: x-selected-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Account ID Header
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EvaluationChartUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationChart'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      deprecated: true
      security:
      - APIKeyHeader: []
      x-source: https://docs.gp.scale.com/reference/v5/evaluation-charts/replace-evaluation-chart
components:
  schemas:
    EvaluationChartViews:
      type: string
      enum:
      - columns
      title: EvaluationChartViews
      description: Views for evaluation chart responses
    CreateChartInEvaluationGroupRequest:
      properties:
        target:
          $ref: '#/components/schemas/EvaluationChartTarget'
          description: Evaluation or evaluation group that owns the chart
        title:
          type: string
          maxLength: 128
          title: Title
          description: Chart title
        type:
          $ref: '#/components/schemas/EvaluationChartTypeEnum'
          description: Chart type
        columns:
          items:
            $ref: '#/components/schemas/EvaluationChartColumn'
          type: array
          minItems: 1
          title: Columns
          description: Column mappings. Columns must include evaluation_id when targeting an evaluation group.
      type: object
      required:
      - target
      - title
      - type
      - columns
      title: CreateChartInEvaluationGroupRequest
      description: Create a chart scoped to an evaluation group.
    EvaluationChartUpdateRequest:
      properties:
        title:
          type: string
          maxLength: 128
          title: Title
          description: Chart title
        type:
          $ref: '#/components/schemas/EvaluationChartTypeEnum'
          description: Chart type
        columns:
          title: Columns
          description: Column mappings (replaces existing). evaluation_id is required for each column.
          items:
            $ref: '#/components/schemas/EvaluationChartColumn'
          type: array
          minItems: 1
      type: object
      title: EvaluationChartUpdateRequest
      description: Request model for updating evaluation chart
    EvaluationChartColumnResponse:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the column mapping
        object:
          type: string
          const: evaluation_chart.column
          title: Object
          default: evaluation_chart.column
        evaluation_id:
          title: Evaluation Id
          description: Evaluation ID (null for single-eval charts)
          type: string
        column_name:
          type: string
          title: Column Name
          description: Column name
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When this column mapping was created
        deleted_at:
          title: Deleted At
          description: When this column mapping was soft-deleted
          type: string
          format: date-time
        account_id:
          type: string
          title: Account Id
          description: Account that owns this column mapping
      type: object
      required:
      - id
      - column_name
      - created_at
      - account_id
      description: Response model for chart column
    CreateChartInEvaluationRequest:
      properties:
        target:
          $ref: '#/components/schemas/EvaluationChartTarget'
          description: Evaluation or evaluation group that owns the chart
        title:
          type: string
          maxLength: 128
          title: Title
          description: Chart title
        type:
          $ref: '#/components/schemas/EvaluationChartTypeEnum'
          description: Chart type
        columns:
          items:
            $ref: '#/components/schemas/EvaluationChartColumn'
          type: array
          minItems: 1
          title: Columns
          description: Column mappings. Columns must include evaluation_id when targeting an evaluation group.
      type: object
      required:
      - target
      - title
      - type
      - columns
      title: CreateChartInEvaluationRequest
      description: Create a chart scoped to a single evaluation.
    EvaluationChartTarget:
      properties:
        id:
          type: string
          title: Id
          description: ID of the evaluation or evaluation group
        type:
          $ref: '#/components/schemas/EvaluationChartTargetType'
          description: 'Target type: evaluation or evaluation_group'
      type: object
      required:
      - id
      - type
      title: EvaluationChartTarget
      description: Target entity that owns the chart
    PaginatedList_EvaluationChart_:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/EvaluationChart'
          type: array
          title: Items
        limit:
          type: integer
          title: Limit
          description: The maximum number of items to return.
          default: 100
        total:
          type: integer
          title: Total
          description: The total of items that match the query. This is greater than or equal to the number of items returned.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more items left to be fetched.
      type: object
      required:
      - items
      - total
      - has_more
    EvaluationChartPatchRequest:
      properties:
        title:
          type: string
          maxLength: 128
          title: Title
          description: Chart title
        type:
          $ref: '#/components/schemas/EvaluationChartTypeEnum'
          description: Chart type
      type: object
      title: EvaluationChartPatchRequest
      description: Request model for partially updating chart metadata
    EvaluationChartColumn:
      properties:
        evaluation_id:
          title: Evaluation Id
          description: Evaluation ID (required when targeting an evaluation group)
          type: string
        column_name:
          type: string
          title: Column Name
          description: Column name from the evaluation dataset
      type: object
      required:
      - column_name
      title: EvaluationChartColumn
      description: Column mapping for the chart
    EvaluationChartCreateRequest:
      anyOf:
      - $ref: '#/components/schemas/CreateChartInEvaluationRequest'
      - $ref: '#/components/schemas/CreateChartInEvaluationGroupRequest'
      title: EvaluationChartCreateRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EvaluationChartTargetType:
      type: string
      enum:
      - evaluation
      - evaluation_group
      title: EvaluationChartTargetType
      description: Scopes a chart to a single evaluation or an evaluation group
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    EvaluationChart:
      properties:
        id:
          type: string
          title: Id
          description: Unique identifier of the evaluation chart
        object:
          type: string
          const: evaluation_chart
          title: Object
          default: evaluation_chart
        evaluation_id:
          title: Evaluation Id
          description: Evaluation ID
          type: string
        evaluation_group_id:
          title: Evaluation Group Id
          description: Evaluation group ID
          type: string
        title:
          type: string
          title: Title
          description: Chart title
        type:
          $ref: '#/components/schemas/EvaluationChartTypeEnum'
          description: Chart type
        account_id:
          type: string
          title: Account Id
          description: Account that owns this chart
        created_at:
          type: string
          format: date-time
          title: Created At
          description: When the chart was created
        deleted_at:
          title: Deleted At
          description: When the chart was soft-deleted
          type: string
          format: date-time
        columns:
          title: Columns
          description: Column mappings. Populated with 'columns' view.
          items:
            $ref: '#/components/schemas/EvaluationChartColumnResponse'
          type: array
      type: object
      required:
      - id
      - title
      - type
      - account_id
      - created_at
      description: Response model for evaluation chart
    SortOrder:
      type: string
      enum:
      - asc
      - desc
      title: SortOrder
    EvaluationChartTypeEnum:
      type: string
      enum:
      - bar
      - histogram
      title: EvaluationChartTypeEnum
      description: Chart types for evaluation visualizations
  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/v5/openapi.json (404 when assembled)