Create an API key

Creates an API key. You can bind the key to one or more corpora. Each key has one of these access levels:

Personal: the key has the same permissions as your user account.
Query only (read-only).
Query and index (read-write).

For example, create a read-only key for an application that only queries data.

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

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

namestring required

The human-readable name of the API key.

api_rolesApiRole[]

Customer-level roles for this API key.

api_key_role'serving' | 'serving_and_indexing' | 'personal'

Role of the API key. A serving API key can only perform query type requests on its corpora. A serving and indexing key can perform both indexing and query type requests on its corpora. A personal API key has all the same permissions as the creator of the API key.

corpus_keysCorpusKey[]

Deprecated: Use corpus_roles instead. Corpora this API key has roles on.

Example request

{
  "corpus_keys": [
    "my-corpus"
  ]
}

Response

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

idstring required

The ID of the API key.

namestring required

The human-readable name of the API key.

secret_keystring required

The key used in API requests. Keep the key secure.

enabledboolean

Indicates whether the API key is enabled.