Create an API key

POST 
/v2/api_keys

An API key is to authenticate when calling Vectara APIs.

Request

application/json

Body

name stringrequired

The human-readable name of the API key.

api_key_role ApiKeyRolerequired

Possible values: [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_keys CorpusKey[]

Possible values: <= 50 characters, Value must match regular expression [a-zA-Z0-9_\=\-]+$

Corpora this API key has roles on if it is not a Personal API key. This property should be null or missing if this api_key_role is personal.

Responses

201

An API Key object, used to query the Vectara API with the assigned roles.

application/json

Schema

Schema

id string

Possible values: Value must match regular expression aky_.*

The ID of the API key.

name string

The human-readable name of the API key.

secret_key string

The key used in API requests. Should be kept secure.

enabled boolean

If this API key is enabled.

api_key_role ApiKeyRole

Possible values: [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.

api_policy object
What actions a principal can take on the Vectara platform.
name stringrequired
The name of the API role.
allowed_operations objectrequired
Operations that are allowed by the API role. Each operation may only allow certain resources that are described by a resource path to resource value map. If the value is null, then the operation is allowed on any resource.
property name* ApiOperationPolicy
Policy to allow operations if only using the specified resource.
allow_any_resource booleanrequired
Default value: true
If any resource is allowed for the operation.
allowed_resources object
Object with keys of resource paths to a list of allowed resources. A resource path starts with either body, path, or implicit. A body or path resource is within the operation body, and implicit resource is a resource implied by the request.
property name* string[]
Array [
string
]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "secret_key": "string",
  "enabled": true,
  "api_key_role": "serving",
  "api_policy": {
    "name": "string",
    "allowed_operations": {}
  }
}

400

API key creation request was malformed.

application/json

Schema

Schema

field_errors object
The errors that relate to specific fields in the request.
property name* string
messages message[]
request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "field_errors": {},
  "messages": [
    "string"
  ],
  "request_id": "string"
}

403

Permissions do not allow creating the API key.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong .

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

Loading...