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

# List Vectors

> List documents in a vector store with cursor-based pagination.

**Use Cases:** Browse documents, export content, audit stored data, or retrieve documents by metadata
without semantic search.

**Ordering:** Documents are returned in storage order (insertion order), not ranked by similarity.
For similarity-based retrieval, use the query endpoint.

**Filtering:** Apply metadata filters to narrow results to specific subsets (e.g., all documents
where `category: "research"`). Only indexed fields can be used for filtering.

**Pagination:** Uses cursor-based pagination for efficient traversal of large datasets. Pass the
`next_cursor` from each response as `starting_after` to retrieve the next page, or `prev_cursor`
as `ending_before` to retrieve the previous page. A null cursor indicates no further pages exist.

**Embedding Vectors:** Setting `include_vectors=true` includes the full embedding vector arrays in
the response. This significantly increases payload size and reduces the maximum page size from 1000 to
100 documents. Enable only when raw vectors are required for external processing.



## OpenAPI

````yaml https://api.dev-sgp.scale.com/openapi-versions/v5/openapi.json get /v5/vector-stores/{vector_store_name}/vectors
openapi: 3.1.0
info:
  title: EGP API V5
  description: >-
    This is the parent API for all EGP APIs. If you are looking for the EGP API,
    please go to https://api.egp.scale.com/docs.
  contact:
    name: Scale Generative AI Platform
    url: https://scale.com/genai-platform
  version: 0.1.0
servers:
  - url: https://api.egp.scale.com
security: []
paths:
  /v5/vector-stores/{vector_store_name}/vectors:
    get:
      tags:
        - Vector Stores
      summary: List Vectors
      description: >-
        List documents in a vector store with cursor-based pagination.


        **Use Cases:** Browse documents, export content, audit stored data, or
        retrieve documents by metadata

        without semantic search.


        **Ordering:** Documents are returned in storage order (insertion order),
        not ranked by similarity.

        For similarity-based retrieval, use the query endpoint.


        **Filtering:** Apply metadata filters to narrow results to specific
        subsets (e.g., all documents

        where `category: "research"`). Only indexed fields can be used for
        filtering.


        **Pagination:** Uses cursor-based pagination for efficient traversal of
        large datasets. Pass the

        `next_cursor` from each response as `starting_after` to retrieve the
        next page, or `prev_cursor`

        as `ending_before` to retrieve the previous page. A null cursor
        indicates no further pages exist.


        **Embedding Vectors:** Setting `include_vectors=true` includes the full
        embedding vector arrays in

        the response. This significantly increases payload size and reduces the
        maximum page size from 1000 to

        100 documents. Enable only when raw vectors are required for external
        processing.
      operationId: GET-V5-/v5/vector-stores/vector_store_name/vectors
      parameters:
        - name: vector_store_name
          in: path
          required: true
          schema:
            type: string
            description: The name of the vector store
            title: Vector Store Name
          description: The name of the vector store
        - name: filter
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Metadata filter expression (JSON)
            title: Filter
          description: Metadata filter expression (JSON)
        - name: include_vectors
          in: query
          required: false
          schema:
            type: boolean
            description: Include embedding vectors
            default: false
            title: Include Vectors
          description: Include embedding vectors
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Alias for starting_after. Use starting_after instead.
            deprecated: true
            title: Cursor
          description: Alias for starting_after. Use starting_after instead.
          deprecated: true
        - name: starting_after
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Starting After
        - name: ending_before
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Ending Before
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 1
            default: 100
            title: Limit
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Sort By
        - name: sort_order
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SortOrder'
              - type: 'null'
            default: asc
            title: Sort Order
        - name: x-selected-account-id
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Account ID Header
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVectorsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    ListVectorsResponse:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        items:
          items:
            $ref: '#/components/schemas/VectorDocumentResponse'
          type: array
          title: Items
          description: Array of documents
        limit:
          type: integer
          title: Limit
          description: The maximum number of items to return.
          default: 100
        total:
          type: integer
          title: Total
          description: >-
            The total of items that match the query. This is greater than or
            equal to the number of items returned.
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more items left to be fetched.
        vectors:
          items:
            $ref: '#/components/schemas/VectorDocumentResponse'
          type: array
          title: Vectors
          description: 'Array of documents. Deprecated: use `items` instead.'
          deprecated: true
        next_cursor:
          title: Next Cursor
          description: >-
            Pass as starting_after to fetch the next page. None when there is no
            next page.
          type: string
        prev_cursor:
          title: Prev Cursor
          description: >-
            Pass as ending_before to fetch the previous page. None when on the
            first page.
          type: string
      type: object
      required:
        - items
        - total
        - has_more
        - vectors
      description: >-
        Paginated list of vector documents with cursors for forward and backward
        navigation.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    VectorDocumentResponse:
      properties:
        id:
          type: string
          title: Id
          description: Document ID
        content:
          title: Content
          description: Document content. None for raw-embedding documents without text.
          oneOf:
            - $ref: '#/components/schemas/TextContent'
          discriminator:
            propertyName: type
            mapping:
              text:
                $ref: '#/components/schemas/TextContent'
        metadata:
          additionalProperties: true
          type: object
          title: Metadata
          description: Key-value metadata
        vector:
          title: Vector
          description: Embedding vector (if requested)
          items:
            type: number
          type: array
      type: object
      required:
        - id
      title: VectorDocumentResponse
      description: A document returned from direct lookups (get/list operations).
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          title: Error Type
          type: string
        input:
          title: Input
        ctx:
          type: object
          title: Context
          additionalProperties: true
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    TextContent:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: Content type identifier
          default: text
        text:
          type: string
          title: Text
          description: Text content to be embedded
      type: object
      required:
        - text
      title: TextContent
      description: Text content for documents.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````