Interface ApiKeyConfig

Config for authentication with API key. This data type is not supported in Gemini API.

interface ApiKeyConfig {
    apiKeySecret?: string;
    apiKeyString?: string;
    httpElementLocation?: HttpElementLocation;
    name?: string;
}

Properties

apiKeySecret? apiKeyString? httpElementLocation? name?

Properties

OptionalapiKeySecret

apiKeySecret?: string

Optional. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version} - If both api_key_secret and api_key_string are specified, this field takes precedence over api_key_string. - If specified, the secretmanager.versions.access permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.

OptionalapiKeyString

apiKeyString?: string

Optional. The API key to be used in the request directly.

OptionalhttpElementLocation

httpElementLocation?: HttpElementLocation

Optional. The location of the API key.

Optionalname

name?: string

Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.

Settings

On This Page

Properties