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

# Video erstellen

> Erstellt einen asynchronen Videoerstellungsauftrag. Die zurückgegebene `polling_url` alle 20 Sekunden abfragen, bis der Auftrag einen Endstatus erreicht.

Erfordert Zugriff auf die Vorschau im Arbeitsbereich. Informationen zu Einrichtung, Webhooks und Ergebnisverarbeitung findest du unter [Video- und Stapelaufträge](../../guides/async-video-and-batch.mdx).


## OpenAPI

````yaml de/openapi/v1/openapi.localized.yaml POST /videos
openapi: 3.0.3
info:
  title: Phaseo Gateway API
  description: >-
    Eine Gateway-API für den Zugriff auf verschiedene KI-Modelle über
    OpenAI-kompatible Endpunkte.
  version: 1.0.0
  contact:
    name: Phaseo
    url: https://phaseo.app
    email: danielbutler500@gmail.com
servers:
  - url: https://api.phaseo.app/v1
    description: Globales Routing
security:
  - BearerAuth: []
tags:
  - name: Gateway
    description: Core Phaseo Gateway operations.
paths:
  /videos:
    post:
      tags:
        - Gateway
      summary: Video erstellen
      description: >-
        Erstellt einen asynchronen Videoerstellungsauftrag. Die zurückgegebene
        `polling_url` alle 20 Sekunden abfragen, bis der Auftrag einen Endstatus
        erreicht.
      operationId: createVideo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoGenerationRequest'
      responses:
        '202':
          description: Videoantwort
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoGenerationResponse'
components:
  schemas:
    VideoGenerationRequest:
      type: object
      required:
        - model
        - prompt
      properties:
        model:
          type: string
        prompt:
          type: string
        duration:
          type: integer
          description: Gewünschte Dauer in Sekunden (anbieter-/modellabhängig).
        input_video_duration:
          type: number
          format: double
          minimum: 0
          maximum: 3600
          exclusiveMinimum: true
          description: >-
            Dauer des Quellvideos in Sekunden. Erforderlich, wenn ein Anbieter
            die Quellvideodauer unabhängig von der erzeugten Ausgabe abrechnet.
        input_audio_duration:
          type: number
          format: double
          minimum: 2
          maximum: 20
          description: >-
            Angegebene Quellaudiodauer in Sekunden zur Prüfung des
            Anbieterbereichs. Anbieter ohne verbindliche Nutzungsangaben können
            ihre maximal unterstützte Eingabedauer abrechnen.
        size:
          type: string
          description: >-
            Explizite Abmessungen (z. B. 1280x720). Nicht mit resolution oder
            aspect_ratio kombinierbar.
        resolution:
          type: string
          description: >-
            480p, 720p, 1080p, 1K, 2K, 4K. Mit aspect_ratio kombinierbar. Nicht
            mit size kombinierbar.
        aspect_ratio:
          type: string
          description: >-
            Seitenverhältnis wie 16:9, 9:16 oder 1:1. Mit resolution
            kombinierbar. Nicht mit size kombinierbar.
        seed:
          type: integer
        sample_count:
          type: integer
          minimum: 1
          maximum: 4
        negative_prompt:
          type: string
        generate_audio:
          type: boolean
        enhance_prompt:
          type: boolean
        compression_quality:
          type: integer
        person_generation:
          type: string
        resize_mode:
          type: string
        input_references:
          type: array
          description: >-
            HTTPS-Bild-, Audio- oder Videoeingaben zur Steuerung der
            Generierung. Unterstützte Typen, Rollen, Anzahlen und Kombinationen
            hängen vom gewählten Modell ab. Vor dem Absenden GET /videos/models
            prüfen. Der hier nicht aufgeführte einzelne Kompatibilitätsalias
            input_reference akzeptiert ein Multipart-Bild oder ein Objekt mit
            genau einem der Felder file_id oder image_url. Die Unterstützung
            hängt vom Anbieter ab.
          items:
            $ref: '#/components/schemas/VideoInputReference'
        frame_images:
          type: array
          minItems: 1
          maxItems: 2
          description: >-
            HTTPS-Bilder des ersten/letzten Frames. Jeder frame_type darf einmal
            vorkommen. Nicht zusätzlich input_reference oder Frame-Rollen in
            input_references angeben.
          items:
            type: object
            additionalProperties: false
            required:
              - type
              - frame_type
              - image_url
            properties:
              type:
                type: string
                enum:
                  - image_url
              frame_type:
                type: string
                enum:
                  - first_frame
                  - last_frame
              image_url:
                type: object
                required:
                  - url
                properties:
                  url:
                    type: string
                    format: uri
        provider_params:
          type: object
          additionalProperties: true
          description: >-
            Nur anbieterspezifische Erweiterungen. Vollständige Durchleitung der
            Anfrage und doppelte Routing-, Prompt-, Callback- oder
            Abrechnungsfelder werden abgelehnt.
        provider_options:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
          description: >-
            Erweiterungen nach kanonischer Anbieter-ID (z. B. atlascloud oder
            byteplus). Nur Optionen des gewählten Anbieters werden
            weitergeleitet. Nicht mit provider_params kombinierbar. Routing,
            Prompt, Callback, Dauer, Auflösung und Ausgabeanzahl müssen
            validierte Felder auf oberster Ebene verwenden.
        output:
          $ref: '#/components/schemas/VideoOutputConfig'
        webhook:
          type: object
          required:
            - endpoint_id
          additionalProperties: false
          properties:
            endpoint_id:
              type: string
              description: >-
                Aktiver, vom Workspace verwalteter Webhook-Endpunkt. Sein
                verschlüsseltes, austauschbares Signaturgeheimnis wird nie in
                Videoauftragsmetadaten gespeichert.
            events:
              type: array
              description: >-
                Optionale Ereignisabonnements. Generische job.*- oder passende
                video.*-Ereignisse verwenden, z. B. video.status_changed,
                video.progress oder video.completed. Ohne Angabe werden
                job.status_changed und finale job.*-Ereignisse verwendet. Für
                Fortschritts-Callbacks job.progress oder video.progress
                ausdrücklich angeben. Mindestens ein angegebenes Ereignis muss
                für Videoaufträge gültig sein; fehlerhafte Listen oder Listen
                nur mit Ereignissen anderer Auftragsarten werden abgelehnt.
              items:
                type: string
        provider:
          $ref: '#/components/schemas/ProviderRoutingOptions'
    VideoGenerationResponse:
      type: object
      properties:
        id:
          type: string
        polling_url:
          type: string
        websocket_url:
          type: string
          format: uri
          description: >-
            WebSocket-URL zum Abonnieren normalisierter
            Lebenszyklusaktualisierungen asynchroner Aufträge.
        model:
          type: string
        request_id:
          type: string
        session_id:
          type: string
        status:
          type: string
          enum:
            - queued
            - processing
            - completed
            - failed
            - cancelled
            - expired
        lifecycle_status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - cancelled
            - expired
          description: >-
            Normalisierter asynchroner Lebenszyklusstatus für Polling-,
            WebSocket- und Webhook-Empfänger.
        cancel_url:
          type: string
          format: uri
          nullable: true
          description: Für Kompatibilität reserviert; derzeit immer null.
        output_access:
          type: string
          enum:
            - bytes
            - signed_url
            - both
        generation_id:
          type: string
          nullable: true
        native_video_id:
          type: string
          nullable: true
          description: >-
            Anbietereigene Video-/Auftrags-ID, wenn sie von der Gateway-ID
            abweicht.
        created_at:
          oneOf:
            - type: integer
            - type: string
        started_at:
          nullable: true
          oneOf:
            - type: integer
            - type: string
        completed_at:
          nullable: true
          oneOf:
            - type: integer
            - type: string
        object:
          type: string
          example: video
        poll_after_seconds:
          type: integer
          example: 20
        provider:
          type: string
        seconds:
          type: number
        size:
          type: string
        audio:
          type: boolean
        content_url:
          type: string
          description: >-
            Vorhanden, wenn output_access bytes einschließt (authentifizierter
            Endpunkt).
        download_url:
          type: string
          nullable: true
          description: >-
            Signierte Erstanbieter-URL zum direkten Download bei Status
            completed.
        expires_at:
          type: integer
          nullable: true
          description: >-
            Unix-Zeitstempel (Sekunden), zu dem die signierte download_url
            abläuft.
        progress:
          type: integer
          nullable: true
        progress_source:
          type: string
        asset:
          type: object
          nullable: true
          properties:
            id:
              type: string
            mime_type:
              type: string
            bytes:
              type: integer
            sha256:
              type: string
            width:
              type: integer
            height:
              type: integer
            duration_seconds:
              type: number
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/VideoOutput'
        billing:
          $ref: '#/components/schemas/VideoBillingSummary'
        webhook:
          $ref: '#/components/schemas/AsyncWebhookPublicState'
        next_webhook_retry_at:
          type: string
          nullable: true
          description: >-
            ISO-Zeitstempel des nächsten geplanten
            Benutzer-Webhook-Wiederholungsversuchs, sofern eingereiht.
        last_webhook_progress:
          type: number
          nullable: true
          description: Letzte an Webhook-Empfänger gesendete grobe Fortschrittsstufe.
        last_webhook_progress_at:
          type: string
          nullable: true
          description: ISO-Zeitstempel des Versands der letzten Webhook-Fortschrittsstufe.
        last_webhook_dispatched_at:
          type: string
          nullable: true
          description: ISO-Zeitstempel des letzten Webhook-Versandversuchs.
        usage:
          type: object
          properties:
            cost:
              type: number
            is_byok:
              type: boolean
          additionalProperties: true
        error:
          nullable: true
    VideoInputReference:
      description: >-
        Typisierte HTTPS-Medieneingabe. image_url für Bilder und media_url für
        Audio oder Video verwenden. Rollen beschreiben die Nutzung der Eingabe
        durch das Modell; Unterstützung variiert je Anbieter und Modell.
      oneOf:
        - type: object
          required:
            - type
            - image_url
          properties:
            type:
              type: string
              enum:
                - image_url
            role:
              type: string
              description: Vorgesehene Verwendung dieses Bildes durch das gewählte Modell.
              enum:
                - first_frame
                - last_frame
                - reference
                - source
                - mask
            reference_type:
              type: string
            image_url:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: Öffentlich erreichbare HTTPS-Bild-URL.
        - type: object
          required:
            - type
            - media_url
          properties:
            type:
              type: string
              enum:
                - video_url
                - audio_url
            role:
              type: string
              description: >-
                Vorgesehene Verwendung dieses Audios oder Videos durch das
                gewählte Modell.
              enum:
                - first_frame
                - last_frame
                - reference
                - source
                - mask
            reference_type:
              type: string
            media_url:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: Öffentlich erreichbare HTTPS-Audio- oder Video-URL.
    VideoOutputConfig:
      type: object
      properties:
        access:
          type: string
          enum:
            - bytes
            - signed_url
            - both
          default: both
          description: >-
            bytes=nur authentifizierte content_url, signed_url=nur signierte
            Downloadlinks, both=beide einschließen.
    ProviderRoutingOptions:
      type: object
      description: Anbieterrouting-Präferenzen für die Auswahl durch das Gateway.
      properties:
        order:
          type: array
          items:
            type: string
        only:
          type: array
          items:
            type: string
        ignore:
          type: array
          items:
            type: string
        include_alpha:
          type: boolean
          description: >-
            Alpha-Anbieter in das Routing einbeziehen (standardmäßig
            deaktiviert).
        allow_fallbacks:
          type: boolean
          nullable: true
          description: Nach einem Fehler auf einen anderen geeigneten Anbieter ausweichen.
        require_parameters:
          type: boolean
          nullable: true
          description: >-
            Vor dem Routing die Unterstützung der angeforderten Parameter durch
            den Anbieter voraussetzen.
        required_execution_region:
          type: string
          nullable: true
          description: >-
            Das Routing auf Anbieter mit der angeforderten Ausführungsregion
            beschränken.
        required_data_region:
          type: string
          nullable: true
          description: >-
            Das Routing auf Anbieter mit der angeforderten Datenregion
            beschränken.
        require_zero_data_retention:
          type: boolean
          nullable: true
          description: >-
            Das Routing auf Anbieter beschränken, die keine Datenspeicherung
            unterstützen.
        data_collection:
          type: string
          nullable: true
          enum:
            - allow
            - deny
        zdr:
          type: boolean
          nullable: true
        enforce_distillable_text:
          type: boolean
          nullable: true
        quantizations:
          type: array
          nullable: true
          items:
            type: string
        sort:
          oneOf:
            - type: string
            - type: object
              additionalProperties: true
          description: >-
            Anbieter für diese Anfrage sortieren, zum Beispiel nach Preis,
            Latenz oder Durchsatz.
        max_price:
          type: object
          properties:
            prompt:
              oneOf:
                - type: number
                - type: string
            completion:
              oneOf:
                - type: number
                - type: string
            image:
              oneOf:
                - type: number
                - type: string
            audio:
              oneOf:
                - type: number
                - type: string
            request:
              oneOf:
                - type: number
                - type: string
        preferred_min_throughput:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
        preferred_max_latency:
          oneOf:
            - type: number
            - type: object
              additionalProperties:
                type: number
    VideoOutput:
      type: object
      properties:
        index:
          type: integer
        mime_type:
          type: string
        bytes_available:
          type: boolean
        content_url:
          type: string
          description: Vorhanden, wenn output_access bytes einschließt.
        download_url:
          type: string
          description: Signierte Erstanbieter-URL für diese Ausgabe.
        expires_at:
          type: integer
          description: Unix-Zeitstempel (Sekunden), zu dem diese Ausgabe-URL abläuft.
    VideoBillingSummary:
      type: object
      properties:
        currency:
          type: string
        estimated_provider_cost:
          type: string
          nullable: true
        estimated_user_cost:
          type: string
          nullable: true
        settled_provider_cost:
          type: string
          nullable: true
        settled_user_cost:
          type: string
          nullable: true
        state:
          type: string
          enum:
            - pending
            - estimated
            - settled
            - void
        billable:
          type: boolean
        total_nanos:
          type: integer
          nullable: true
        estimated_nanos:
          type: integer
          nullable: true
        reserved_nanos:
          type: integer
          nullable: true
        reservation_id:
          type: string
          nullable: true
        reservation_status:
          type: string
          nullable: true
        charge_reason:
          type: string
          nullable: true
        charged:
          type: boolean
          nullable: true
        billed_at:
          type: string
      additionalProperties: true
    AsyncWebhookPublicState:
      type: object
      description: >-
        Bereinigte asynchrone Webhook-Konfiguration und Zustellstatus.
        Geheimnisse werden nie zurückgegeben; `has_secret` zeigt an, ob
        signierte Zustellungen aktiviert sind. Signierte Zustellungen enthalten
        die Header x-phaseo-signature, x-phaseo-timestamp, x-phaseo-event-id,
        x-phaseo-event-type, x-phaseo-delivery-key, x-phaseo-attempt und
        x-phaseo-max-attempts.
      properties:
        url:
          type: string
          format: uri
          nullable: true
        events:
          type: array
          items:
            type: string
        has_secret:
          type: boolean
        delivery:
          $ref: '#/components/schemas/AsyncWebhookDeliverySummary'
        attempts:
          type: array
          items:
            $ref: '#/components/schemas/AsyncWebhookDeliveryAttempt'
    AsyncWebhookDeliverySummary:
      type: object
      description: >-
        Öffentliche Zustellübersicht für vom Gateway verwaltete asynchrone
        Webhooks. Damit lässt sich der Ausführungsstatus des Auftrags vom
        Zustellzustand des Webhooks unterscheiden.
      properties:
        total_attempts:
          type: integer
          description: Gesamtzahl erfasster Zustellversuche für diesen Auftrag.
        delivered_events:
          type: integer
          description: >-
            Anzahl der Zustellschlüssel, die den Status zugestellt erreicht
            haben.
        delivered_event_types:
          type: array
          description: Mindestens einmal zugestellte Zustellschlüssel.
          items:
            type: string
          example:
            - video.completed
        pending_retries:
          type: integer
          description: >-
            Anzahl der Zustellschlüssel, für die derzeit ein
            Wiederholungsversuch geplant ist.
        next_retry_at:
          type: string
          nullable: true
          description: >-
            ISO-Zeitstempel des nächsten geplanten Wiederholungsversuchs, sofern
            vorhanden.
        last_attempt_at:
          type: string
          nullable: true
          description: ISO-Zeitstempel des letzten Zustellversuchs.
        last_attempt_status:
          type: string
          nullable: true
          enum:
            - delivered
            - scheduled_retry
            - failed_permanently
          description: Ergebnis des letzten Zustellversuchs.
        last_response_status:
          type: integer
          nullable: true
          description: Vom Webhook-Ziel zurückgegebener HTTP-Status, sofern verfügbar.
        last_delivered_at:
          type: string
          nullable: true
          description: ISO-Zeitstempel der letzten erfolgreichen Zustellung.
        last_failure_at:
          type: string
          nullable: true
          description: >-
            ISO-Zeitstempel des letzten fehlgeschlagenen oder erneut versuchten
            Zustellversuchs.
        last_error_message:
          type: string
          nullable: true
          description: Letzte Zustellfehlermeldung, sofern verfügbar.
    AsyncWebhookDeliveryAttempt:
      type: object
      description: >-
        Letzter Zustellversuch eines vom Gateway verwalteten asynchronen
        Webhooks.
      properties:
        id:
          type: string
          description: Stabile Versuchskennung für Audit und Fehlersuche.
        delivery_key:
          type: string
          description: Idempotenzschlüssel für die Zustellung dieses Ereignisses.
          example: video.completed
        event_type:
          type: string
          description: An das Webhook-Ziel zugestellter Ereignistyp.
          example: video.completed
        status:
          type: string
          enum:
            - delivered
            - scheduled_retry
            - failed_permanently
        attempt_number:
          type: integer
          description: Bei eins beginnende Versuchsnummer für diesen Zustellschlüssel.
        max_attempts:
          type: integer
          description: >-
            Maximale Anzahl an Versuchen, bevor die Zustellung als dauerhaft
            fehlgeschlagen markiert wird.
        tried_at:
          type: string
          description: ISO-Zeitstempel dieses Versuchs.
        delivered_at:
          type: string
          nullable: true
          description: ISO-Zeitstempel der erfolgreichen Zustellung dieses Versuchs.
        next_retry_at:
          type: string
          nullable: true
          description: >-
            ISO-Zeitstempel des nächsten Wiederholungsversuchs nach diesem
            Versuch, sofern geplant.
        response_status:
          type: integer
          nullable: true
          description: Vom Webhook-Ziel zurückgegebener HTTP-Status, sofern verfügbar.
        error_message:
          type: string
          nullable: true
          description: Zustellfehlermeldung, sofern verfügbar.
        response_body_preview:
          type: string
          nullable: true
          description: >-
            Vorschau des Antworttexts des Webhook-Ziels mit unkenntlich
            gemachten sensiblen Daten.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authentifizierung mit Bearer-Token

````

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