> ## 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 workflows runId

> Requires scopes: runs:read



## OpenAPI

````yaml /api-reference/openapi.json get /api/workflows/{id}/runs/{runId}
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/workflows/{id}/runs/{runId}:
    get:
      tags:
        - workflows
      summary: Get workflows runId
      description: 'Requires scopes: runs:read'
      operationId: get_workflows_id_runs_runId
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: runId
          in: path
          required: true
          schema:
            type: integer
        - name: includeDetails
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetApiWorkflowsIdRunsRunIdResponse200ApplicationJson
        '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:
            - runs:read
components:
  schemas:
    GetApiWorkflowsIdRunsRunIdResponse200ApplicationJson:
      oneOf:
        - type: object
          properties:
            run:
              type: object
              properties:
                id:
                  type: number
                workflowId:
                  oneOf:
                    - type: 'null'
                    - type: number
                traceId:
                  type: number
                organizationId:
                  $ref: '#/components/schemas/OrganizationId'
                status:
                  type: string
                input:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                output:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                totalCost:
                  oneOf:
                    - type: 'null'
                    - type: string
                totalDurationMs:
                  oneOf:
                    - type: 'null'
                    - type: number
                agentCount:
                  oneOf:
                    - type: 'null'
                    - type: number
                handoffCount:
                  oneOf:
                    - type: 'null'
                    - type: number
                retryCount:
                  oneOf:
                    - type: 'null'
                    - type: number
                errorMessage:
                  oneOf:
                    - type: 'null'
                    - type: string
                metadata:
                  oneOf:
                    - type: 'null'
                    - type: object
                      properties:
                        trigger:
                          type: string
                        environment:
                          type: string
                        evaluationId:
                          type: number
                        autonomyLevel:
                          oneOf:
                            - type: string
                              enum:
                                - manual
                            - type: string
                              enum:
                                - default_approvals
                            - type: string
                              enum:
                                - bypass_approvals
                            - type: string
                              enum:
                                - autopilot
                        approvalMode:
                          type: string
                        hookCount:
                          type: number
                        checkpointed:
                          oneOf:
                            - type: boolean
                              enum:
                                - false
                            - type: boolean
                              enum:
                                - true
                        agentWorkflowType:
                          type: string
                        sessionId:
                          type: string
                        workflowProfile:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                recipeTitle:
                                  type: string
                                workflowClass:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - approval_gated_mutation
                                    - type: string
                                      enum:
                                        - background_execution
                                    - type: string
                                      enum:
                                        - recovery_required
                                    - type: string
                                      enum:
                                        - policy_conflict
                                    - type: string
                                      enum:
                                        - handoff_heavy
                                    - type: string
                                      enum:
                                        - memory_sensitive
                                    - type: string
                                      enum:
                                        - parallel_tool_use
                                autonomyLevel:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - manual
                                    - type: string
                                      enum:
                                        - default_approvals
                                    - type: string
                                      enum:
                                        - bypass_approvals
                                    - type: string
                                      enum:
                                        - autopilot
                                approvalMode:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - human_review
                                    - type: string
                                      enum:
                                        - none
                                    - type: string
                                      enum:
                                        - policy_guided
                                    - type: string
                                      enum:
                                        - auto_with_audit
                                memoryMode:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - session
                                    - type: string
                                      enum:
                                        - none
                                    - type: string
                                      enum:
                                        - persistent
                                    - type: string
                                      enum:
                                        - mixed
                                backgroundExecution:
                                  type: boolean
                                requiredHooks:
                                  type: array
                                  items:
                                    oneOf:
                                      - type: string
                                        enum:
                                          - session_start
                                      - type: string
                                        enum:
                                          - pre_plan
                                      - type: string
                                        enum:
                                          - pre_tool
                                      - type: string
                                        enum:
                                          - post_tool
                                      - type: string
                                        enum:
                                          - pre_write
                                      - type: string
                                        enum:
                                          - pre_handoff
                                      - type: string
                                        enum:
                                          - on_error
                                      - type: string
                                        enum:
                                          - session_end
                                linkedFailureModes:
                                  type: array
                                  items:
                                    type: string
                                successMetrics:
                                  type: array
                                  items:
                                    type: string
                                guardrails:
                                  type: array
                                  items:
                                    type: string
                                recommendedIterations:
                                  type: number
                                source:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - coverage_gap
                                    - type: string
                                      enum:
                                        - failure
                              additionalProperties: false
                              required:
                                - recipeTitle
                                - workflowClass
                                - autonomyLevel
                                - approvalMode
                                - memoryMode
                                - backgroundExecution
                                - requiredHooks
                                - linkedFailureModes
                                - successMetrics
                                - guardrails
                                - recommendedIterations
                                - source
                        hookInvocations:
                          type: array
                          items:
                            type: object
                            properties:
                              hook:
                                oneOf:
                                  - type: string
                                    enum:
                                      - session_start
                                  - type: string
                                    enum:
                                      - pre_plan
                                  - type: string
                                    enum:
                                      - pre_tool
                                  - type: string
                                    enum:
                                      - post_tool
                                  - type: string
                                    enum:
                                      - pre_write
                                  - type: string
                                    enum:
                                      - pre_handoff
                                  - type: string
                                    enum:
                                      - on_error
                                  - type: string
                                    enum:
                                      - session_end
                              blocked:
                                type: boolean
                              latencyMs:
                                type: number
                              detail:
                                type: string
                            additionalProperties: false
                            required:
                              - hook
                              - blocked
                              - latencyMs
                              - detail
                        approvalDecisions:
                          type: array
                          items:
                            type: object
                            properties:
                              actionType:
                                type: string
                              riskLevel:
                                oneOf:
                                  - type: string
                                    enum:
                                      - low
                                  - type: string
                                    enum:
                                      - medium
                                  - type: string
                                    enum:
                                      - high
                                  - type: string
                                    enum:
                                      - critical
                              recommendedDisposition:
                                oneOf:
                                  - type: string
                                    enum:
                                      - deny
                                  - type: string
                                    enum:
                                      - auto_approve
                                  - type: string
                                    enum:
                                      - require_review
                              finalDisposition:
                                oneOf:
                                  - type: string
                                    enum:
                                      - approved
                                  - type: string
                                    enum:
                                      - rejected
                                  - type: string
                                    enum:
                                      - overridden
                              rationale:
                                type: string
                            additionalProperties: false
                            required:
                              - actionType
                              - riskLevel
                              - recommendedDisposition
                              - finalDisposition
                              - rationale
                        memoryEvents:
                          type: array
                          items:
                            type: object
                            properties:
                              layer:
                                oneOf:
                                  - type: string
                                    enum:
                                      - session
                                  - type: string
                                    enum:
                                      - project_rule
                                  - type: string
                                    enum:
                                      - persistent_memory
                              operation:
                                oneOf:
                                  - type: string
                                    enum:
                                      - read
                                  - type: string
                                    enum:
                                      - write
                                  - type: string
                                    enum:
                                      - ignore
                              sourceId:
                                type: string
                              detail:
                                type: string
                            additionalProperties: false
                            required:
                              - layer
                              - operation
                              - sourceId
                              - detail
                        checkpoints:
                          type: array
                          items:
                            type: object
                            properties:
                              kind:
                                oneOf:
                                  - type: string
                                    enum:
                                      - manual
                                  - type: string
                                    enum:
                                      - auto
                              restorable:
                                type: boolean
                              label:
                                type: string
                            additionalProperties: false
                            required:
                              - kind
                              - restorable
                              - label
                        debugSnapshots:
                          type: array
                          items:
                            type: object
                            properties:
                              stepIndex:
                                type: number
                              label:
                                type: string
                              activeHooks:
                                type: array
                                items:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - session_start
                                    - type: string
                                      enum:
                                        - pre_plan
                                    - type: string
                                      enum:
                                        - pre_tool
                                    - type: string
                                      enum:
                                        - post_tool
                                    - type: string
                                      enum:
                                        - pre_write
                                    - type: string
                                      enum:
                                        - pre_handoff
                                    - type: string
                                      enum:
                                        - on_error
                                    - type: string
                                      enum:
                                        - session_end
                              memoryRefs:
                                type: array
                                items:
                                  type: string
                              approvalState:
                                type: string
                              summary:
                                type: string
                            additionalProperties: false
                            required:
                              - stepIndex
                              - label
                              - activeHooks
                              - memoryRefs
                              - approvalState
                              - summary
                        runtimeSummary:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                workflowRunId:
                                  type: number
                                traceId:
                                  type: number
                                executionMode:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - analysis_only
                                    - type: string
                                      enum:
                                        - single_agent
                                    - type: string
                                      enum:
                                        - parallel_swarm
                                finalStatus:
                                  oneOf:
                                    - type: string
                                      enum:
                                        - failed
                                    - type: string
                                      enum:
                                        - completed
                                stopReason:
                                  oneOf:
                                    - type: 'null'
                                    - type: string
                                approvalState:
                                  type: string
                                hookCount:
                                  type: number
                                memoryReadCount:
                                  type: number
                                checkpointCreated:
                                  type: boolean
                                handoffCount:
                                  type: number
                                debugSnapshotCount:
                                  type: number
                                decisionCount:
                                  type: number
                              additionalProperties: false
                              required:
                                - executionMode
                                - finalStatus
                                - stopReason
                                - approvalState
                                - hookCount
                                - memoryReadCount
                                - checkpointCreated
                                - handoffCount
                                - debugSnapshotCount
                                - decisionCount
                      additionalProperties: false
                trigger:
                  oneOf:
                    - type: 'null'
                    - type: string
                startedAt:
                  type: string
                  format: date-time
                completedAt:
                  oneOf:
                    - type: 'null'
                    - type: string
                      format: date-time
              additionalProperties: false
              required:
                - id
                - workflowId
                - traceId
                - organizationId
                - status
                - input
                - output
                - totalCost
                - totalDurationMs
                - agentCount
                - handoffCount
                - retryCount
                - errorMessage
                - metadata
                - trigger
                - startedAt
                - completedAt
            trace:
              type: object
              properties:
                id:
                  type: number
                name:
                  type: string
                traceId:
                  type: string
                organizationId:
                  $ref: '#/components/schemas/OrganizationId'
                status:
                  type: string
                analysisStatus:
                  oneOf:
                    - type: 'null'
                    - type: string
                source:
                  oneOf:
                    - type: 'null'
                    - type: string
                environment:
                  oneOf:
                    - type: 'null'
                    - type: string
                durationMs:
                  oneOf:
                    - type: 'null'
                    - type: number
                metadata:
                  oneOf:
                    - type: 'null'
                    - type: object
                      properties:
                        score:
                          oneOf:
                            - type: 'null'
                            - type: number
                        tags:
                          type: array
                          items:
                            type: string
                        environment:
                          type: string
                        userId:
                          type: string
                        sessionId:
                          type: string
                        repoSha:
                          type: string
                        repo_sha:
                          type: string
                        contentHash:
                          type: string
                        content_hash:
                          type: string
                        model:
                          type: string
                        tokens:
                          type: number
                        temperature:
                          type: number
                        documentLength:
                          type: number
                        language:
                          type: string
                        latencyMs:
                          type: number
                        tokenCount:
                          type: number
                        provider:
                          type: string
                        cost:
                          type: number
                        cacheHit:
                          oneOf:
                            - type: boolean
                              enum:
                                - false
                            - type: boolean
                              enum:
                                - true
                      additionalProperties: false
                score:
                  oneOf:
                    - type: 'null'
                    - type: number
                activeRevisionId:
                  oneOf:
                    - type: 'null'
                    - type: string
                sealStatus:
                  oneOf:
                    - type: 'null'
                    - type: string
                createdAt:
                  type: string
                  format: date-time
              additionalProperties: false
              required:
                - id
                - name
                - traceId
                - organizationId
                - status
                - analysisStatus
                - source
                - environment
                - durationMs
                - metadata
                - score
                - activeRevisionId
                - sealStatus
                - createdAt
            handoffs:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: number
                  workflowRunId:
                    oneOf:
                      - type: 'null'
                      - type: number
                  organizationId:
                    $ref: '#/components/schemas/OrganizationId'
                  fromSpanId:
                    oneOf:
                      - type: 'null'
                      - type: string
                  toSpanId:
                    type: string
                  fromAgent:
                    oneOf:
                      - type: 'null'
                      - type: string
                  toAgent:
                    type: string
                  handoffType:
                    type: string
                  context:
                    oneOf:
                      - type: 'null'
                      - type: object
                        properties:
                          reason:
                            type: string
                          data:
                            type: object
                            additionalProperties:
                              $ref: '#/components/schemas/JsonValue'
                        additionalProperties: false
                  timestamp:
                    type: string
                    format: date-time
                additionalProperties: false
                required:
                  - id
                  - workflowRunId
                  - organizationId
                  - fromSpanId
                  - toSpanId
                  - fromAgent
                  - toAgent
                  - handoffType
                  - context
                  - timestamp
          additionalProperties: false
          required:
            - run
            - trace
            - handoffs
        - type: object
          properties:
            id:
              type: number
            workflowId:
              oneOf:
                - type: 'null'
                - type: number
            traceId:
              type: number
            organizationId:
              $ref: '#/components/schemas/OrganizationId'
            status:
              type: string
            input:
              oneOf:
                - type: 'null'
                - type: object
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
            output:
              oneOf:
                - type: 'null'
                - type: object
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
            totalCost:
              oneOf:
                - type: 'null'
                - type: string
            totalDurationMs:
              oneOf:
                - type: 'null'
                - type: number
            agentCount:
              oneOf:
                - type: 'null'
                - type: number
            handoffCount:
              oneOf:
                - type: 'null'
                - type: number
            retryCount:
              oneOf:
                - type: 'null'
                - type: number
            errorMessage:
              oneOf:
                - type: 'null'
                - type: string
            metadata:
              oneOf:
                - type: 'null'
                - type: object
                  properties:
                    trigger:
                      type: string
                    environment:
                      type: string
                    evaluationId:
                      type: number
                    autonomyLevel:
                      oneOf:
                        - type: string
                          enum:
                            - manual
                        - type: string
                          enum:
                            - default_approvals
                        - type: string
                          enum:
                            - bypass_approvals
                        - type: string
                          enum:
                            - autopilot
                    approvalMode:
                      type: string
                    hookCount:
                      type: number
                    checkpointed:
                      oneOf:
                        - type: boolean
                          enum:
                            - false
                        - type: boolean
                          enum:
                            - true
                    agentWorkflowType:
                      type: string
                    sessionId:
                      type: string
                    workflowProfile:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            recipeTitle:
                              type: string
                            workflowClass:
                              oneOf:
                                - type: string
                                  enum:
                                    - approval_gated_mutation
                                - type: string
                                  enum:
                                    - background_execution
                                - type: string
                                  enum:
                                    - recovery_required
                                - type: string
                                  enum:
                                    - policy_conflict
                                - type: string
                                  enum:
                                    - handoff_heavy
                                - type: string
                                  enum:
                                    - memory_sensitive
                                - type: string
                                  enum:
                                    - parallel_tool_use
                            autonomyLevel:
                              oneOf:
                                - type: string
                                  enum:
                                    - manual
                                - type: string
                                  enum:
                                    - default_approvals
                                - type: string
                                  enum:
                                    - bypass_approvals
                                - type: string
                                  enum:
                                    - autopilot
                            approvalMode:
                              oneOf:
                                - type: string
                                  enum:
                                    - human_review
                                - type: string
                                  enum:
                                    - none
                                - type: string
                                  enum:
                                    - policy_guided
                                - type: string
                                  enum:
                                    - auto_with_audit
                            memoryMode:
                              oneOf:
                                - type: string
                                  enum:
                                    - session
                                - type: string
                                  enum:
                                    - none
                                - type: string
                                  enum:
                                    - persistent
                                - type: string
                                  enum:
                                    - mixed
                            backgroundExecution:
                              type: boolean
                            requiredHooks:
                              type: array
                              items:
                                oneOf:
                                  - type: string
                                    enum:
                                      - session_start
                                  - type: string
                                    enum:
                                      - pre_plan
                                  - type: string
                                    enum:
                                      - pre_tool
                                  - type: string
                                    enum:
                                      - post_tool
                                  - type: string
                                    enum:
                                      - pre_write
                                  - type: string
                                    enum:
                                      - pre_handoff
                                  - type: string
                                    enum:
                                      - on_error
                                  - type: string
                                    enum:
                                      - session_end
                            linkedFailureModes:
                              type: array
                              items:
                                type: string
                            successMetrics:
                              type: array
                              items:
                                type: string
                            guardrails:
                              type: array
                              items:
                                type: string
                            recommendedIterations:
                              type: number
                            source:
                              oneOf:
                                - type: string
                                  enum:
                                    - coverage_gap
                                - type: string
                                  enum:
                                    - failure
                          additionalProperties: false
                          required:
                            - recipeTitle
                            - workflowClass
                            - autonomyLevel
                            - approvalMode
                            - memoryMode
                            - backgroundExecution
                            - requiredHooks
                            - linkedFailureModes
                            - successMetrics
                            - guardrails
                            - recommendedIterations
                            - source
                    hookInvocations:
                      type: array
                      items:
                        type: object
                        properties:
                          hook:
                            oneOf:
                              - type: string
                                enum:
                                  - session_start
                              - type: string
                                enum:
                                  - pre_plan
                              - type: string
                                enum:
                                  - pre_tool
                              - type: string
                                enum:
                                  - post_tool
                              - type: string
                                enum:
                                  - pre_write
                              - type: string
                                enum:
                                  - pre_handoff
                              - type: string
                                enum:
                                  - on_error
                              - type: string
                                enum:
                                  - session_end
                          blocked:
                            type: boolean
                          latencyMs:
                            type: number
                          detail:
                            type: string
                        additionalProperties: false
                        required:
                          - hook
                          - blocked
                          - latencyMs
                          - detail
                    approvalDecisions:
                      type: array
                      items:
                        type: object
                        properties:
                          actionType:
                            type: string
                          riskLevel:
                            oneOf:
                              - type: string
                                enum:
                                  - low
                              - type: string
                                enum:
                                  - medium
                              - type: string
                                enum:
                                  - high
                              - type: string
                                enum:
                                  - critical
                          recommendedDisposition:
                            oneOf:
                              - type: string
                                enum:
                                  - deny
                              - type: string
                                enum:
                                  - auto_approve
                              - type: string
                                enum:
                                  - require_review
                          finalDisposition:
                            oneOf:
                              - type: string
                                enum:
                                  - approved
                              - type: string
                                enum:
                                  - rejected
                              - type: string
                                enum:
                                  - overridden
                          rationale:
                            type: string
                        additionalProperties: false
                        required:
                          - actionType
                          - riskLevel
                          - recommendedDisposition
                          - finalDisposition
                          - rationale
                    memoryEvents:
                      type: array
                      items:
                        type: object
                        properties:
                          layer:
                            oneOf:
                              - type: string
                                enum:
                                  - session
                              - type: string
                                enum:
                                  - project_rule
                              - type: string
                                enum:
                                  - persistent_memory
                          operation:
                            oneOf:
                              - type: string
                                enum:
                                  - read
                              - type: string
                                enum:
                                  - write
                              - type: string
                                enum:
                                  - ignore
                          sourceId:
                            type: string
                          detail:
                            type: string
                        additionalProperties: false
                        required:
                          - layer
                          - operation
                          - sourceId
                          - detail
                    checkpoints:
                      type: array
                      items:
                        type: object
                        properties:
                          kind:
                            oneOf:
                              - type: string
                                enum:
                                  - manual
                              - type: string
                                enum:
                                  - auto
                          restorable:
                            type: boolean
                          label:
                            type: string
                        additionalProperties: false
                        required:
                          - kind
                          - restorable
                          - label
                    debugSnapshots:
                      type: array
                      items:
                        type: object
                        properties:
                          stepIndex:
                            type: number
                          label:
                            type: string
                          activeHooks:
                            type: array
                            items:
                              oneOf:
                                - type: string
                                  enum:
                                    - session_start
                                - type: string
                                  enum:
                                    - pre_plan
                                - type: string
                                  enum:
                                    - pre_tool
                                - type: string
                                  enum:
                                    - post_tool
                                - type: string
                                  enum:
                                    - pre_write
                                - type: string
                                  enum:
                                    - pre_handoff
                                - type: string
                                  enum:
                                    - on_error
                                - type: string
                                  enum:
                                    - session_end
                          memoryRefs:
                            type: array
                            items:
                              type: string
                          approvalState:
                            type: string
                          summary:
                            type: string
                        additionalProperties: false
                        required:
                          - stepIndex
                          - label
                          - activeHooks
                          - memoryRefs
                          - approvalState
                          - summary
                    runtimeSummary:
                      oneOf:
                        - type: 'null'
                        - type: object
                          properties:
                            workflowRunId:
                              type: number
                            traceId:
                              type: number
                            executionMode:
                              oneOf:
                                - type: string
                                  enum:
                                    - analysis_only
                                - type: string
                                  enum:
                                    - single_agent
                                - type: string
                                  enum:
                                    - parallel_swarm
                            finalStatus:
                              oneOf:
                                - type: string
                                  enum:
                                    - failed
                                - type: string
                                  enum:
                                    - completed
                            stopReason:
                              oneOf:
                                - type: 'null'
                                - type: string
                            approvalState:
                              type: string
                            hookCount:
                              type: number
                            memoryReadCount:
                              type: number
                            checkpointCreated:
                              type: boolean
                            handoffCount:
                              type: number
                            debugSnapshotCount:
                              type: number
                            decisionCount:
                              type: number
                          additionalProperties: false
                          required:
                            - executionMode
                            - finalStatus
                            - stopReason
                            - approvalState
                            - hookCount
                            - memoryReadCount
                            - checkpointCreated
                            - handoffCount
                            - debugSnapshotCount
                            - decisionCount
                  additionalProperties: false
            trigger:
              oneOf:
                - type: 'null'
                - type: string
            startedAt:
              type: string
              format: date-time
            completedAt:
              oneOf:
                - type: 'null'
                - type: string
                  format: date-time
          additionalProperties: false
          required:
            - id
            - workflowId
            - traceId
            - organizationId
            - status
            - input
            - output
            - totalCost
            - totalDurationMs
            - agentCount
            - handoffCount
            - retryCount
            - errorMessage
            - metadata
            - trigger
            - startedAt
            - completedAt
    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

````