## Get Vectorize Index

`client.Vectorize.Indexes.Get(ctx, indexName, query) (*CreateIndex, error)`

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

Returns the specified Vectorize Index.

### Parameters

- `indexName string`

- `query IndexGetParams`

  - `AccountID param.Field[string]`

    Identifier

### Returns

- `type CreateIndex struct{…}`

  - `Config IndexDimensionConfiguration`

    - `Dimensions int64`

      Specifies the number of dimensions for the index

    - `Metric IndexDimensionConfigurationMetric`

      Specifies the type of metric to use calculating distance.

      - `const IndexDimensionConfigurationMetricCosine IndexDimensionConfigurationMetric = "cosine"`

      - `const IndexDimensionConfigurationMetricEuclidean IndexDimensionConfigurationMetric = "euclidean"`

      - `const IndexDimensionConfigurationMetricDOTProduct IndexDimensionConfigurationMetric = "dot-product"`

  - `CreatedOn Time`

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

  - `Description string`

    Specifies the description of the index.

  - `ModifiedOn Time`

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

  - `Name string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/vectorize"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  createIndex, err := client.Vectorize.Indexes.Get(
    context.TODO(),
    "example-index",
    vectorize.IndexGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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
}
```