Skip to main content

Create API Key API Definition

The Create API Key API lets you create new API keys, which you can bind to one or multiple corpora. You can also decide whether to designate each key for specific access like personal API keys, only querying (read-only) or both querying and indexing (read-write).

This capability is useful in scenarios where you have applications that require different levels of access to corpora data. For example, you might create a read-only API key for an application that only needs to query data.

note

For more information about the different types of API keys, see API Key Management.

The apiKeyData object includes a description, apiKeyType (query-only, indexing and querying, or personal access key), and corpusId.

tip

Check out our interactive API Playground that lets you experiment with this REST endpoint to create API keys for your account.

REST API Example​

Create API Key Endpoint Address​

Vectara exposes a REST endpoint at the following URL to create API keys:
https://api.vectara.io/v1/create-api-key

The API Playground shows the full Create API Key REST definition.

gRPC Example​

You can find the full Create API Key gRPC definition at admin_apikey.proto.