Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
API Keys

List API keys

Lists all API keys for the customer account. The response shows the corpora each key can access and with what permissions.

get/v2/api_keys

Query parameters

limitinteger

The maximum number of API keys to return at one time.

page_keystring

The opaque cursor returned in metadata.page_key of the previous response. Omit it to fetch the first page.

corpus_keystring

A user-provided key for a corpus.

Example:my-corpus

Filters the API keys to only those with permissions on the specified corpus 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.

Filter API keys by their role.

Headers

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.

Response

The response includes an api_keys array with the API keys, and a metadata field with the pagination key.

Example response

{
  "metadata": {
    "page_key": "eyJvZmZzZXQiOjF9"
  }
}