> ## 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.

# Get Boreal items

> Retrieve a list of videos, with an optional ids param to filter vdieo by their UUIDs.



## OpenAPI

````yaml get /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/:
    get:
      tags:
        - boreal
      description: >-
        Retrieve a list of videos, with an optional ids param to filter vdieo by
        their UUIDs.
      operationId: boreal_list
      parameters:
        - in: query
          name: ids
          schema:
            type: string
            minLength: 1
          description: >-
            Comma-separated list of UUIDs to filter. Maximum 100 entries
            allowed.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $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
        prompt:
          type: string
          description: >-
            Describe the video: subject, action, camera, and any dialogue or
            sound it should contain.
        image_url:
          type: string
          format: uri
          nullable: true
          description: >-
            Optional start frame. The video follows the image's own aspect ratio
            unless aspect_ratio names one, which centre-crops the image to it.
          maxLength: 2000
        audio_url:
          type: string
          format: uri
          nullable: true
          description: >-
            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
        resolution:
          allOf:
            - $ref: '#/components/schemas/ResolutionEnum'
          default: 720p
          description: >-
            Delivery tier. 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 credit at 720p, 3 credits at 1080p and 12 credits at 2k.


            * `720p` - 720p

            * `1080p` - 1080p

            * `2k` - 2k
        aspect_ratio:
          allOf:
            - $ref: '#/components/schemas/APIBorealAspectRatioEnum'
          default: auto
          description: >-
            Frame ratio. auto follows the start image's own ratio, and is 16:9
            without an image. A named ratio renders that ratio; with an image it
            centre-crops the image to it.


            * `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, greater than 0 and at most 60 at 720p, 30
            at 1080p and 15 at 2k.
        negative_prompt:
          type: string
          nullable: true
          description: What the video should avoid.
        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
          description: Credits used in this API call
          readOnly: true
        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
    ResolutionEnum:
      enum:
        - 720p
        - 1080p
        - 2k
      type: string
      description: |-
        * `720p` - 720p
        * `1080p` - 1080p
        * `2k` - 2k
    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
    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.

````