All Implemented Interfaces:

com.openai.core.Params
```
public final class ClientSecretCreateParams
 implements Params
                    
```
Create a Realtime client secret with an associated session configuration.
Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which grants access to the Realtime API without leaking your main API key. You can configure a custom TTL for each client secret.
You can also attach session configuration options to the client secret, which will be applied to any sessions created using that client secret, but these can also be overridden by the client connection.
[Learn more about authentication with client secrets over
- WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc).
Returns the created client secret and the effective session object. The client secret is a string that looks like ek_1234.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ClientSecretCreateParams.Builder`	A builder for ClientSecretCreateParams.
`public final class`	`ClientSecretCreateParams.Body`	Create a session and client secret for the Realtime API. The request can specify either a realtime or a transcription session configuration. Learn more about the Realtime API.
`public final class`	`ClientSecretCreateParams.ExpiresAfter`	Configuration for the client secret expiration. Expiration refers to the time after which a client secret will no longer be valid for creating sessions. The session itself may continue after that time once started. A secret can be used to create multiple sessions until it expires.
`public final class`	`ClientSecretCreateParams.Session`	Session configuration to use for the client secret. Choose either a realtime session or a transcription session.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<ClientSecretCreateParams.ExpiresAfter>`	`expiresAfter()`	Configuration for the client secret expiration.
`final Optional<ClientSecretCreateParams.Session>`	`session()`	Session configuration to use for the client secret.
`final JsonField<ClientSecretCreateParams.ExpiresAfter>`	`_expiresAfter()`	Returns the raw JSON value of expiresAfter.
`final JsonField<ClientSecretCreateParams.Session>`	`_session()`	Returns the raw JSON value of session.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final ClientSecretCreateParams.Builder`	`toBuilder()`
`final ClientSecretCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ClientSecretCreateParams`	`none()`
`final static ClientSecretCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ClientSecretCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - expiresAfter
```
 final Optional<ClientSecretCreateParams.ExpiresAfter> expiresAfter()
```
    Configuration for the client secret expiration. Expiration refers to the time after which a client secret will no longer be valid for creating sessions. The session itself may continue after that time once started. A secret can be used to create multiple sessions until it expires.
  - session
```
 final Optional<ClientSecretCreateParams.Session> session()
```
    Session configuration to use for the client secret. Choose either a realtime session or a transcription session.
  - _expiresAfter
```
 final JsonField<ClientSecretCreateParams.ExpiresAfter> _expiresAfter()
```
    Returns the raw JSON value of expiresAfter.
    Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type.
  - _session
```
 final JsonField<ClientSecretCreateParams.Session> _session()
```
    Returns the raw JSON value of session.
    Unlike session, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final ClientSecretCreateParams.Builder toBuilder()
```
  - _body
```
 final ClientSecretCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static ClientSecretCreateParams none()
```
  - builder
```
 final static ClientSecretCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ClientSecretCreateParams.

Class ClientSecretCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

expiresAfter

session

_expiresAfter

_session

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

none

builder