> ## Documentation Index
> Fetch the complete documentation index at: https://docs.creatify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a Boreal task

> Generate a video with Boreal from a prompt, an optional start image and an optional audio track, or with Boreal-H3 (`model` set to `boreal-h3`) from a prompt, start and closing frames, or reference media. Boreal renders up to 60 seconds at 720p, 30 seconds at 1080p and 15 seconds at 2k; each started 10 seconds costs 1, 3 or 12 credits. Boreal-H3 renders 5 to 15 seconds at 0.4 credits per second at 768p, 1.2 at 1088p and 2.6 at 2k, plus any reference inputs, the same price as on the Asset Generator.



## OpenAPI

````yaml post /api/boreal/
openapi: 3.0.3
info:
  title: creatify.ai API
  version: 1.0.0
  description: API for creatify.ai
servers: []
security: []
paths:
  /api/boreal/:
    post:
      tags:
        - boreal
      description: >-
        Generate a video from a prompt with Boreal (optional start image and
        audio

        track) or Boreal-H3 (``model: "boreal-h3"``: optional start and closing

        frames, or reference images, videos and audio).


        Async only: POST returns the job immediately; poll the detail route or

        supply ``webhook_url``.
      operationId: boreal_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APIBoreal'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/APIBoreal'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/APIBoreal'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIBoreal'
          description: ''
      security:
        - X-API-ID: []
          X-API-KEY: []
