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

# Archive a phase



## OpenAPI

````yaml https://app.pepline.ai/api/v1/openapi.yaml post /agents/{agent_slug}/flow/states/{id}/archive
openapi: 3.1.0
info:
  title: pepline API
  version: '1'
  description: |
    The pepline knowledge ingestion API: push knowledge into your
    organization's library from your own systems — CMS hooks, sync scripts,
    Zapier/Make/n8n scenarios — and keep whole websites fresh. One inbound
    API instead of N connectors; you own the trigger, we own idempotency.
servers:
  - url: https://app.pepline.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Organization
    description: The identity behind your key — confirm it works and read your agent slugs.
  - name: Knowledge sources
    description: >-
      Push and sync the knowledge your agents stand on — text, files, pages,
      whole websites.
  - name: Agents
    description: List and provision agents, and tune each agent's widget settings.
  - name: Services
    description: The offerings your agents present and reason about.
  - name: Fit criteria
    description: What makes a good or poor lead — the signals your agents qualify against.
  - name: Voice profiles
    description: How your agents sound — tone, formality, phrasing.
  - name: Flow
    description: >-
      Author an agent's conversation — its phases and the answers each one
      captures.
  - name: Catalog
    description: >-
      Draft services, voice, and fit criteria from your knowledge, then accept
      or dismiss the proposals.
paths:
  /agents/{agent_slug}/flow/states/{id}/archive:
    post:
      tags:
        - Flow
      summary: Archive a phase
      operationId: archiveFlowState
      parameters:
        - name: agent_slug
          in: path
          required: true
          schema:
            type: string
        - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: The archived phase.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowState'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Invalid'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: integer
  schemas:
    FlowState:
      type: object
      required:
        - object
        - id
        - key
        - title
        - position
        - kind
        - objective
        - exit_criteria
        - max_turns
        - archived
        - slots
      properties:
        object:
          type: string
          const: flow_state
        id:
          type: integer
        key:
          type: string
        title:
          type: string
        position:
          type: integer
        kind:
          type: string
          enum:
            - step
            - loop
            - terminal
        objective:
          type: string
        exit_criteria:
          type: string
        max_turns:
          type: integer
        tools:
          type: array
          items:
            type: string
        archived:
          type: boolean
        slots:
          type: array
          items:
            $ref: '#/components/schemas/InformationSlot'
    InformationSlot:
      type: object
      required:
        - object
        - id
        - key
        - title
        - data_type
        - archived
      properties:
        object:
          type: string
          const: information_slot
        id:
          type: integer
        key:
          type: string
          description: >-
            lowercase letters, digits, underscores; the extraction-schema
            property + slot_values key.
        title:
          type:
            - string
            - 'null'
          description: Owner-facing label (the chip group header).
        data_type:
          type: string
          enum:
            - string
            - enum
            - band
            - boolean
            - email
        required:
          type: boolean
        enum_values:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Required for enum/band; the chip values.
        enum_labels:
          type: object
          description: value → display label.
        translations:
          type: object
          description: locale → { title, enum_labels } overrides.
        description:
          type:
            - string
            - 'null'
          description: LLM-facing extraction guidance (not shown to visitors).
        archived:
          type: boolean
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
          properties:
            type:
              type: string
              enum:
                - authentication_error
                - invalid_request_error
                - rate_limit_error
                - api_error
            code:
              type: string
              enum:
                - missing_api_key
                - invalid_api_key
                - resource_missing
                - method_not_allowed
                - resource_archived
                - idempotency_conflict
                - parameter_invalid
                - parameter_missing
                - parameter_unknown
                - organization_required
                - rate_limited
                - flow_invalid
                - internal
            message:
              type: string
            param:
              type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: No such resource in your organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Invalid:
      description: Validation failed — `error.param` names the field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped;
        treat them like passwords.

````