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

# Apply the complete authored state from a repository

> The complete authored suites and tests are applied atomically. Each test carries its own mock tools and env. Missing resources refuse rather than delete.



## OpenAPI

````yaml openapi.json POST /v1/repository/change-set
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/repository/change-set:
    post:
      tags:
        - Repository
      summary: Apply the complete authored state from a repository
      description: >-
        The complete authored suites and tests are applied atomically. Each test
        carries its own mock tools and env. Missing resources refuse rather than
        delete.
      operationId: applyRepositoryChangeSet
      parameters:
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                suites:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      name:
                        type: string
                    required:
                      - id
                      - name
                    additionalProperties: false
                tests:
                  type: array
                  items:
                    type: object
                    properties:
                      clientRef:
                        type: string
                      suiteId:
                        type: string
                        minLength: 1
                      name:
                        type: string
                      description:
                        type: string
                      scenario:
                        type: string
                      expectedBehaviors:
                        type: array
                        items:
                          type: string
                      personas:
                        type: array
                        items:
                          type: string
                      mockTools:
                        type: array
                        items:
                          description: >-
                            One named tool's fixed response for this test.
                            Supply exactly one of answer or error. Tools without
                            a mock run normally.
                          oneOf:
                            - type: object
                              properties:
                                tool:
                                  type: string
                                answer: {}
                                error:
                                  not: {}
                              required:
                                - tool
                                - answer
                              additionalProperties: false
                            - type: object
                              properties:
                                tool:
                                  type: string
                                answer:
                                  not: {}
                                error:
                                  type: string
                              required:
                                - tool
                                - error
                              additionalProperties: false
                      env:
                        anyOf:
                          - type: object
                            properties:
                              retell_dynamic_variables:
                                type: object
                                description: >-
                                  String values supplied to the Retell agent
                                  before the conversation. Variable names
                                  beginning with egma_ are reserved.
                                additionalProperties:
                                  type: string
                              job_dispatch_metadata:
                                type: object
                                description: >-
                                  Context delivered to the LiveKit worker in
                                  ctx.job.metadata.
                                additionalProperties: true
                            additionalProperties: false
                          - type: 'null'
                      expectedVersionId:
                        type: string
                        minLength: 1
                      expectedRevision:
                        type: string
                        minLength: 1
                    required:
                      - clientRef
                      - suiteId
                      - name
                      - description
                      - scenario
                      - expectedBehaviors
                      - personas
                      - mockTools
                      - env
                    additionalProperties: false
              required:
                - suites
                - tests
              additionalProperties: false
      responses:
        '200':
          description: The tests after the change set was applied.
          content:
            application/json:
              schema:
                type: object
                properties:
                  tests:
                    type: array
                    items:
                      type: object
                      properties:
                        clientRef:
                          type: string
                        test:
                          type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            projectId:
                              type: string
                              minLength: 1
                            suiteId:
                              type: string
                              minLength: 1
                            name:
                              type: string
                            description:
                              anyOf:
                                - type: string
                                - type: 'null'
                            version:
                              type: integer
                              minimum: 1
                            versionId:
                              type: string
                              minLength: 1
                            scenario:
                              type: string
                            expectedBehaviors:
                              type: array
                              items:
                                type: string
                            personas:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    minLength: 1
                                  name:
                                    type: string
                                  archivedAt:
                                    anyOf:
                                      - type: string
                                        format: date-time
                                      - type: 'null'
                                required:
                                  - id
                                  - name
                                  - archivedAt
                                additionalProperties: false
                            mockTools:
                              type: array
                              items:
                                description: >-
                                  One named tool's fixed response for this test.
                                  Supply exactly one of answer or error. Tools
                                  without a mock run normally.
                                oneOf:
                                  - type: object
                                    properties:
                                      tool:
                                        type: string
                                      answer: {}
                                      error:
                                        not: {}
                                    required:
                                      - tool
                                      - answer
                                    additionalProperties: false
                                  - type: object
                                    properties:
                                      tool:
                                        type: string
                                      answer:
                                        not: {}
                                      error:
                                        type: string
                                    required:
                                      - tool
                                      - error
                                    additionalProperties: false
                            env:
                              anyOf:
                                - type: object
                                  properties:
                                    retell_dynamic_variables:
                                      type: object
                                      description: >-
                                        String values supplied to the Retell
                                        agent before the conversation. Variable
                                        names beginning with egma_ are reserved.
                                      additionalProperties:
                                        type: string
                                    job_dispatch_metadata:
                                      type: object
                                      description: >-
                                        Context delivered to the LiveKit worker
                                        in ctx.job.metadata.
                                      additionalProperties: true
                                  additionalProperties: false
                                - type: 'null'
                            revision:
                              type: string
                              minLength: 1
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                          required:
                            - id
                            - projectId
                            - suiteId
                            - name
                            - description
                            - version
                            - versionId
                            - scenario
                            - expectedBehaviors
                            - personas
                            - mockTools
                            - env
                            - revision
                            - createdAt
                            - updatedAt
                          additionalProperties: false
                      required:
                        - clientRef
                        - test
                      additionalProperties: false
                required:
                  - tests
                additionalProperties: false
        '400':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '403':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '409':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '422':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````