> ## Documentation Index
> Fetch the complete documentation index at: https://evalgate.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List golden release summary

> Requires scopes: eval:read



## OpenAPI

````yaml /api-reference/openapi.json get /api/golden-release/summary
openapi: 3.1.2
info:
  title: EvalGate API
  version: 18.13.0
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
  - url: https://evalgate.com
    description: Production
  - url: http://localhost:3000
    description: Local
security: []
paths:
  /api/golden-release/summary:
    get:
      tags:
        - golden release
      summary: List golden release summary
      description: 'Requires scopes: eval:read'
      operationId: get_golden_release_summary
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetApiGoldenReleaseSummaryResponse200ApplicationJson
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - bearerAuth: []
components:
  schemas:
    GetApiGoldenReleaseSummaryResponse200ApplicationJson:
      oneOf:
        - type: object
          properties:
            uxEnabled:
              type: boolean
            experimental:
              type: boolean
            candidates:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: number
                  title:
                    type: string
                  status:
                    type: string
                  lifecycleState:
                    type: string
                  inboxStatus:
                    oneOf:
                      - type: string
                        enum:
                          - rejected
                      - type: string
                        enum:
                          - needs_review
                      - type: string
                        enum:
                          - blocked
                      - type: string
                        enum:
                          - merged
                      - type: string
                        enum:
                          - ready_to_publish
                      - type: string
                        enum:
                          - awaiting_repository
                      - type: string
                        enum:
                          - pr_open
                      - type: string
                        enum:
                          - abstained
                  failureMode:
                    oneOf:
                      - type: 'null'
                      - type: string
                  qualityScore:
                    oneOf:
                      - type: 'null'
                      - type: number
                  rationale:
                    oneOf:
                      - type: 'null'
                      - type: string
                  createdAt:
                    type: string
                  nextAction:
                    oneOf:
                      - type: 'null'
                      - type: string
                  publicationId:
                    oneOf:
                      - type: 'null'
                      - type: string
                  traceId:
                    oneOf:
                      - type: 'null'
                      - type: number
                additionalProperties: false
                required:
                  - id
                  - title
                  - status
                  - lifecycleState
                  - inboxStatus
                  - failureMode
                  - qualityScore
                  - rationale
                  - createdAt
                  - nextAction
                  - publicationId
                  - traceId
            activeDecision:
              oneOf:
                - type: 'null'
                - type: object
                  properties:
                    decision:
                      type: string
                    canonicalScore:
                      oneOf:
                        - type: 'null'
                        - type: number
                    threshold:
                      oneOf:
                        - type: 'null'
                        - type: number
                    primaryMetric:
                      type: string
                    reasonCodes:
                      type: array
                      items:
                        type: string
                    measurementRevisionId:
                      type: string
                    evaluatorReleaseId:
                      type: string
                    evaluatorReleaseName:
                      oneOf:
                        - type: 'null'
                        - type: string
                    revision:
                      type: number
                    status:
                      type: string
                    prUrl:
                      oneOf:
                        - type: 'null'
                        - type: string
                    checkUrl:
                      oneOf:
                        - type: 'null'
                        - type: string
                    headSha:
                      oneOf:
                        - type: 'null'
                        - type: string
                  additionalProperties: false
                  required:
                    - decision
                    - canonicalScore
                    - threshold
                    - primaryMetric
                    - reasonCodes
                    - measurementRevisionId
                    - evaluatorReleaseId
                    - evaluatorReleaseName
                    - revision
                    - status
                    - prUrl
                    - checkUrl
                    - headSha
            measurementRevisions:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  revision:
                    type: number
                  status:
                    type: string
                  decision:
                    type: string
                  canonicalScore:
                    oneOf:
                      - type: 'null'
                      - type: number
                  threshold:
                    oneOf:
                      - type: 'null'
                      - type: number
                  primaryMetricName:
                    type: string
                  reasonCodes:
                    type: array
                    items:
                      type: string
                  evaluatorReleaseId:
                    type: string
                  evaluatorReleaseName:
                    oneOf:
                      - type: 'null'
                      - type: string
                  supersededAt:
                    oneOf:
                      - type: 'null'
                      - type: string
                  createdAt:
                    type: string
                  effectiveSampleSize:
                    oneOf:
                      - type: 'null'
                      - type: number
                  weightDiagnostics:
                    oneOf:
                      - type: 'null'
                      - type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                  isActive:
                    type: boolean
                additionalProperties: false
                required:
                  - id
                  - revision
                  - status
                  - decision
                  - canonicalScore
                  - threshold
                  - primaryMetricName
                  - reasonCodes
                  - evaluatorReleaseId
                  - evaluatorReleaseName
                  - supersededAt
                  - createdAt
                  - effectiveSampleSize
                  - weightDiagnostics
                  - isActive
            publications:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                  pullRequestNumber:
                    oneOf:
                      - type: 'null'
                      - type: number
                  headSha:
                    oneOf:
                      - type: 'null'
                      - type: string
                  baseSha:
                    type: string
                  branchName:
                    type: string
                  repositoryFullName:
                    oneOf:
                      - type: 'null'
                      - type: string
                  pullRequestUrl:
                    oneOf:
                      - type: 'null'
                      - type: string
                  checkRunId:
                    oneOf:
                      - type: 'null'
                      - type: number
                  checkRunUrl:
                    oneOf:
                      - type: 'null'
                      - type: string
                  checkStatus:
                    oneOf:
                      - type: 'null'
                      - type: string
                  checkConclusion:
                    oneOf:
                      - type: 'null'
                      - type: string
                  checkName:
                    oneOf:
                      - type: 'null'
                      - type: string
                  mergedArtifactHash:
                    type: string
                  publicationManifestHash:
                    type: string
                  candidateIds:
                    type: array
                    items:
                      type: number
                  updatedAt:
                    type: string
                additionalProperties: false
                required:
                  - id
                  - status
                  - pullRequestNumber
                  - headSha
                  - baseSha
                  - branchName
                  - repositoryFullName
                  - pullRequestUrl
                  - checkRunId
                  - checkRunUrl
                  - checkStatus
                  - checkConclusion
                  - checkName
                  - mergedArtifactHash
                  - publicationManifestHash
                  - candidateIds
                  - updatedAt
            toolTrajectory:
              type: array
              items:
                type: object
                properties:
                  order:
                    type: number
                  toolName:
                    type: string
                  callId:
                    type: string
                  arguments:
                    oneOf:
                      - type: 'null'
                      - type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                  sideEffectClass:
                    type: string
                  success:
                    oneOf:
                      - type: 'null'
                      - type: boolean
                        enum:
                          - false
                      - type: boolean
                        enum:
                          - true
                additionalProperties: false
                required:
                  - order
                  - toolName
                  - callId
                  - arguments
                  - sideEffectClass
                  - success
          additionalProperties: false
          required:
            - uxEnabled
            - experimental
            - candidates
            - activeDecision
            - measurementRevisions
            - publications
            - toolTrajectory
        - type: object
          properties:
            uxEnabled:
              type: boolean
            experimental:
              type: boolean
              enum:
                - true
            candidates:
              type: array
              items:
                $ref: '#/components/schemas/JsonValue'
            activeDecision:
              type: 'null'
            measurementRevisions:
              type: array
              items:
                $ref: '#/components/schemas/JsonValue'
            publications:
              type: array
              items:
                $ref: '#/components/schemas/JsonValue'
            toolTrajectory:
              type: array
              items:
                $ref: '#/components/schemas/JsonValue'
            warning:
              type: string
          additionalProperties: false
          required:
            - uxEnabled
            - experimental
            - candidates
            - activeDecision
            - measurementRevisions
            - publications
            - toolTrajectory
            - warning
    JsonValue:
      oneOf:
        - type: 'null'
        - type: boolean
        - type: number
        - type: string
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - INVALID_REFERENCE
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - FEATURE_LIMIT_REACHED
                - NO_ORG_MEMBERSHIP
                - SHARE_REVOKED
                - SHARE_EXPIRED
                - SHARE_UNAVAILABLE
                - PROVIDER_KEY_MISSING
                - PROVIDER_KEY_EXPIRED
                - PROVIDER_RATE_LIMITED
                - PROVIDER_UNAUTHORIZED
                - PROVIDER_UNAVAILABLE
                - AGENT_HANDOFF_INVALID
                - AGENT_HANDOFF_EXPIRED
                - AGENT_HANDOFF_DENIED
                - AGENT_HANDOFF_CONSUMED
                - PAYLOAD_TOO_LARGE
                - METHOD_NOT_ALLOWED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
            redaction:
              type: object
              properties:
                applied:
                  type: boolean
                  enum:
                    - true
                fieldCount:
                  type: integer
                  minimum: 0
                secretCount:
                  type: integer
                  minimum: 0
              required:
                - applied
                - fieldCount
                - secretCount
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
        WWW-Authenticate:
          description: >-
            Bearer challenge. Agent-facing routes include the RFC 9728
            resource_metadata URL.
          schema:
            type: string
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
        Retry-After:
          description: Delay in seconds before retrying when present.
          schema:
            type: integer
            minimum: 1
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
    ServiceUnavailable:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
      headers:
        RateLimit-Limit:
          description: Quota in requests for the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Remaining:
          description: Remaining requests in the active window.
          schema:
            type: integer
            minimum: 0
        RateLimit-Reset:
          description: Reset delay in seconds (not a Unix timestamp).
          schema:
            type: integer
            minimum: 1
        X-RateLimit-Limit:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Remaining:
          schema:
            type: integer
            minimum: 0
        X-RateLimit-Reset:
          description: Legacy reset timestamp in Unix milliseconds.
          schema:
            type: integer
            minimum: 0
        RateLimit-Policy:
          description: IETF HTTPAPI structured quota policy (work in progress).
          schema:
            type: string
        RateLimit:
          description: >-
            IETF HTTPAPI structured remaining quota and reset delay (work in
            progress).
          schema:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: EvalGate API key
      description: >-
        Organization-scoped EvalGate API key. Discover the supported agent
        scopes at /.well-known/oauth-protected-resource. Per-operation grants
        are listed in x-evalgate-required-scopes; OpenAPI bearer security
        requirement arrays remain empty as required for non-OAuth schemes.
      x-evalgate-scopes-supported:
        - eval:read
        - eval:write
        - objectives:read
        - objectives:write
        - runs:read
        - runs:write
        - traces:read
        - traces:write
        - exports:download
        - reports:write
        - prompt:publish
        - scorer:publish
        - red_team:read
        - red_team:run
        - red_team:approve
        - docs:read
        - agent:read
        - agent:execute
        - resources:read
        - resources:write
        - contexts:read
        - contexts:write
        - observations:write
        - checks:read
        - checks:run
        - standards:read
        - standards:write
        - standards:approve
        - grants:read
        - grants:write
        - admin:keys
        - admin:workspace
        - admin:org
      x-evalgate-protected-resource-metadata: https://www.evalgate.com/.well-known/oauth-protected-resource

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.