--- title: Create Vectorize Index --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Vectorize](https://developers.cloudflare.com/api/go/resources/vectorize) [Indexes](https://developers.cloudflare.com/api/go/resources/vectorize/subresources/indexes) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Create Vectorize Index client.Vectorize.Indexes.New(ctx, params) (\*[CreateIndex](), error) POST/accounts/{account\_id}/vectorize/v2/indexes Creates and returns a new Vectorize Index. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Vectorize Write` ##### ParametersExpand Collapse
params IndexNewParams AccountID param.Field\[string] Path param: Identifier maxLength32 Link to this property
Config param.Field\[IndexNewParamsConfig] Body param: Specifies the type of configuration to use for the index.
type IndexDimensionConfiguration struct{…} Dimensions int64 Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
Metric IndexDimensionConfigurationMetric Specifies the type of metric to use calculating distance. One of the following: const IndexDimensionConfigurationMetricCosine IndexDimensionConfigurationMetric = "cosine" Link to this property const IndexDimensionConfigurationMetricEuclidean IndexDimensionConfigurationMetric = "euclidean" Link to this property const IndexDimensionConfigurationMetricDOTProduct IndexDimensionConfigurationMetric = "dot-product" Link to this property
Link to this property
Link to this property
type IndexNewParamsConfigVectorizeIndexPresetConfiguration struct{…}
Preset IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset Specifies the preset to use for the index. One of the following: const IndexNewParamsConfigVectorizeIndexPresetConfigurationPresetCfBaaiBgeSmallEnV1\_5 IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset = "@cf/baai/bge-small-en-v1.5" Link to this property const IndexNewParamsConfigVectorizeIndexPresetConfigurationPresetCfBaaiBgeBaseEnV1\_5 IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset = "@cf/baai/bge-base-en-v1.5" Link to this property const IndexNewParamsConfigVectorizeIndexPresetConfigurationPresetCfBaaiBgeLargeEnV1\_5 IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset = "@cf/baai/bge-large-en-v1.5" Link to this property const IndexNewParamsConfigVectorizeIndexPresetConfigurationPresetOpenAITextEmbeddingAda002 IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset = "openai/text-embedding-ada-002" Link to this property const IndexNewParamsConfigVectorizeIndexPresetConfigurationPresetCohereEmbedMultilingualV2\_0 IndexNewParamsConfigVectorizeIndexPresetConfigurationPreset = "cohere/embed-multilingual-v2.0" Link to this property
Link to this property
Link to this property
Link to this property Name param.Field\[string] Body param Link to this property Description param.Field\[string]Optional Body param: Specifies the description of the index. Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(method)%20create%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type CreateIndex struct{…}
Config CreateIndexConfigOptional Dimensions int64 Specifies the number of dimensions for the index maximum1536 minimum1 Link to this property
Metric CreateIndexConfigMetric Specifies the type of metric to use calculating distance. One of the following: const CreateIndexConfigMetricCosine CreateIndexConfigMetric = "cosine" Link to this property const CreateIndexConfigMetricEuclidean CreateIndexConfigMetric = "euclidean" Link to this property const CreateIndexConfigMetricDOTProduct CreateIndexConfigMetric = "dot-product" Link to this property
Link to this property
Preset CreateIndexConfigPresetOptional Specifies the preset to use for the index. One of the following: const CreateIndexConfigPresetCfBaaiBgeSmallEnV1\_5 CreateIndexConfigPreset = "@cf/baai/bge-small-en-v1.5" Link to this property const CreateIndexConfigPresetCfBaaiBgeBaseEnV1\_5 CreateIndexConfigPreset = "@cf/baai/bge-base-en-v1.5" Link to this property const CreateIndexConfigPresetCfBaaiBgeLargeEnV1\_5 CreateIndexConfigPreset = "@cf/baai/bge-large-en-v1.5" Link to this property const CreateIndexConfigPresetOpenAITextEmbeddingAda002 CreateIndexConfigPreset = "openai/text-embedding-ada-002" Link to this property const CreateIndexConfigPresetCohereEmbedMultilingualV2\_0 CreateIndexConfigPreset = "cohere/embed-multilingual-v2.0" Link to this property
Link to this property
Link to this property CreatedOn TimeOptional Specifies the timestamp the resource was created as an ISO8601 string. formatdate-time Link to this property Description stringOptional Specifies the description of the index. Link to this property ModifiedOn TimeOptional Specifies the timestamp the resource was modified as an ISO8601 string. formatdate-time Link to this property Name stringOptional Link to this property
[Link to this property](<#(resource)%20vectorize.indexes%20%3E%20(model)%20create_index%20%3E%20(schema)>) ### Create Vectorize Index Go HTTPTypeScriptPythonGoTerraform ``` 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.New(context.TODO(), vectorize.IndexNewParams{ AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Config: cloudflare.F[vectorize.IndexNewParamsConfigUnion](vectorize.IndexDimensionConfigurationParam{ Dimensions: cloudflare.F(int64(768)), Metric: cloudflare.F(vectorize.IndexDimensionConfigurationMetricCosine), }), Name: cloudflare.F("example-index"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", createIndex.Config) } ``` 200 example ``` { "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", "preset": "@cf/baai/bge-small-en-v1.5" }, "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 } ``` ##### Returns Examples 200 example ``` { "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", "preset": "@cf/baai/bge-small-en-v1.5" }, "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 } ```