## Get Vectorize Index

`client.vectorize.indexes.get(stringindexName, IndexGetParamsparams, RequestOptionsoptions?): CreateIndex | null`

**get** `/accounts/{account_id}/vectorize/v2/indexes/{index_name}`

Returns the specified Vectorize Index.

### Parameters

- `indexName: string`

- `params: IndexGetParams`

  - `account_id: string`

    Identifier

### Returns

- `CreateIndex | null`

  - `config?: IndexDimensionConfiguration`

    - `dimensions: number`

      Specifies the number of dimensions for the index

    - `metric: "cosine" | "euclidean" | "dot-product"`

      Specifies the type of metric to use calculating distance.

      - `"cosine"`

      - `"euclidean"`

      - `"dot-product"`

  - `created_on?: string`

    Specifies the timestamp the resource was created as an ISO8601 string.

  - `description?: string`

    Specifies the description of the index.

  - `modified_on?: string`

    Specifies the timestamp the resource was modified as an ISO8601 string.

  - `name?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const createIndex = await client.vectorize.indexes.get('example-index', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(createIndex.config);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "config": {
      "dimensions": 768,
      "metric": "cosine"
    },
    "created_on": "2022-11-15T18:25:44.442097Z",
    "description": "This is my example index.",
    "modified_on": "2022-11-15T18:25:44.442097Z",
    "name": "example-index"
  },
  "success": true
}
```