Common Operations

Generate a five second video using a text prompt.

post/v3/videos/generate

Request

  • Base URL: https://firefly-api.adobe.io
  • URL: https://firefly-api.adobe.io/v3/videos/generate
  • Auth: API key in header x-api-key and HTTP bearer

Headers

x-model-version'video1_standard' required

Specify the Firefly model version to use for the video generation.

Request body

bitRateFactorinteger

The constant rate factor for encoding video. 0 indicates a lossless generation, with the highest quality and largest file size. 63 indicates the worst quality generation with the smallest file size. The suggested value range is 17-23.

promptstring

The prompt used to generate the video. The longer the prompt, the better.

seedsinteger[]

The seed reference value. Currently only 1 seed is supported.

Example request

{
  "prompt": "A lone figure stands in the middle of a vast desert, looking up at the sky, with a sense of awe and wonder.",
  "seeds": [
    1842533538
  ],
  "sizes": [
    {
      "height": 720,
      "width": 720
    }
  ]
}

Response

Accepted

cancelUrlstring required

The URL to cancel the job.

jobIdstring required

The ID of the job.

statusUrlstring required

The URL to check the status of the job.

Changes

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      added subschema #1 subschema #2 to the /// response property oneOf list for the response status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new cai_assertion_violation_error enum value to the response property for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property anyOf list for the response status

    • info

      removed the access_error enum value from the response property for the response status

    • info

      removed the bad_request enum value from the response property for the response status

    • info

      removed the empty_input_body enum value from the response property for the response status

    • info

      removed the invalid_content_type enum value from the response property for the response status

    • info

      removed the rate_limited enum value from the response property for the response status

    • info

      removed the runtime_error enum value from the response property for the response status

    • info

      removed the timeout_error enum value from the response property for the response status

    • breaking

      the request's body type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new access_error enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new bad_request enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new empty_input_body enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new invalid_content_type enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new rate_limited enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new runtime_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new timeout_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • warning

      added the new validation_error enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status