Interface AuthToken

Config for auth_tokens.create parameters.

interface AuthToken {
    expireTime?: string;
    name?: string;
    newSessionExpireTime?: string;
    uses?: number;
}

Properties

expireTime?: string

Optional. Input only. Immutable. An optional time after which, when using the resulting token, messages in BidiGenerateContent sessions will be rejected. (Gemini may preemptively close the session after this time.) If not set then this defaults to 30 minutes in the future. If set, this value must be less than 20 hours in the future.

name?: string

The name of the auth token.

newSessionExpireTime?: string

Optional. Input only. Immutable. The time after which new Live API sessions using the token resulting from this request will be rejected. If not set this defaults to 60 seconds in the future. If set, this value must be less than 20 hours in the future.

uses?: number

Optional. Input only. Immutable. The number of times the token can be used. If this value is zero then no limit is applied. Resuming a Live API session does not count as a use. If unspecified, the default is 1.