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

# Create experiments experiments

> Requires scopes: eval:write



## OpenAPI

````yaml /api-reference/openapi.json post /api/experiments
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/experiments:
    post:
      tags:
        - experiments
      summary: Create experiments experiments
      description: 'Requires scopes: eval:write'
      operationId: post_experiments
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiExperimentsRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiExperimentsResponse200ApplicationJson
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiExperimentsResponse201ApplicationJson
        '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:write
components:
  schemas:
    PostApiExperimentsRequest:
      type: object
      properties:
        evaluationId:
          type: number
        name:
          type: string
        idempotencyKey:
          type: string
        baselineVariantKey:
          type: string
        variants:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              key:
                type: string
              provider:
                oneOf:
                  - type: 'null'
                  - type: string
              promptVersionId:
                oneOf:
                  - type: 'null'
                  - type: string
              routingProfileId:
                oneOf:
                  - type: 'null'
                  - type: string
              model:
                oneOf:
                  - type: 'null'
                  - type: string
              messages:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    role:
                      oneOf:
                        - type: string
                          enum:
                            - user
                        - type: string
                          enum:
                            - system
                        - type: string
                          enum:
                            - tool
                        - type: string
                          enum:
                            - assistant
                    content:
                      type: string
                    name:
                      type: string
                  additionalProperties: false
                  required:
                    - id
                    - role
                    - content
              parameters:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/JsonValue'
              tools:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/JsonValue'
              systemPrompt:
                oneOf:
                  - type: 'null'
                  - type: string
              policies:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/JsonValue'
              expectedPromptContentHash:
                type: string
              routingStrategy:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/JsonValue'
              scorerConfigIds:
                type: array
                items:
                  type: number
              calibrationMappingIds:
                type: array
                items:
                  type: string
            additionalProperties: false
            required:
              - name
              - key
        description:
          oneOf:
            - type: 'null'
            - type: string
        environment:
          oneOf:
            - type: string
              enum:
                - dev
            - type: string
              enum:
                - staging
            - type: string
              enum:
                - prod
        datasetVersionId:
          oneOf:
            - type: 'null'
            - type: string
        seed:
          type: number
        winnerPolicy:
          type: object
          properties:
            minimumPassRateDelta:
              type: number
            maximumCostIncreasePercent:
              type: number
            maximumP95LatencyIncreasePercent:
              type: number
            allowIncomparableJudges:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
            allowRegressions:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
          additionalProperties: false
        expectedDatasetContentHash:
          type: string
        runnerVersion:
          type: string
        codeVersion:
          type: string
        policies:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
      additionalProperties: false
      required:
        - evaluationId
        - name
        - idempotencyKey
        - baselineVariantKey
        - variants
    PostApiExperimentsResponse200ApplicationJson:
      type: object
      properties:
        idempotentReplay:
          type: boolean
        id:
          type: string
        organizationId:
          $ref: '#/components/schemas/OrganizationId'
        evaluationId:
          type: number
        name:
          type: string
        description:
          oneOf:
            - type: 'null'
            - type: string
        status:
          type: string
        baselineVariantKey:
          type: string
        datasetVersionId:
          oneOf:
            - type: 'null'
            - type: string
        snapshotHash:
          type: string
        snapshotJson:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            snapshotHashVersion:
              type: string
              enum:
                - sha256-canonical-v1
            name:
              type: string
            description:
              oneOf:
                - type: 'null'
                - type: string
            evaluationId:
              type: number
            environment:
              oneOf:
                - type: string
                  enum:
                    - dev
                - type: string
                  enum:
                    - staging
                - type: string
                  enum:
                    - prod
            seed:
              type: number
            code:
              type: object
              properties:
                runnerVersion:
                  type: string
                codeVersion:
                  type: string
                schemaVersion:
                  type: string
              additionalProperties: false
              required:
                - runnerVersion
                - codeVersion
                - schemaVersion
            evaluation:
              type: object
              properties:
                type:
                  type: string
                executionSettings:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                modelSettings:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                customMetrics:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                executorType:
                  oneOf:
                    - type: 'null'
                    - type: string
                executorConfig:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
              additionalProperties: false
              required:
                - type
                - executionSettings
                - modelSettings
                - customMetrics
                - executorType
                - executorConfig
            dataset:
              type: object
              properties:
                id:
                  oneOf:
                    - type: 'null'
                    - type: string
                versionId:
                  oneOf:
                    - type: 'null'
                    - type: string
                contentHash:
                  type: string
                schema:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: number
                      name:
                        type: string
                      input:
                        type: string
                      expectedOutput:
                        oneOf:
                          - type: 'null'
                          - type: string
                      metadata:
                        $ref: '#/components/schemas/JsonValue'
                      lifecycleState:
                        type: string
                      originType:
                        type: string
                      datasetId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetVersionId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetRowId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetRowContentHash:
                        oneOf:
                          - type: 'null'
                          - type: string
                      inputHash:
                        oneOf:
                          - type: 'null'
                          - type: string
                      lastLifecycleTransitionAt:
                        type: string
                      archivedAt:
                        oneOf:
                          - type: 'null'
                          - type: string
                      supersededById:
                        oneOf:
                          - type: 'null'
                          - type: number
                      supersededAt:
                        oneOf:
                          - type: 'null'
                          - type: string
                      supersessionReason:
                        oneOf:
                          - type: 'null'
                          - type: string
                      createdAt:
                        type: string
                    additionalProperties: false
                    required:
                      - id
                      - name
                      - input
                      - expectedOutput
                      - metadata
                      - lifecycleState
                      - originType
                      - datasetId
                      - datasetVersionId
                      - datasetRowId
                      - datasetRowContentHash
                      - inputHash
                      - lastLifecycleTransitionAt
                      - archivedAt
                      - supersededById
                      - supersededAt
                      - supersessionReason
                      - createdAt
                datasetHubRows:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      ordinal:
                        type: number
                      contentHash:
                        type: string
                      payload:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                    additionalProperties: false
                    required:
                      - id
                      - ordinal
                      - contentHash
                      - payload
              additionalProperties: false
              required:
                - id
                - versionId
                - contentHash
                - schema
                - rows
                - datasetHubRows
            baselineVariantKey:
              type: string
            variants:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  ordinal:
                    type: number
                  name:
                    type: string
                  prompt:
                    type: object
                    properties:
                      versionId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      artifactId:
                        oneOf:
                          - type: 'null'
                          - type: number
                      contentHash:
                        type: string
                      payload:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                      messages:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            role:
                              oneOf:
                                - type: string
                                  enum:
                                    - user
                                - type: string
                                  enum:
                                    - system
                                - type: string
                                  enum:
                                    - tool
                                - type: string
                                  enum:
                                    - assistant
                            content:
                              type: string
                            name:
                              type: string
                          additionalProperties: false
                          required:
                            - id
                            - role
                            - content
                      systemPrompt:
                        oneOf:
                          - type: 'null'
                          - type: string
                    additionalProperties: false
                    required:
                      - versionId
                      - artifactId
                      - contentHash
                      - payload
                      - messages
                      - systemPrompt
                  routing:
                    type: object
                    properties:
                      profileId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      provider:
                        oneOf:
                          - type: 'null'
                          - type: string
                      model:
                        oneOf:
                          - type: 'null'
                          - type: string
                      strategy:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                    additionalProperties: false
                    required:
                      - profileId
                      - provider
                      - model
                      - strategy
                  parameters:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  tools:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  scorers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        name:
                          type: string
                        model:
                          type: string
                        promptTemplate:
                          type: string
                        promptTemplateHash:
                          type: string
                        criteria:
                          $ref: '#/components/schemas/JsonValue'
                        settings:
                          $ref: '#/components/schemas/JsonValue'
                      additionalProperties: false
                      required:
                        - id
                        - name
                        - model
                        - promptTemplate
                        - promptTemplateHash
                        - criteria
                        - settings
                  calibrationMappings:
                    type: array
                    items:
                      type: object
                      properties:
                        mappingId:
                          type: string
                        calibrationRunId:
                          type: string
                        method:
                          type: string
                        scoreScaleVersion:
                          type: string
                        mapping:
                          type: object
                          additionalProperties:
                            $ref: '#/components/schemas/JsonValue'
                      additionalProperties: false
                      required:
                        - mappingId
                        - calibrationRunId
                        - method
                        - scoreScaleVersion
                        - mapping
                  policies:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  configurationHash:
                    type: string
                additionalProperties: false
                required:
                  - key
                  - ordinal
                  - name
                  - prompt
                  - routing
                  - parameters
                  - tools
                  - scorers
                  - calibrationMappings
                  - policies
                  - configurationHash
            policies:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
            createdFrom:
              type: object
              properties:
                surface:
                  oneOf:
                    - type: string
                      enum:
                        - playground
                    - type: string
                      enum:
                        - api
                playgroundId:
                  oneOf:
                    - type: 'null'
                    - type: number
              additionalProperties: false
              required:
                - surface
                - playgroundId
          additionalProperties: false
          required:
            - schemaVersion
            - snapshotHashVersion
            - name
            - description
            - evaluationId
            - environment
            - seed
            - code
            - evaluation
            - dataset
            - baselineVariantKey
            - variants
            - policies
            - createdFrom
        createRequestHash:
          type: string
        winnerPolicy:
          type: object
          properties:
            minimumPassRateDelta:
              type: number
            maximumCostIncreasePercent:
              type: number
            maximumP95LatencyIncreasePercent:
              type: number
            allowIncomparableJudges:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
            allowRegressions:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
          additionalProperties: false
        createIdempotencyKey:
          type: string
        createdBy:
          type: string
        createdAt:
          type: string
          format: date-time
        completedAt:
          oneOf:
            - type: 'null'
            - type: string
              format: date-time
      additionalProperties: false
      required:
        - idempotentReplay
        - id
        - organizationId
        - evaluationId
        - name
        - description
        - status
        - baselineVariantKey
        - datasetVersionId
        - snapshotHash
        - snapshotJson
        - createRequestHash
        - winnerPolicy
        - createIdempotencyKey
        - createdBy
        - createdAt
        - completedAt
    PostApiExperimentsResponse201ApplicationJson:
      type: object
      properties:
        idempotentReplay:
          type: boolean
        id:
          type: string
        organizationId:
          $ref: '#/components/schemas/OrganizationId'
        evaluationId:
          type: number
        name:
          type: string
        description:
          oneOf:
            - type: 'null'
            - type: string
        status:
          type: string
        baselineVariantKey:
          type: string
        datasetVersionId:
          oneOf:
            - type: 'null'
            - type: string
        snapshotHash:
          type: string
        snapshotJson:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            snapshotHashVersion:
              type: string
              enum:
                - sha256-canonical-v1
            name:
              type: string
            description:
              oneOf:
                - type: 'null'
                - type: string
            evaluationId:
              type: number
            environment:
              oneOf:
                - type: string
                  enum:
                    - dev
                - type: string
                  enum:
                    - staging
                - type: string
                  enum:
                    - prod
            seed:
              type: number
            code:
              type: object
              properties:
                runnerVersion:
                  type: string
                codeVersion:
                  type: string
                schemaVersion:
                  type: string
              additionalProperties: false
              required:
                - runnerVersion
                - codeVersion
                - schemaVersion
            evaluation:
              type: object
              properties:
                type:
                  type: string
                executionSettings:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                modelSettings:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                customMetrics:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
                executorType:
                  oneOf:
                    - type: 'null'
                    - type: string
                executorConfig:
                  oneOf:
                    - type: 'null'
                    - type: object
                      additionalProperties:
                        $ref: '#/components/schemas/JsonValue'
              additionalProperties: false
              required:
                - type
                - executionSettings
                - modelSettings
                - customMetrics
                - executorType
                - executorConfig
            dataset:
              type: object
              properties:
                id:
                  oneOf:
                    - type: 'null'
                    - type: string
                versionId:
                  oneOf:
                    - type: 'null'
                    - type: string
                contentHash:
                  type: string
                schema:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/JsonValue'
                rows:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: number
                      name:
                        type: string
                      input:
                        type: string
                      expectedOutput:
                        oneOf:
                          - type: 'null'
                          - type: string
                      metadata:
                        $ref: '#/components/schemas/JsonValue'
                      lifecycleState:
                        type: string
                      originType:
                        type: string
                      datasetId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetVersionId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetRowId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      datasetRowContentHash:
                        oneOf:
                          - type: 'null'
                          - type: string
                      inputHash:
                        oneOf:
                          - type: 'null'
                          - type: string
                      lastLifecycleTransitionAt:
                        type: string
                      archivedAt:
                        oneOf:
                          - type: 'null'
                          - type: string
                      supersededById:
                        oneOf:
                          - type: 'null'
                          - type: number
                      supersededAt:
                        oneOf:
                          - type: 'null'
                          - type: string
                      supersessionReason:
                        oneOf:
                          - type: 'null'
                          - type: string
                      createdAt:
                        type: string
                    additionalProperties: false
                    required:
                      - id
                      - name
                      - input
                      - expectedOutput
                      - metadata
                      - lifecycleState
                      - originType
                      - datasetId
                      - datasetVersionId
                      - datasetRowId
                      - datasetRowContentHash
                      - inputHash
                      - lastLifecycleTransitionAt
                      - archivedAt
                      - supersededById
                      - supersededAt
                      - supersessionReason
                      - createdAt
                datasetHubRows:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      ordinal:
                        type: number
                      contentHash:
                        type: string
                      payload:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                    additionalProperties: false
                    required:
                      - id
                      - ordinal
                      - contentHash
                      - payload
              additionalProperties: false
              required:
                - id
                - versionId
                - contentHash
                - schema
                - rows
                - datasetHubRows
            baselineVariantKey:
              type: string
            variants:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  ordinal:
                    type: number
                  name:
                    type: string
                  prompt:
                    type: object
                    properties:
                      versionId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      artifactId:
                        oneOf:
                          - type: 'null'
                          - type: number
                      contentHash:
                        type: string
                      payload:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                      messages:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            role:
                              oneOf:
                                - type: string
                                  enum:
                                    - user
                                - type: string
                                  enum:
                                    - system
                                - type: string
                                  enum:
                                    - tool
                                - type: string
                                  enum:
                                    - assistant
                            content:
                              type: string
                            name:
                              type: string
                          additionalProperties: false
                          required:
                            - id
                            - role
                            - content
                      systemPrompt:
                        oneOf:
                          - type: 'null'
                          - type: string
                    additionalProperties: false
                    required:
                      - versionId
                      - artifactId
                      - contentHash
                      - payload
                      - messages
                      - systemPrompt
                  routing:
                    type: object
                    properties:
                      profileId:
                        oneOf:
                          - type: 'null'
                          - type: string
                      provider:
                        oneOf:
                          - type: 'null'
                          - type: string
                      model:
                        oneOf:
                          - type: 'null'
                          - type: string
                      strategy:
                        type: object
                        additionalProperties:
                          $ref: '#/components/schemas/JsonValue'
                    additionalProperties: false
                    required:
                      - profileId
                      - provider
                      - model
                      - strategy
                  parameters:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  tools:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  scorers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: number
                        name:
                          type: string
                        model:
                          type: string
                        promptTemplate:
                          type: string
                        promptTemplateHash:
                          type: string
                        criteria:
                          $ref: '#/components/schemas/JsonValue'
                        settings:
                          $ref: '#/components/schemas/JsonValue'
                      additionalProperties: false
                      required:
                        - id
                        - name
                        - model
                        - promptTemplate
                        - promptTemplateHash
                        - criteria
                        - settings
                  calibrationMappings:
                    type: array
                    items:
                      type: object
                      properties:
                        mappingId:
                          type: string
                        calibrationRunId:
                          type: string
                        method:
                          type: string
                        scoreScaleVersion:
                          type: string
                        mapping:
                          type: object
                          additionalProperties:
                            $ref: '#/components/schemas/JsonValue'
                      additionalProperties: false
                      required:
                        - mappingId
                        - calibrationRunId
                        - method
                        - scoreScaleVersion
                        - mapping
                  policies:
                    type: object
                    additionalProperties:
                      $ref: '#/components/schemas/JsonValue'
                  configurationHash:
                    type: string
                additionalProperties: false
                required:
                  - key
                  - ordinal
                  - name
                  - prompt
                  - routing
                  - parameters
                  - tools
                  - scorers
                  - calibrationMappings
                  - policies
                  - configurationHash
            policies:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JsonValue'
            createdFrom:
              type: object
              properties:
                surface:
                  oneOf:
                    - type: string
                      enum:
                        - playground
                    - type: string
                      enum:
                        - api
                playgroundId:
                  oneOf:
                    - type: 'null'
                    - type: number
              additionalProperties: false
              required:
                - surface
                - playgroundId
          additionalProperties: false
          required:
            - schemaVersion
            - snapshotHashVersion
            - name
            - description
            - evaluationId
            - environment
            - seed
            - code
            - evaluation
            - dataset
            - baselineVariantKey
            - variants
            - policies
            - createdFrom
        createRequestHash:
          type: string
        winnerPolicy:
          type: object
          properties:
            minimumPassRateDelta:
              type: number
            maximumCostIncreasePercent:
              type: number
            maximumP95LatencyIncreasePercent:
              type: number
            allowIncomparableJudges:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
            allowRegressions:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
          additionalProperties: false
        createIdempotencyKey:
          type: string
        createdBy:
          type: string
        createdAt:
          type: string
          format: date-time
        completedAt:
          oneOf:
            - type: 'null'
            - type: string
              format: date-time
      additionalProperties: false
      required:
        - idempotentReplay
        - id
        - organizationId
        - evaluationId
        - name
        - description
        - status
        - baselineVariantKey
        - datasetVersionId
        - snapshotHash
        - snapshotJson
        - createRequestHash
        - winnerPolicy
        - createIdempotencyKey
        - createdBy
        - createdAt
        - completedAt
    JsonValue:
      oneOf:
        - type: 'null'
        - type: boolean
        - type: number
        - type: string
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    OrganizationId:
      type: string
      format: uuid
    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

````