Constructor Detail

Method Detail

• body

   final VideoCreateParams.Builder body(VideoCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • prompt

  • inputReference

  • model

  • seconds

  • size

  • etc.

• prompt

   final VideoCreateParams.Builder prompt(String prompt)

  Text prompt that describes the video to generate.

• prompt

   final VideoCreateParams.Builder prompt(MultipartField<String> prompt)

  Sets Builder.prompt to an arbitrary multipart value.

  You should usually call Builder.prompt with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• inputReference

   final VideoCreateParams.Builder inputReference(InputStream inputReference)

  Optional image reference that guides generation.

• inputReference

   final VideoCreateParams.Builder inputReference(MultipartField<InputStream> inputReference)

  Sets Builder.inputReference to an arbitrary multipart value.

  You should usually call Builder.inputReference with a well-typed InputStream value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• inputReference

   final VideoCreateParams.Builder inputReference(ByteArray inputReference)

  Optional image reference that guides generation.

• inputReference

   final VideoCreateParams.Builder inputReference(Path path)

  Optional image reference that guides generation.

• model

   final VideoCreateParams.Builder model(VideoModel model)

  The video generation model to use. Defaults to sora-2.

• model

   final VideoCreateParams.Builder model(MultipartField<VideoModel> model)

  Sets Builder.model to an arbitrary multipart value.

  You should usually call Builder.model with a well-typed VideoModel value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• seconds

   final VideoCreateParams.Builder seconds(VideoSeconds seconds)

  Clip duration in seconds. Defaults to 4 seconds.

• seconds

   final VideoCreateParams.Builder seconds(MultipartField<VideoSeconds> seconds)

  Sets Builder.seconds to an arbitrary multipart value.

  You should usually call Builder.seconds with a well-typed VideoSeconds value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• size

   final VideoCreateParams.Builder size(VideoSize size)

  Output resolution formatted as width x height. Defaults to 720x1280.

• size

   final VideoCreateParams.Builder size(MultipartField<VideoSize> size)

  Sets Builder.size to an arbitrary multipart value.

  You should usually call Builder.size with a well-typed VideoSize value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final VideoCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final VideoCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final VideoCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final VideoCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final VideoCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final VideoCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final VideoCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final VideoCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final VideoCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final VideoCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final VideoCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final VideoCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final VideoCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final VideoCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final VideoCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final VideoCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final VideoCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final VideoCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final VideoCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final VideoCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final VideoCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final VideoCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final VideoCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final VideoCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final VideoCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final VideoCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final VideoCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final VideoCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final VideoCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final VideoCreateParams build()

  Returns an immutable instance of VideoCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .prompt()