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

# Archive an agent



## OpenAPI

````yaml openapi.json POST /v1/agents/{agentId}/archive
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/agents/{agentId}/archive:
    post:
      tags:
        - Agents
      summary: Archive an agent
      operationId: archiveAgent
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: The Egma agent ID returned by Register an agent or List agents.
            examples:
              - agt_01M0E4J0BBE1FVDVTZ1BSS5C97
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            description: >-
              Project to act in. A project-scoped API key already identifies its
              project.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties: {}
              additionalProperties: false
      responses:
        '200':
          description: The archived agent and the work stopped with it.
          content:
            application/json:
              schema:
                type: object
                properties:
                  agent:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      projectId:
                        type: string
                        minLength: 1
                      name:
                        type: string
                      agentPlatform:
                        type: string
                        enum:
                          - retell
                          - livekit
                      platformAgentId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      retellModality:
                        anyOf:
                          - type: string
                            enum:
                              - voice
                              - chat
                          - type: 'null'
                      monitoringKeyPresent:
                        type: boolean
                      monitoringApiKeyHint:
                        anyOf:
                          - type: string
                          - type: 'null'
                      pullProductionCalls:
                        type: boolean
                      monitoringConfigured:
                        type: boolean
                      lastReceivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      archived:
                        type: boolean
                      archivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - projectId
                      - name
                      - agentPlatform
                      - platformAgentId
                      - retellModality
                      - monitoringKeyPresent
                      - monitoringApiKeyHint
                      - pullProductionCalls
                      - monitoringConfigured
                      - lastReceivedAt
                      - archived
                      - archivedAt
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                  archivedConnections:
                    type: array
                    items:
                      type: string
                      minLength: 1
                  canceledRunCount:
                    type: integer
                    minimum: 0
                required:
                  - agent
                  - archivedConnections
                  - canceledRunCount
                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'
        '404':
          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'
        '503':
          description: The request was refused.
          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.

````