components:
  schemas:
    APIBoreal:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
          title: Created date
        updated_at:
          type: string
          format: date-time
          readOnly: true
          title: Updated date
        model:
          allOf:
            - $ref: '#/components/schemas/APIBorealModelEnum'
          default: boreal
          description: >-
            boreal (default) or boreal-h3, Creatify's post-trained H3 model.
            boreal-h3 renders 768p, 1088p or 2k, 5 to 15 seconds, and adds a
            closing frame (end_image_url) and reference-to-video
            (reference_*_urls); it takes no audio_url or negative_prompt.


            * `boreal` - Boreal

            * `boreal-h3` - Boreal H3
        prompt:
          type: string
          description: >-
            Describe the video: subject, action, camera, and any dialogue or
            sound it should contain. In a boreal-h3 reference render, refer to
            the references by type and order: Image 1, Image 2, Video 1, Audio
            1.
        image_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Optional start frame. boreal follows the image's own aspect ratio
            unless aspect_ratio names one, which centre-crops the image to it;
            boreal-h3 always follows the image's ratio.
          maxLength: 2000
        end_image_url:
          type: string
          format: uri
          nullable: true
          description: 'boreal-h3 only: optional closing frame. Requires image_url.'
          maxLength: 2000
        audio_url:
          type: string
          format: uri
          nullable: true
          description: >-
            boreal only: optional audio track ('mp3' or 'wav') that drives the
            video. When set, the video is as long as the audio, within the same
            per-resolution limit, and duration is ignored.
          maxLength: 2000
        reference_image_urls:
          type: array
          items:
            type: string
            format: uri
            maxLength: 2000
          description: >-
            boreal-h3 only: up to 9 reference images for reference-to-video. A
            reference render needs at least one image or video reference and
            takes no image_url. The first 5 are free; each one after that costs
            0.2 credits.
          maxItems: 9
        reference_video_urls:
          type: array
          items:
            type: string
            format: uri
            maxLength: 2000
          description: >-
            boreal-h3 only: up to 3 reference videos for reference-to-video,
            billed on top of the output per second of their combined length
            (counted up to 15 seconds): 0.4 credits at 768p, 0.6 at 1088p and
            2k. The whole boreal-h3 price is rounded up to half a credit.
          maxItems: 3
        reference_audio_urls:
          type: array
          items:
            type: string
            format: uri
            maxLength: 2000
          description: >-
            boreal-h3 only: up to 3 reference audio tracks, alongside at least
            one image or video reference.
          maxItems: 3
        resolution:
          allOf:
            - $ref: '#/components/schemas/APIBorealResolutionEnum'
          description: >-
            Delivery tier. boreal: 720p (default), 1080p or 2k, where 2k is 2016
            px on the long edge for 16:9 and 9:16, and the 1440p row for 1:1,
            4:3 and 3:4; each started 10 seconds of video costs 1, 3 or 12
            credits. boreal-h3: 768p (default), 1088p or 2k, where 2k is a 1440
            px short edge; each second costs 0.4, 1.2 or 2.6 credits, plus any
            reference inputs, the same as on the asset generator API.


            * `720p` - 720p

            * `1080p` - 1080p

            * `2k` - 2k

            * `768p` - 768p

            * `1088p` - 1088p
        aspect_ratio:
          allOf:
            - $ref: '#/components/schemas/APIBorealAspectRatioEnum'
          default: auto
          description: >-
            Frame ratio. auto follows the start image's own ratio (boreal-h3:
            the first reference image's), and is 16:9 without an image. A named
            ratio renders that ratio; with a start image, boreal centre-crops
            the image to it, and boreal-h3 takes only auto.


            * `auto` - auto

            * `16:9` - 16:9

            * `9:16` - 9:16

            * `1:1` - 1:1

            * `4:3` - 4:3

            * `3:4` - 3:4
        duration:
          type: number
          format: double
          default: 10
          description: >-
            Video length in seconds. boreal: greater than 0 and at most 60 at
            720p, 30 at 1080p and 15 at 2k. boreal-h3: a whole number from 5 to
            15.
        negative_prompt:
          type: string
          nullable: true
          description: 'boreal only: what the video should avoid.'
        prompt_enhancement:
          allOf:
            - $ref: '#/components/schemas/PromptEnhancementEnum'
          description: >-
            auto (default) rewrites the prompt the way the Creatify app does for
            the model: boreal-h3 with the rewrite it was evaluated with, boreal
            for image and text renders (a render driven by audio_url keeps its
            prompt). none renders the prompt as sent.


            * `auto` - auto

            * `none` - none
        webhook_url:
          type: string
          format: uri
          nullable: true
          maxLength: 200
        status:
          allOf:
            - $ref: '#/components/schemas/StatusD69Enum'
          readOnly: true
        failed_reason:
          type: string
          readOnly: true
          description: Failed reason
        video_output:
          type: string
          nullable: true
          readOnly: true
          description: Video output URL
        credits_used:
          type: number
          readOnly: true
          description: Credits used in this API call
        progress:
          type: number
          format: double
          readOnly: true
          description: Progress of the job
      required:
        - created_at
        - credits_used
        - failed_reason
        - id
        - progress
        - prompt
        - status
        - updated_at
        - video_output
    APIBorealModelEnum:
      enum:
        - boreal
        - boreal-h3
      type: string
      description: |-
        * `boreal` - Boreal
        * `boreal-h3` - Boreal H3
    APIBorealResolutionEnum:
      enum:
        - 720p
        - 1080p
        - 2k
        - 768p
        - 1088p
      type: string
      description: |-
        * `720p` - 720p
        * `1080p` - 1080p
        * `2k` - 2k
        * `768p` - 768p
        * `1088p` - 1088p
    APIBorealAspectRatioEnum:
      enum:
        - auto
        - '16:9'
        - '9:16'
        - '1:1'
        - '4:3'
        - '3:4'
      type: string
      description: |-
        * `auto` - auto
        * `16:9` - 16:9
        * `9:16` - 9:16
        * `1:1` - 1:1
        * `4:3` - 4:3
        * `3:4` - 3:4
    PromptEnhancementEnum:
      enum:
        - auto
        - none
      type: string
      description: |-
        * `auto` - auto
        * `none` - none
    StatusD69Enum:
      enum:
        - pending
        - in_queue
        - running
        - failed
        - done
        - rejected
      type: string
      description: |-
        * `pending` - Pending
        * `in_queue` - In Queue
        * `running` - Running
        * `failed` - Failed
        * `done` - Done
        * `rejected` - Rejected
  securitySchemes:
    X-API-ID:
      type: apiKey
      in: header
      name: X-API-ID
      description: API ID, from your settings page.
    X-API-KEY:
      type: apiKey
      in: header
      name: X-API-KEY
      description: API Key, from your settings page.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.