# Scan Vector Index

Launch stage: GA

`POST /api/2.0/vector-search/indexes/{name}/scan`

Scan the specified vector index and return the first `num_results` entries after the exclusive `primary_key`.

API scopes: vector-search

## Path parameters

- `name` (string, optional)
  Name of the vector index to scan.

## Request body

- `num_results` (int32, optional)
  Number of results to return. Defaults to 10.
- `last_primary_key` (string, optional)
  Primary key of the last entry returned in the previous scan.

## Returns

- `data` (array of object, optional)
  List of data entries
  - `fields` (array of object, optional)
    Data entry, corresponding to a row in a vector index.
    - `key` (string, optional)
      Column name.
    - `value` (object, optional)
      Column value, nullable.
      - `number_value` (double, required)
      - `string_value` (string, required)
      - `bool_value` (boolean, required)
      - `struct_value` (object, required)
      - `list_value` (object, required)
- `last_primary_key` (string, optional)
  Primary key of the last entry.

## Request

### First scan request

```json
{
  "num_results": 2
}
```

### Scan more results

```json
{
  "last_primary_key": "2",
  "num_results": 2
}
```

## Response

### Successful response for scan operation.

```json
{
  "data": [
    {
      "fields": [
        {
          "key": "id",
          "value": {
            "number_value": 1
          }
        },
        {
          "key": "text",
          "value": {
            "string_value": "foo"
          }
        },
        {
          "key": "embedding",
          "value": {
            "list_value": {
              "values": [
                {
                  "number_value": 0.1
                },
                {
                  "number_value": 0.2
                },
                {
                  "number_value": 0.3
                }
              ]
            }
          }
        }
      ]
    },
    {
      "fields": [
        {
          "key": "id",
          "value": {
            "number_value": 2
          }
        },
        {
          "key": "text",
          "value": {
            "string_value": "bar"
          }
        },
        {
          "key": "embedding",
          "value": {
            "list_value": {
              "values": [
                {
                  "number_value": 1
                },
                {
                  "number_value": 2
                },
                {
                  "number_value": 3
                }
              ]
            }
          }
        }
      ]
    }
  ],
  "last_primary_key": "2"
}
```