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

# Erase memory

> Delete what an agent remembers, in bulk, with a preview first.

<Warning>
  **`dry_run` defaults to `true`.** The first call reports what *would* be deleted. Send
  `"dry_run": false` to actually delete.
</Warning>

```json theme={"dark"}
{ "last_updated_from": "2026-08-01", "last_updated_to": "2026-08-31", "dry_run": true }
```

```json theme={"dark"}
{ "dry_run": true, "subjects": 214, "facts": 1893, "transcript_turns": 4402 }
```

Target a date range, specific callers by id, or leave both out for everything. Deletions are
tombstoned and take effect at once.

This is the path to satisfy a data-erasure request: run it for one person, check the counts, then run
it for real and keep the receipt.


## OpenAPI

````yaml developers/openapi.json POST /v1/agents/{agent_id}/memory/flush
openapi: 3.1.0
info:
  title: Vocily API
  description: >-
    Public REST API for Vocily. Build and configure an agent, publish a version
    and put it live, place outbound calls, and read back calls, chats and what
    the agent remembered. Authenticate with a workspace API key as a Bearer
    token.


    Some things stay in the dashboard, by design: creating an API key, buying or
    connecting a phone number, setting an agent's webhook URL, connecting
    WhatsApp and its templates, building HTTP tools, and running batch
    campaigns.
  version: v1
servers:
  - url: https://api.vocily.ai
    description: Production
security: []
paths:
  /v1/agents/{agent_id}/memory/flush:
    post:
      tags:
        - agent-memory
      summary: Flush
      description: >-
        Delete whole notebooks matching the filter. Previews unless `dry_run` is
        false.
      operationId: flush_v1_agents__agent_id__memory_flush_post
      parameters:
        - name: agent_id
          in: path
          required: true
          schema:
            type: string
            title: Agent Id
          description: The agent's id, as `GET /v1/agents` returns it.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicMemoryFlushRequest'
            example:
              last_updated_from: '2026-08-01'
              last_updated_to: '2026-08-31'
              dry_run: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemoryFlushResult'
              example:
                dry_run: true
                subjects: 0
                facts: 0
                transcript_turns: 0
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                detail: Invalid API key
                code: UNAUTHORIZED
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded — honor `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                code: rate_limited
      security:
        - bearerAuth: []
components:
  schemas:
    PublicMemoryFlushRequest:
      properties:
        last_updated_on:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Updated On
          description: >-
            Erase memory last touched on this date. A selector, not a stored
            field.
        last_updated_from:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Updated From
          description: Erase memory last touched on or after this date.
        last_updated_to:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Updated To
          description: Erase memory last touched on or before this date.
        subjects:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Subjects
          description: >-
            Erase only these people, by subject id. Omit to cover everyone the
            filters match.
        dry_run:
          type: boolean
          title: Dry Run
          description: >-
            **Send `true` first.** It reports exactly what WOULD be erased and
            deletes nothing — the only way to check a filter before an
            irreversible delete.
          default: true
      additionalProperties: false
      type: object
      title: PublicMemoryFlushRequest
    MemoryFlushResult:
      properties:
        dry_run:
          type: boolean
          title: Dry Run
          description: Whether this was a rehearsal. `true` means nothing was deleted.
        subjects:
          type: integer
          title: Subjects
          description: How many people were affected.
        facts:
          type: integer
          title: Facts
          description: How many facts were erased.
        transcript_turns:
          type: integer
          title: Transcript Turns
          description: How many stored turns were erased.
      type: object
      required:
        - dry_run
        - subjects
        - facts
        - transcript_turns
      title: MemoryFlushResult
      description: What a flush did, or would do.
    ApiError:
      type: object
      description: >-
        Error envelope. `code` is derived from the HTTP status, so branch on it
        for the CLASS of failure; the specific reason is `detail.code`. Every
        public refusal carries both.
      properties:
        detail:
          type: object
          description: >-
            The reason. `code` is the domain reason (e.g. `call_not_found`) and
            `message` is a sentence safe to log. On a `422` it also carries
            `errors[]`, one entry per rejected field — see
            `HTTPValidationError`.
          properties:
            code:
              type: string
              example: call_not_found
            message:
              type: string
              example: Call not found
          required:
            - code
            - message
        code:
          type: string
          description: Derived from the HTTP status, not the domain reason.
          example: NOT_FOUND
    HTTPValidationError:
      type: object
      title: HTTPValidationError
      description: >-
        A request the API could not read: a field of the wrong type, out of
        range, missing, or one we do not accept. Same envelope as every other
        error.
      properties:
        detail:
          type: object
          description: >-
            What was wrong, as `code`, a one-line `message`, and every offending
            field in `errors`.
          required:
            - code
            - message
            - errors
          properties:
            code:
              type: string
              enum:
                - validation_error
            message:
              type: string
              description: >-
                The first problem in one line, with a count of the rest — e.g.
                `model.temperature: Input should be less than or equal to 2 (and
                1 more)`.
            errors:
              type: array
              items:
                $ref: '#/components/schemas/ValidationError'
              description: >-
                One entry per offending field. **Every problem is reported at
                once**, not just the first, so a malformed body needs one round
                trip to fix rather than one per field.
        code:
          type: string
          enum:
            - VALIDATION_ERROR
          description: Derived from the HTTP status, as on every error.
    ValidationError:
      type: object
      title: ValidationError
      required:
        - field
        - message
        - type
      properties:
        field:
          type: string
          description: >-
            The offending field as a path from the root of your request —
            `voice.speed`, `variables[0].key`, or `query.limit` for a query
            parameter. **This is the field to read.**
        message:
          type: string
          description: What is wrong with it, in plain language.
        type:
          type: string
          description: >-
            A stable machine code for the kind of failure, e.g.
            `extra_forbidden` for a field we do not accept, `missing` for a
            required one, or `less_than_equal` for a number out of range. Switch
            on this rather than on `message`, which may be reworded.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key as a Bearer token, e.g. `Authorization: Bearer vk_…`.'

````