> ## 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.

# Get copilot id

> Requires scopes: eval:read



## OpenAPI

````yaml /api-reference/openapi.json get /api/copilot/proposals/{id}
openapi: 3.1.0
info:
  title: EvalGate API
  version: 3.7.6
  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/copilot/proposals/{id}:
    get:
      tags:
        - copilot
      summary: Get copilot id
      description: 'Requires scopes: eval:read'
      operationId: get_copilot_proposals_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetApiCopilotProposalsIdResponse200ApplicationJson
        '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'
      security:
        - bearerAuth:
            - eval:read
components:
  schemas:
    GetApiCopilotProposalsIdResponse200ApplicationJson:
      type: object
      properties:
        proposal:
          type: object
          properties:
            id:
              type: string
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            threadId:
              type: string
            sourceProposalId:
              oneOf:
                - type: 'null'
                - type: string
            domain:
              type: string
            resourceRef:
              type: object
              properties:
                type:
                  oneOf:
                    - type: string
                      enum:
                        - prompt
                    - type: string
                      enum:
                        - scorer
                    - type: string
                      enum:
                        - dataset
                    - type: string
                      enum:
                        - deployment
                    - type: string
                      enum:
                        - evals_as_code
                    - type: string
                      enum:
                        - monitor
                    - type: string
                      enum:
                        - dashboard
                id:
                  type: string
                version:
                  type: string
              additionalProperties: false
              required:
                - type
                - id
            expectedResourceHash:
              type: string
            status:
              type: string
            summary:
              type: string
            before:
              $ref: '#/components/schemas/JsonValue'
            after:
              $ref: '#/components/schemas/JsonValue'
            evidence:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                  resourceRef:
                    type: object
                    properties:
                      type:
                        oneOf:
                          - type: string
                            enum:
                              - prompt
                          - type: string
                            enum:
                              - scorer
                          - type: string
                            enum:
                              - dataset
                          - type: string
                            enum:
                              - deployment
                          - type: string
                            enum:
                              - evals_as_code
                          - type: string
                            enum:
                              - monitor
                          - type: string
                            enum:
                              - dashboard
                      id:
                        type: string
                      version:
                        type: string
                    additionalProperties: false
                    required:
                      - type
                      - id
                  label:
                    type: string
                  detail:
                    type: string
                additionalProperties: false
                required:
                  - type
                  - resourceRef
                  - label
                  - detail
            rationale:
              type: string
            warnings:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  severity:
                    oneOf:
                      - type: string
                        enum:
                          - blocking
                      - type: string
                        enum:
                          - info
                      - type: string
                        enum:
                          - warning
                additionalProperties: false
                required:
                  - code
                  - message
                  - severity
            expectedCostUsd:
              oneOf:
                - type: 'null'
                - type: string
            modelCallId:
              type: string
            authorizationSnapshot:
              type: object
              properties:
                actorId:
                  type: string
                role:
                  oneOf:
                    - type: string
                      enum:
                        - owner
                    - type: string
                      enum:
                        - viewer
                    - type: string
                      enum:
                        - member
                    - type: string
                      enum:
                        - admin
                scopes:
                  type: array
                  items:
                    type: string
                requiredScope:
                  type: string
                  enum:
                    - eval:write
                requiredRole:
                  type: string
                  enum:
                    - member
                checkedAt:
                  type: string
              additionalProperties: false
              required:
                - actorId
                - role
                - scopes
                - requiredScope
                - requiredRole
                - checkedAt
            requestHash:
              type: string
            redactionState:
              type: string
            redactionFindings:
              type: array
              items:
                type: string
            applicationResult:
              oneOf:
                - type: 'null'
                - type: object
                  properties:
                    domain:
                      oneOf:
                        - type: string
                          enum:
                            - prompt
                        - type: string
                          enum:
                            - scorer
                        - type: string
                          enum:
                            - dataset
                        - type: string
                          enum:
                            - deployment
                        - type: string
                          enum:
                            - evals_as_code
                        - type: string
                          enum:
                            - monitor
                        - type: string
                          enum:
                            - dashboard
                    resourceRef:
                      type: object
                      properties:
                        type:
                          oneOf:
                            - type: string
                              enum:
                                - prompt
                            - type: string
                              enum:
                                - scorer
                            - type: string
                              enum:
                                - dataset
                            - type: string
                              enum:
                                - deployment
                            - type: string
                              enum:
                                - evals_as_code
                            - type: string
                              enum:
                                - monitor
                            - type: string
                              enum:
                                - dashboard
                        id:
                          type: string
                        version:
                          type: string
                      additionalProperties: false
                      required:
                        - type
                        - id
                    createdDraftRef:
                      type: object
                      properties:
                        type:
                          oneOf:
                            - type: string
                              enum:
                                - prompt
                            - type: string
                              enum:
                                - scorer
                            - type: string
                              enum:
                                - dataset
                            - type: string
                              enum:
                                - deployment
                            - type: string
                              enum:
                                - evals_as_code
                            - type: string
                              enum:
                                - monitor
                            - type: string
                              enum:
                                - dashboard
                        id:
                          type: string
                        version:
                          type: string
                      additionalProperties: false
                      required:
                        - type
                        - id
                    rollbackRef:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            type:
                              oneOf:
                                - type: string
                                  enum:
                                    - prompt
                                - type: string
                                  enum:
                                    - scorer
                                - type: string
                                  enum:
                                    - dataset
                                - type: string
                                  enum:
                                    - deployment
                                - type: string
                                  enum:
                                    - evals_as_code
                                - type: string
                                  enum:
                                    - monitor
                                - type: string
                                  enum:
                                    - dashboard
                            id:
                              type: string
                            version:
                              type: string
                          additionalProperties: false
                          required:
                            - type
                            - id
                    detail:
                      type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                  additionalProperties: false
                  required:
                    - domain
                    - resourceRef
                    - createdDraftRef
                    - rollbackRef
                    - detail
                - type: object
                  properties:
                    acceptedRowIds:
                      type: array
                      items:
                        type: string
                    cause:
                      type: string
                    failures:
                      type: array
                      items:
                        type: object
                        properties:
                          code:
                            type: string
                          line:
                            type: number
                          message:
                            type: string
                        additionalProperties: false
                        required:
                          - code
                          - line
                          - message
                  additionalProperties: false
                  required:
                    - acceptedRowIds
            errorCode:
              oneOf:
                - type: 'null'
                - type: string
            errorMessage:
              oneOf:
                - type: 'null'
                - type: string
            createdBy:
              type: string
            reviewedBy:
              oneOf:
                - type: 'null'
                - type: string
            reviewedAt:
              oneOf:
                - type: 'null'
                - type: string
                  format: date-time
            expiresAt:
              type: string
              format: date-time
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
          additionalProperties: false
          required:
            - id
            - organizationId
            - threadId
            - sourceProposalId
            - domain
            - resourceRef
            - expectedResourceHash
            - status
            - summary
            - before
            - after
            - evidence
            - rationale
            - warnings
            - expectedCostUsd
            - modelCallId
            - authorizationSnapshot
            - requestHash
            - redactionState
            - redactionFindings
            - applicationResult
            - errorCode
            - errorMessage
            - createdBy
            - reviewedBy
            - reviewedAt
            - expiresAt
            - createdAt
            - updatedAt
        decisions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              organizationId:
                $ref: '#/components/schemas/OrganizationId'
              proposalId:
                type: string
              decision:
                type: string
              rationale:
                type: string
              actorId:
                type: string
              authorizationSnapshot:
                type: object
                properties:
                  actorId:
                    type: string
                  role:
                    oneOf:
                      - type: string
                        enum:
                          - owner
                      - type: string
                        enum:
                          - viewer
                      - type: string
                        enum:
                          - member
                      - type: string
                        enum:
                          - admin
                  scopes:
                    type: array
                    items:
                      type: string
                  requiredScope:
                    type: string
                    enum:
                      - eval:write
                  requiredRole:
                    type: string
                    enum:
                      - member
                  checkedAt:
                    type: string
                additionalProperties: false
                required:
                  - actorId
                  - role
                  - scopes
                  - requiredScope
                  - requiredRole
                  - checkedAt
              idempotencyKey:
                type: string
              result:
                oneOf:
                  - type: 'null'
                  - type: object
                    properties:
                      domain:
                        oneOf:
                          - type: string
                            enum:
                              - prompt
                          - type: string
                            enum:
                              - scorer
                          - type: string
                            enum:
                              - dataset
                          - type: string
                            enum:
                              - deployment
                          - type: string
                            enum:
                              - evals_as_code
                          - type: string
                            enum:
                              - monitor
                          - type: string
                            enum:
                              - dashboard
                      resourceRef:
                        type: object
                        properties:
                          type:
                            oneOf:
                              - type: string
                                enum:
                                  - prompt
                              - type: string
                                enum:
                                  - scorer
                              - type: string
                                enum:
                                  - dataset
                              - type: string
                                enum:
                                  - deployment
                              - type: string
                                enum:
                                  - evals_as_code
                              - type: string
                                enum:
                                  - monitor
                              - type: string
                                enum:
                                  - dashboard
                          id:
                            type: string
                          version:
                            type: string
                        additionalProperties: false
                        required:
                          - type
                          - id
                      createdDraftRef:
                        type: object
                        properties:
                          type:
                            oneOf:
                              - type: string
                                enum:
                                  - prompt
                              - type: string
                                enum:
                                  - scorer
                              - type: string
                                enum:
                                  - dataset
                              - type: string
                                enum:
                                  - deployment
                              - type: string
                                enum:
                                  - evals_as_code
                              - type: string
                                enum:
                                  - monitor
                              - type: string
                                enum:
                                  - dashboard
                          id:
                            type: string
                          version:
                            type: string
                        additionalProperties: false
                        required:
                          - type
                          - id
                      rollbackRef:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              type:
                                oneOf:
                                  - type: string
                                    enum:
                                      - prompt
                                  - type: string
                                    enum:
                                      - scorer
                                  - type: string
                                    enum:
                                      - dataset
                                  - type: string
                                    enum:
                                      - deployment
                                  - type: string
                                    enum:
                                      - evals_as_code
                                  - type: string
                                    enum:
                                      - monitor
                                  - type: string
                                    enum:
                                      - dashboard
                              id:
                                type: string
                              version:
                                type: string
                            additionalProperties: false
                            required:
                              - type
                              - id
                      detail:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                    additionalProperties: false
                    required:
                      - domain
                      - resourceRef
                      - createdDraftRef
                      - rollbackRef
                      - detail
                  - type: object
                    properties:
                      errorCode:
                        type: string
                      errorMessage:
                        type: string
                      partialResult:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              acceptedRowIds:
                                type: array
                                items:
                                  type: string
                              cause:
                                type: string
                              failures:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    code:
                                      type: string
                                    line:
                                      type: number
                                    message:
                                      type: string
                                  additionalProperties: false
                                  required:
                                    - code
                                    - line
                                    - message
                            additionalProperties: false
                            required:
                              - acceptedRowIds
                    additionalProperties: false
                    required:
                      - errorCode
                      - errorMessage
                      - partialResult
                  - type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - rejected
                    additionalProperties: false
                    required:
                      - status
              createdAt:
                type: string
                format: date-time
            additionalProperties: false
            required:
              - id
              - organizationId
              - proposalId
              - decision
              - rationale
              - actorId
              - authorizationSnapshot
              - idempotencyKey
              - result
              - createdAt
      additionalProperties: false
      required:
        - proposal
        - decisions
    OrganizationId:
      type: string
      format: uuid
    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
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - NO_ORG_MEMBERSHIP
                - CROSS_ORG_REFERENCE
                - INCOMPLETE
                - MALFORMED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key or Session Token

````