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

# Clear payload

> Remove all payload fields from the specified points, leaving them with an empty payload. Only explicitly listed point IDs are supported; filter-based targeting is not available for this operation. Points that already have an empty payload are unaffected.



## OpenAPI

````yaml post /collections/{collection_name}/points/payload/clear
openapi: 3.0.3
info:
  title: Actian VectorAI DB - Points API
  description: Point CRUD operations for VectorAI DB.
  version: 1.0.0
  contact:
    name: Actian Corporation
    url: https://www.actian.com
servers:
  - url: http://localhost:6575
    description: Local development server (REST API)
  - url: https://api.vectorai.actian.com
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Points
    description: Point data operations
paths:
  /collections/{collection_name}/points/payload/clear:
    post:
      tags:
        - Points
      summary: Clear payload
      description: >-
        Remove all payload fields from the specified points, leaving them with
        an empty payload. Only explicitly listed point IDs are supported;
        filter-based targeting is not available for this operation. Points that
        already have an empty payload are unaffected.
      operationId: clear_payload
      parameters:
        - name: collection_name
          in: path
          required: true
          schema:
            type: string
            example: my_collection
          description: The name of the collection containing the target points.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - points
              properties:
                points:
                  type: array
                  items:
                    oneOf:
                      - type: integer
                      - type: string
                  example:
                    - 5
                  description: List of point IDs to clear payloads from.
            examples:
              clear:
                summary: Clear all payload
                value:
                  points:
                    - 5
      responses:
        '200':
          description: Payload cleared
          content:
            application/json:
              schema:
                type: object
                properties:
                  usage:
                    type: object
                    description: Resource usage information for this request.
                    properties:
                      hardware:
                        type: object
                        nullable: true
                        description: >-
                          Hardware resource counters for the operation,
                          including CPU, payload I/O, payload index I/O, and
                          vector I/O metrics.
                  time:
                    type: number
                    format: double
                    example: 0.000059651
                    description: Time spent to process this request, in seconds.
                  status:
                    type: string
                    example: ok
                    description: Operation status. Returns `ok` on success.
                  result:
                    type: object
                    description: >-
                      Operation result containing the status of the payload
                      clear.
                    properties:
                      operation_id:
                        type: integer
                        example: 0
                        description: Unique identifier for the operation.
                      status:
                        type: string
                        example: Completed
                        description: >-
                          Status of the operation. Returns `Completed` when the
                          operation finishes successfully.
              example:
                usage:
                  hardware: null
                time: 0.000059651
                status: ok
                result:
                  operation_id: 0
                  status: Completed
        4XX:
          description: Error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codeSamples:
        - lang: Python
          label: Clear payload
          source: |
            from actian_vectorai_client import VectorAIClient

            with VectorAIClient("localhost:6574") as client:
                # Clear all payload fields
                client.points.clear_payload("my_collection", ids=[5])
                print("✓ Cleared payload on point 5")
        - lang: JavaScript
          label: Clear payload
          source: |
            import { VectorAIClient } from '@actian/vectorai-client';

            const client = new VectorAIClient('localhost:6574');

            await client.points.clearPayload('my_collection', { ids: [5] });
            console.log('Cleared payload on point 5');

            client.close();
        - lang: cURL
          label: Clear payload
          source: >
            curl -X POST
            "http://localhost:6575/collections/my_collection/points/payload/clear"
            \
              -H "Content-Type: application/json" \
              -H 'Authorization: Bearer <admin-jwt-or-access-token>' \
              -d '{
                "points": [5]
              }'
components:
  schemas:
    ErrorResponse:
      type: object
      description: Error response returned when a request fails.
      properties:
        status:
          type: object
          description: Status object containing the error message.
          properties:
            error:
              type: string
              description: Human-readable error message describing what went wrong.
              example: Collection `my_collection` doesn't exist!
        time:
          type: number
          format: double
          description: Time spent to process this request, in seconds.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Admin JWT or access token for authenticating requests to VectorAI DB.

````