--- title: "POST /v1/projects/{projectsId}/locations/{locationsId}/indexes" method: POST path: "/v1/projects/{projectsId}/locations/{locationsId}/indexes" tags: ["projects"] --- # POST /v1/projects/{projectsId}/locations/{locationsId}/indexes `POST /v1/projects/{projectsId}/locations/{locationsId}/indexes` ## Request - Base URL: `https://aiplatform.googleapis.com` - URL: `https://aiplatform.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/indexes` - Auth: OAuth 2 and OAuth 2 - Implicit: `https://accounts.google.com/o/oauth2/auth` - Scopes: `https://www.googleapis.com/auth/cloud-platform` - Authorization code: `https://accounts.google.com/o/oauth2/auth` - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform` Creates an Index. ## Path parameters - `projectsId` string, required - `locationsId` string, required ## Request body - GoogleCloudAiplatformV1Index: A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search. - `createTime` string, google-datetime: Output only. Timestamp when this Index was created. - `deployedIndexes` GoogleCloudAiplatformV1DeployedIndexRef[]: Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. - `deployedIndexId` string: Immutable. The ID of the DeployedIndex in the above IndexEndpoint. - `displayName` string: Output only. The display name of the DeployedIndex. - `indexEndpoint` string: Immutable. A resource name of the IndexEndpoint. - `description` string: The description of the Index. - `displayName` string: Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. - `encryptionSpec` GoogleCloudAiplatformV1EncryptionSpec: Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. - `kmsKeyName` string: Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. - `etag` string: Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. - `indexStats` GoogleCloudAiplatformV1IndexStats: Stats of the Index. - `shardsCount` integer: Output only. The number of shards in the Index. - `sparseVectorsCount` string, int64: Output only. The number of sparse vectors in the Index. - `vectorsCount` string, int64: Output only. The number of dense vectors in the Index. - `indexUpdateMethod` 'INDEX_UPDATE_METHOD_UNSPECIFIED' | 'BATCH_UPDATE' | 'STREAM_UPDATE': Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. - `labels` object: The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. - `metadata` unknown - `metadataSchemaUri` string: Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. - `name` string: Output only. The resource name of the Index. - `satisfiesPzi` boolean: Output only. Reserved for future use. - `satisfiesPzs` boolean: Output only. Reserved for future use. - `updateTime` string, google-datetime: Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. ## Response `200` Successful response - GoogleLongrunningOperation: This resource represents a long-running operation that is the result of a network API call. - `done` boolean: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. - `error` GoogleRpcStatus: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). - `code` integer: The status code, which should be an enum value of google.rpc.Code. - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use. - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. - `metadata` object: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. - `name` string: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. - `response` object: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. --- [API](https://skmtc.dev/google/apis/aiplatform.md) - [All operations](https://skmtc.dev/google/apis/aiplatform/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/aiplatform/revisions/3aca3b348f0c?raw)