Create an API key

POST 
/v2/api_keys

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.

Request

Responses

201

The response includes the assigned API key ID, name, secret key, enabled status, API key role, and API policy.

400

API key creation request was malformed.

403

Permissions do not allow creating the API key.